Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_api_module.xml @ 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 |
---|---|
376 Possible responses: | 376 Possible responses: |
377 </para> | 377 </para> |
378 <list type="bullet"> | 378 <list type="bullet"> |
379 <listitem>204 - Success</listitem> | 379 <listitem>204 - Success</listitem> |
380 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 380 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
381 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
381 </list> | 382 </list> |
382 </listitem> | 383 </listitem> |
383 </list> | 384 </list> |
384 </tag-desc> | 385 </tag-desc> |
385 <tag-name id="http_" name="/http/"> | 386 <tag-name id="http_" name="/http/"> |
431 <para> | 432 <para> |
432 Possible responses: | 433 Possible responses: |
433 </para> | 434 </para> |
434 <list type="bullet"> | 435 <list type="bullet"> |
435 <listitem>204 - Success</listitem> | 436 <listitem>204 - Success</listitem> |
437 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
436 </list> | 438 </list> |
437 </listitem> | 439 </listitem> |
438 </list> | 440 </list> |
439 </tag-desc> | 441 </tag-desc> |
440 <tag-name id="http_server_zones_" name="/http/server_zones/"> | 442 <tag-name id="http_server_zones_" name="/http/server_zones/"> |
504 Possible responses: | 506 Possible responses: |
505 </para> | 507 </para> |
506 <list type="bullet"> | 508 <list type="bullet"> |
507 <listitem>204 - Success</listitem> | 509 <listitem>204 - Success</listitem> |
508 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 510 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
511 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
509 </list> | 512 </list> |
510 </listitem> | 513 </listitem> |
511 </list> | 514 </list> |
512 </tag-desc> | 515 </tag-desc> |
513 <tag-name id="http_caches_" name="/http/caches/"> | 516 <tag-name id="http_caches_" name="/http/caches/"> |
577 Possible responses: | 580 Possible responses: |
578 </para> | 581 </para> |
579 <list type="bullet"> | 582 <list type="bullet"> |
580 <listitem>204 - Success</listitem> | 583 <listitem>204 - Success</listitem> |
581 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 584 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
585 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
582 </list> | 586 </list> |
583 </listitem> | 587 </listitem> |
584 </list> | 588 </list> |
585 </tag-desc> | 589 </tag-desc> |
586 <tag-name id="http_upstreams_" name="/http/upstreams/"> | 590 <tag-name id="http_upstreams_" name="/http/upstreams/"> |
652 </para> | 656 </para> |
653 <list type="bullet"> | 657 <list type="bullet"> |
654 <listitem>204 - Success</listitem> | 658 <listitem>204 - Success</listitem> |
655 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 659 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
656 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 660 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
661 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
657 </list> | 662 </list> |
658 </listitem> | 663 </listitem> |
659 </list> | 664 </list> |
660 </tag-desc> | 665 </tag-desc> |
661 <tag-name id="http_upstreams_http_upstream_name_servers_" name="/http/upstreams/{httpUpstreamName}/servers/"> | 666 <tag-name id="http_upstreams_http_upstream_name_servers_" name="/http/upstreams/{httpUpstreamName}/servers/"> |
717 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), | 722 “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), |
718 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), | 723 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), |
719 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), | 724 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), |
720 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 725 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
721 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 726 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
727 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
722 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 728 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
723 </list> | 729 </list> |
724 </listitem> | 730 </listitem> |
725 </list> | 731 </list> |
726 </tag-desc> | 732 </tag-desc> |
789 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), | 795 server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), |
790 server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), | 796 server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), |
791 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 797 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
792 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), | 798 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
793 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 799 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
800 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
794 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 801 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
795 </list> | 802 </list> |
796 </listitem> | 803 </listitem> |
797 <listitem id="deleteHttpUpstreamServer"> | 804 <listitem id="deleteHttpUpstreamServer"> |
798 <literal>DELETE</literal> - Remove a server from an HTTP upstream server group | 805 <literal>DELETE</literal> - Remove a server from an HTTP upstream server group |
805 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), | 812 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), |
806 invalid server ID (<literal>UpstreamBadServerId</literal>), | 813 invalid server ID (<literal>UpstreamBadServerId</literal>), |
807 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 814 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
808 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), | 815 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
809 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 816 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
817 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
810 </list> | 818 </list> |
811 </listitem> | 819 </listitem> |
812 </list> | 820 </list> |
813 </tag-desc> | 821 </tag-desc> |
814 <tag-name id="http_keyvals_" name="/http/keyvals/"> | 822 <tag-name id="http_keyvals_" name="/http/keyvals/"> |
891 <listitem>201 - Created</listitem> | 899 <listitem>201 - Created</listitem> |
892 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), | 900 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), |
893 only one key can be added (<literal>KeyvalFormatError</literal>), | 901 only one key can be added (<literal>KeyvalFormatError</literal>), |
894 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 902 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
895 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 903 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
904 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
896 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 905 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
897 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 906 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
898 </list> | 907 </list> |
899 </listitem> | 908 </listitem> |
900 <listitem id="patchHttpKeyvalZoneKeyValue"> | 909 <listitem id="patchHttpKeyvalZoneKeyValue"> |
917 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), | 926 <listitem>400 - Key required (<literal>KeyvalFormatError</literal>), |
918 only one key can be updated (<literal>KeyvalFormatError</literal>), | 927 only one key can be updated (<literal>KeyvalFormatError</literal>), |
919 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 928 nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
920 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), | 929 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), |
921 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 930 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
931 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
922 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 932 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
923 </list> | 933 </list> |
924 </listitem> | 934 </listitem> |
925 <listitem id="deleteHttpKeyvalZoneData"> | 935 <listitem id="deleteHttpKeyvalZoneData"> |
926 <literal>DELETE</literal> - Empty the keyval zone | 936 <literal>DELETE</literal> - Empty the keyval zone |
929 Possible responses: | 939 Possible responses: |
930 </para> | 940 </para> |
931 <list type="bullet"> | 941 <list type="bullet"> |
932 <listitem>204 - Success</listitem> | 942 <listitem>204 - Success</listitem> |
933 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 943 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
944 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
934 </list> | 945 </list> |
935 </listitem> | 946 </listitem> |
936 </list> | 947 </list> |
937 </tag-desc> | 948 </tag-desc> |
938 <tag-name id="stream_" name="/stream/"> | 949 <tag-name id="stream_" name="/stream/"> |
1023 </para> | 1034 </para> |
1024 <list type="bullet"> | 1035 <list type="bullet"> |
1025 <listitem>204 - Success</listitem> | 1036 <listitem>204 - Success</listitem> |
1026 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), | 1037 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), |
1027 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1038 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1039 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
1028 </list> | 1040 </list> |
1029 </listitem> | 1041 </listitem> |
1030 </list> | 1042 </list> |
1031 </tag-desc> | 1043 </tag-desc> |
1032 <tag-name id="stream_upstreams_" name="/stream/upstreams/"> | 1044 <tag-name id="stream_upstreams_" name="/stream/upstreams/"> |
1101 <list type="bullet"> | 1113 <list type="bullet"> |
1102 <listitem>204 - Success</listitem> | 1114 <listitem>204 - Success</listitem> |
1103 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1115 <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1104 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), | 1116 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
1105 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1117 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1118 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
1106 </list> | 1119 </list> |
1107 </listitem> | 1120 </listitem> |
1108 </list> | 1121 </list> |
1109 </tag-desc> | 1122 </tag-desc> |
1110 <tag-name id="stream_upstreams_stream_upstream_name_servers_" name="/stream/upstreams/{streamUpstreamName}/servers/"> | 1123 <tag-name id="stream_upstreams_stream_upstream_name_servers_" name="/stream/upstreams/{streamUpstreamName}/servers/"> |
1168 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), | 1181 no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), |
1169 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), | 1182 upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), |
1170 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1183 upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1171 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), | 1184 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
1172 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1185 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1186 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
1173 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1187 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1174 </list> | 1188 </list> |
1175 </listitem> | 1189 </listitem> |
1176 </list> | 1190 </list> |
1177 </tag-desc> | 1191 </tag-desc> |
1242 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), | 1256 server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), |
1243 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1257 upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1244 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), | 1258 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
1245 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), | 1259 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
1246 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1260 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1261 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
1247 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1262 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1248 </list> | 1263 </list> |
1249 </listitem> | 1264 </listitem> |
1250 <listitem id="deleteStreamUpstreamServer"> | 1265 <listitem id="deleteStreamUpstreamServer"> |
1251 <literal>DELETE</literal> - Remove a server from a stream upstream server group | 1266 <literal>DELETE</literal> - Remove a server from a stream upstream server group |
1259 invalid server ID (<literal>UpstreamBadServerId</literal>), | 1274 invalid server ID (<literal>UpstreamBadServerId</literal>), |
1260 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1275 server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1261 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), | 1276 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), |
1262 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), | 1277 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), |
1263 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> | 1278 <link url="https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream">stream</link> not configured (<literal>StreamNotConfigured</literal>), returns <link id="def_nginx_error">Error</link></listitem> |
1279 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> | |
1264 </list> | 1280 </list> |
1265 </listitem> | 1281 </listitem> |
1266 </list> | 1282 </list> |
1267 </tag-desc> | 1283 </tag-desc> |
1268 </list> | 1284 </list> |