changeset 2500:8a9b2efa92aa

Documented the "Method disabled" error in the API.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 12 Feb 2020 15:10:47 +0000
parents 20dbb29cbe05
children 2b494b8ff72d
files xml/en/docs/http/ngx_http_api_module.xml yaml/nginx_api.yaml
diffstat 2 files changed, 15 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
@@ -343,6 +343,7 @@ Possible responses:
 <list type="bullet">
 <listitem>204 - Success</listitem>
 <listitem>404 - Unknown version (<literal>UnknownVersion</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>
@@ -382,6 +383,7 @@ Possible responses:
 <list type="bullet">
 <listitem>204 - Success</listitem>
 <listitem>404 - Unknown version (<literal>UnknownVersion</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>
@@ -1973,6 +1975,7 @@ Possible responses:
 <list type="bullet">
 <listitem>204 - Success</listitem>
 <listitem>404 - Unknown version (<literal>UnknownVersion</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
@@ -118,6 +118,10 @@ paths:
           description: Unknown version (*UnknownVersion*)
           schema:
             $ref: '#/definitions/NginxError'
+        '405':
+          description: Method disabled (*MethodDisabled*)
+          schema:
+            $ref: '#/definitions/NginxError'
   /connections:
     get:
       tags:
@@ -157,6 +161,10 @@ paths:
           description: Unknown version (*UnknownVersion*)
           schema:
             $ref: '#/definitions/NginxError'
+        '405':
+          description: Method disabled (*MethodDisabled*)
+          schema:
+            $ref: '#/definitions/NginxError'
   /slabs/:
     get:
       tags:
@@ -2074,6 +2082,10 @@ paths:
           description: Unknown version (*UnknownVersion*)
           schema:
             $ref: '#/definitions/NginxError'
+        '405':
+          description: Method disabled (*MethodDisabled*)
+          schema:
+            $ref: '#/definitions/NginxError'
 ###
 ###DEFINITIONS
 ###