Mercurial > hg > nginx-site
comparison yaml/nginx_api.yaml @ 2047:593dfdc524ae
Documented the 405 error (Method Disabled) in yaml.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 06 Sep 2017 15:15:38 +0300 |
parents | a810103f8a75 |
children | 116994597b0e |
comparison
equal
deleted
inserted
replaced
2046:a810103f8a75 | 2047:593dfdc524ae |
---|---|
222 description: Success | 222 description: Success |
223 '404': | 223 '404': |
224 description: Slab not found (*SlabNotFound*) | 224 description: Slab not found (*SlabNotFound*) |
225 schema: | 225 schema: |
226 $ref: '#/definitions/NginxError' | 226 $ref: '#/definitions/NginxError' |
227 '405': | |
228 description: Method disabled (*MethodDisabled*) | |
229 schema: | |
230 $ref: '#/definitions/NginxError' | |
227 /http/: | 231 /http/: |
228 get: | 232 get: |
229 tags: | 233 tags: |
230 - HTTP | 234 - HTTP |
231 - Method GET | 235 - Method GET |
268 description: Resets the number of total client HTTP requests. | 272 description: Resets the number of total client HTTP requests. |
269 operationId: deleteHttpRequests | 273 operationId: deleteHttpRequests |
270 responses: | 274 responses: |
271 '204': | 275 '204': |
272 description: Success | 276 description: Success |
277 '405': | |
278 description: Method disabled (*MethodDisabled*) | |
279 schema: | |
280 $ref: '#/definitions/NginxError' | |
273 /http/server_zones/: | 281 /http/server_zones/: |
274 get: | 282 get: |
275 tags: | 283 tags: |
276 - HTTP Server Zones | 284 - HTTP Server Zones |
277 - Method GET | 285 - Method GET |
336 description: Success | 344 description: Success |
337 '404': | 345 '404': |
338 description: Server zone not found (*ServerZoneNotFound*) | 346 description: Server zone not found (*ServerZoneNotFound*) |
339 schema: | 347 schema: |
340 $ref: '#/definitions/NginxError' | 348 $ref: '#/definitions/NginxError' |
349 '405': | |
350 description: Method disabled (*MethodDisabled*) | |
351 schema: | |
352 $ref: '#/definitions/NginxError' | |
341 /http/caches/: | 353 /http/caches/: |
342 get: | 354 get: |
343 tags: | 355 tags: |
344 - HTTP Caches | 356 - HTTP Caches |
345 - Method GET | 357 - Method GET |
402 responses: | 414 responses: |
403 '204': | 415 '204': |
404 description: Success | 416 description: Success |
405 '404': | 417 '404': |
406 description: Cache not found (*CacheNotFound*) | 418 description: Cache not found (*CacheNotFound*) |
419 schema: | |
420 $ref: '#/definitions/NginxError' | |
421 '405': | |
422 description: Method disabled (*MethodDisabled*) | |
407 schema: | 423 schema: |
408 $ref: '#/definitions/NginxError' | 424 $ref: '#/definitions/NginxError' |
409 /http/upstreams/: | 425 /http/upstreams/: |
410 get: | 426 get: |
411 tags: | 427 tags: |
481 description: Upstream is static (*UpstreamStatic*) | 497 description: Upstream is static (*UpstreamStatic*) |
482 schema: | 498 schema: |
483 $ref: '#/definitions/NginxError' | 499 $ref: '#/definitions/NginxError' |
484 '404': | 500 '404': |
485 description: Upstream not found (*UpstreamNotFound*) | 501 description: Upstream not found (*UpstreamNotFound*) |
502 schema: | |
503 $ref: '#/definitions/NginxError' | |
504 '405': | |
505 description: Method disabled (*MethodDisabled*) | |
486 schema: | 506 schema: |
487 $ref: '#/definitions/NginxError' | 507 $ref: '#/definitions/NginxError' |
488 '/http/upstreams/{httpUpstreamName}/servers/': | 508 '/http/upstreams/{httpUpstreamName}/servers/': |
489 parameters: | 509 parameters: |
490 - name: httpUpstreamName | 510 - name: httpUpstreamName |
564 $ref: '#/definitions/NginxError' | 584 $ref: '#/definitions/NginxError' |
565 '404': | 585 '404': |
566 description: Upstream not found (*UpstreamNotFound*) | 586 description: Upstream not found (*UpstreamNotFound*) |
567 schema: | 587 schema: |
568 $ref: '#/definitions/NginxError' | 588 $ref: '#/definitions/NginxError' |
589 '405': | |
590 description: Method disabled (*MethodDisabled*) | |
591 schema: | |
592 $ref: '#/definitions/NginxError' | |
569 '415': | 593 '415': |
570 description: JSON error (*JsonError*) | 594 description: JSON error (*JsonError*) |
571 schema: | 595 schema: |
572 $ref: '#/definitions/NginxError' | 596 $ref: '#/definitions/NginxError' |
573 '/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}': | 597 '/http/upstreams/{httpUpstreamName}/servers/{httpUpstreamServerId}': |
659 description: | | 683 description: | |
660 Upstream not found (*UpstreamNotFound*), | 684 Upstream not found (*UpstreamNotFound*), |
661 server with ID “**id**” does not exist (*UpstreamServerNotFound*) | 685 server with ID “**id**” does not exist (*UpstreamServerNotFound*) |
662 schema: | 686 schema: |
663 $ref: '#/definitions/NginxError' | 687 $ref: '#/definitions/NginxError' |
688 '405': | |
689 description: Method disabled (*MethodDisabled*) | |
690 schema: | |
691 $ref: '#/definitions/NginxError' | |
664 '415': | 692 '415': |
665 description: JSON error (*JsonError*) | 693 description: JSON error (*JsonError*) |
666 schema: | 694 schema: |
667 $ref: '#/definitions/NginxError' | 695 $ref: '#/definitions/NginxError' |
668 delete: | 696 delete: |
688 $ref: '#/definitions/NginxError' | 716 $ref: '#/definitions/NginxError' |
689 '404': | 717 '404': |
690 description: | | 718 description: | |
691 Upstream not found (*UpstreamNotFound*), | 719 Upstream not found (*UpstreamNotFound*), |
692 server with ID “**id**” does not exist (*UpstreamServerNotFound*) | 720 server with ID “**id**” does not exist (*UpstreamServerNotFound*) |
721 schema: | |
722 $ref: '#/definitions/NginxError' | |
723 '405': | |
724 description: Method disabled (*MethodDisabled*) | |
693 schema: | 725 schema: |
694 $ref: '#/definitions/NginxError' | 726 $ref: '#/definitions/NginxError' |
695 /http/keyvals/: | 727 /http/keyvals/: |
696 get: | 728 get: |
697 tags: | 729 tags: |
780 $ref: '#/definitions/NginxError' | 812 $ref: '#/definitions/NginxError' |
781 '404': | 813 '404': |
782 description: Keyval not found (*KeyvalNotFound*) | 814 description: Keyval not found (*KeyvalNotFound*) |
783 schema: | 815 schema: |
784 $ref: '#/definitions/NginxError' | 816 $ref: '#/definitions/NginxError' |
817 '405': | |
818 description: Method disabled (*MethodDisabled*) | |
819 schema: | |
820 $ref: '#/definitions/NginxError' | |
785 '409': | 821 '409': |
786 description: Key already exists (*KeyvalKeyExists*) | 822 description: Key already exists (*KeyvalKeyExists*) |
787 schema: | 823 schema: |
788 $ref: '#/definitions/NginxError' | 824 $ref: '#/definitions/NginxError' |
789 '415': | 825 '415': |
821 description: | | 857 description: | |
822 Keyval not found (*KeyvalNotFound*), | 858 Keyval not found (*KeyvalNotFound*), |
823 keyval key not found (*KeyvalKeyNotFound*) | 859 keyval key not found (*KeyvalKeyNotFound*) |
824 schema: | 860 schema: |
825 $ref: '#/definitions/NginxError' | 861 $ref: '#/definitions/NginxError' |
862 '405': | |
863 description: Method disabled (*MethodDisabled*) | |
864 schema: | |
865 $ref: '#/definitions/NginxError' | |
826 '415': | 866 '415': |
827 description: JSON error (*JsonError*) | 867 description: JSON error (*JsonError*) |
828 schema: | 868 schema: |
829 $ref: '#/definitions/NginxError' | 869 $ref: '#/definitions/NginxError' |
830 delete: | 870 delete: |
838 responses: | 878 responses: |
839 '204': | 879 '204': |
840 description: Success | 880 description: Success |
841 '404': | 881 '404': |
842 description: Keyval not found (*KeyvalNotFound*) | 882 description: Keyval not found (*KeyvalNotFound*) |
883 schema: | |
884 $ref: '#/definitions/NginxError' | |
885 '405': | |
886 description: Method disabled (*MethodDisabled*) | |
843 schema: | 887 schema: |
844 $ref: '#/definitions/NginxError' | 888 $ref: '#/definitions/NginxError' |
845 /stream/: | 889 /stream/: |
846 get: | 890 get: |
847 tags: | 891 tags: |
930 description: Success | 974 description: Success |
931 '404': | 975 '404': |
932 description: | | 976 description: | |
933 Server zone not found (*ServerZoneNotFound*), | 977 Server zone not found (*ServerZoneNotFound*), |
934 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) | 978 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) |
979 schema: | |
980 $ref: '#/definitions/NginxError' | |
981 '405': | |
982 description: Method disabled (*MethodDisabled*) | |
935 schema: | 983 schema: |
936 $ref: '#/definitions/NginxError' | 984 $ref: '#/definitions/NginxError' |
937 /stream/upstreams/: | 985 /stream/upstreams/: |
938 get: | 986 get: |
939 tags: | 987 tags: |
1019 $ref: '#/definitions/NginxError' | 1067 $ref: '#/definitions/NginxError' |
1020 '404': | 1068 '404': |
1021 description: | | 1069 description: | |
1022 Upstream not found (*UpstreamNotFound*), | 1070 Upstream not found (*UpstreamNotFound*), |
1023 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) | 1071 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) |
1072 schema: | |
1073 $ref: '#/definitions/NginxError' | |
1074 '405': | |
1075 description: Method disabled (*MethodDisabled*) | |
1024 schema: | 1076 schema: |
1025 $ref: '#/definitions/NginxError' | 1077 $ref: '#/definitions/NginxError' |
1026 '/stream/upstreams/{streamUpstreamName}/servers/': | 1078 '/stream/upstreams/{streamUpstreamName}/servers/': |
1027 parameters: | 1079 parameters: |
1028 - name: streamUpstreamName | 1080 - name: streamUpstreamName |
1106 description: | | 1158 description: | |
1107 Upstream not found (*UpstreamNotFound*), | 1159 Upstream not found (*UpstreamNotFound*), |
1108 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) | 1160 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) |
1109 schema: | 1161 schema: |
1110 $ref: '#/definitions/NginxError' | 1162 $ref: '#/definitions/NginxError' |
1163 '405': | |
1164 description: Method disabled (*MethodDisabled*) | |
1165 schema: | |
1166 $ref: '#/definitions/NginxError' | |
1111 '415': | 1167 '415': |
1112 description: JSON error (*JsonError*) | 1168 description: JSON error (*JsonError*) |
1113 schema: | 1169 schema: |
1114 $ref: '#/definitions/NginxError' | 1170 $ref: '#/definitions/NginxError' |
1115 '/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}': | 1171 '/stream/upstreams/{streamUpstreamName}/servers/{streamUpstreamServerId}': |
1203 Upstream not found (*UpstreamNotFound*), | 1259 Upstream not found (*UpstreamNotFound*), |
1204 server with ID “**id**” does not exist (*UpstreamServerNotFound*), | 1260 server with ID “**id**” does not exist (*UpstreamServerNotFound*), |
1205 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) | 1261 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) |
1206 schema: | 1262 schema: |
1207 $ref: '#/definitions/NginxError' | 1263 $ref: '#/definitions/NginxError' |
1264 '405': | |
1265 description: Method disabled (*MethodDisabled*) | |
1266 schema: | |
1267 $ref: '#/definitions/NginxError' | |
1208 '415': | 1268 '415': |
1209 description: JSON error (*JsonError*) | 1269 description: JSON error (*JsonError*) |
1210 schema: | 1270 schema: |
1211 $ref: '#/definitions/NginxError' | 1271 $ref: '#/definitions/NginxError' |
1212 delete: | 1272 delete: |
1233 '404': | 1293 '404': |
1234 description: | | 1294 description: | |
1235 Upstream not found (*UpstreamNotFound*), | 1295 Upstream not found (*UpstreamNotFound*), |
1236 server with ID “**id**” does not exist (*UpstreamServerNotFound*), | 1296 server with ID “**id**” does not exist (*UpstreamServerNotFound*), |
1237 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) | 1297 [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) |
1298 schema: | |
1299 $ref: '#/definitions/NginxError' | |
1300 '405': | |
1301 description: Method disabled (*MethodDisabled*) | |
1238 schema: | 1302 schema: |
1239 $ref: '#/definitions/NginxError' | 1303 $ref: '#/definitions/NginxError' |
1240 ### | 1304 ### |
1241 ###DEFINITIONS | 1305 ###DEFINITIONS |
1242 ### | 1306 ### |