Mercurial > hg > nginx-site
changeset 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 | 5c80c77cbdcd |
files | xml/en/docs/http/ngx_http_api_module.xml yaml/nginx_api.yaml |
diffstat | 2 files changed, 80 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_api_module.xml +++ b/xml/en/docs/http/ngx_http_api_module.xml @@ -378,6 +378,7 @@ Possible responses: <list type="bullet"> <listitem>204 - Success</listitem> <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -433,6 +434,7 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -506,6 +508,7 @@ Possible responses: <list type="bullet"> <listitem>204 - Success</listitem> <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -579,6 +582,7 @@ Possible responses: <list type="bullet"> <listitem>204 - Success</listitem> <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -654,6 +658,7 @@ Possible responses: <listitem>204 - Success</listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -719,6 +724,7 @@ no resolver defined to resolve (<literal upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -791,6 +797,7 @@ server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -807,6 +814,7 @@ invalid server ID (<literal>UpstreamBadS server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -893,6 +901,7 @@ Possible responses: only one key can be added (<literal>KeyvalFormatError</literal>), nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> @@ -919,6 +928,7 @@ only one key can be updated (<literal>Ke nested object or list (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -931,6 +941,7 @@ Possible responses: <list type="bullet"> <listitem>204 - Success</listitem> <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1025,6 +1036,7 @@ Possible responses: <listitem>204 - Success</listitem> <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), <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> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1103,6 +1115,7 @@ Possible responses: <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), <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> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1170,6 +1183,7 @@ upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), <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> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1244,6 +1258,7 @@ upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), <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> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1261,6 +1276,7 @@ server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), <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> +<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list>
--- a/yaml/nginx_api.yaml +++ b/yaml/nginx_api.yaml @@ -224,6 +224,10 @@ paths: description: Slab not found (*SlabNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /http/: get: tags: @@ -270,6 +274,10 @@ paths: responses: '204': description: Success + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /http/server_zones/: get: tags: @@ -338,6 +346,10 @@ paths: description: Server zone not found (*ServerZoneNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /http/caches/: get: tags: @@ -406,6 +418,10 @@ paths: description: Cache not found (*CacheNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /http/upstreams/: get: tags: @@ -485,6 +501,10 @@ paths: description: Upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '/http/upstreams/{httpUpstreamName}/servers/': parameters: - name: httpUpstreamName @@ -566,6 +586,10 @@ paths: description: Upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '415': description: JSON error (*JsonError*) schema: @@ -661,6 +685,10 @@ paths: server with ID “**id**” does not exist (*UpstreamServerNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '415': description: JSON error (*JsonError*) schema: @@ -692,6 +720,10 @@ paths: server with ID “**id**” does not exist (*UpstreamServerNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /http/keyvals/: get: tags: @@ -782,6 +814,10 @@ paths: description: Keyval not found (*KeyvalNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '409': description: Key already exists (*KeyvalKeyExists*) schema: @@ -823,6 +859,10 @@ paths: keyval key not found (*KeyvalKeyNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '415': description: JSON error (*JsonError*) schema: @@ -842,6 +882,10 @@ paths: description: Keyval not found (*KeyvalNotFound*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /stream/: get: tags: @@ -934,6 +978,10 @@ paths: [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' /stream/upstreams/: get: tags: @@ -1023,6 +1071,10 @@ paths: [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '/stream/upstreams/{streamUpstreamName}/servers/': parameters: - name: streamUpstreamName @@ -1108,6 +1160,10 @@ paths: [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '415': description: JSON error (*JsonError*) schema: @@ -1205,6 +1261,10 @@ paths: [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' '415': description: JSON error (*JsonError*) schema: @@ -1237,6 +1297,10 @@ paths: [stream](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) not configured (*StreamNotConfigured*) schema: $ref: '#/definitions/NginxError' + '405': + description: Method disabled (*MethodDisabled*) + schema: + $ref: '#/definitions/NginxError' ### ###DEFINITIONS ###