Mercurial > hg > nginx-site
changeset 2501:2b494b8ff72d
Documented the "Entry exists" error in the API.
| author | Yaroslav Zhuravlev <yar@nginx.com> |
|---|---|
| date | Wed, 12 Feb 2020 15:10:47 +0000 |
| parents | 8a9b2efa92aa |
| children | 5280a40d933e |
| files | xml/en/docs/http/ngx_http_api_module.xml yaml/nginx_api.yaml |
| diffstat | 2 files changed, 20 insertions(+), 4 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 @@ -1053,6 +1053,7 @@ upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), 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>409 - Entry exists (<literal>EntryExists</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> @@ -1240,7 +1241,8 @@ reading request body failed <literal>Bod <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 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> -<listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>409 - Entry exists (<literal>EntryExists</literal>), +key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>413 - Request Entity Too Large, 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> @@ -1607,6 +1609,7 @@ reading request body failed <literal>Bod <listitem>404 - Unknown version (<literal>UnknownVersion</literal>), 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>409 - Entry exists (<literal>EntryExists</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> @@ -1794,7 +1797,8 @@ reading request body failed <literal>Bod <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 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> -<listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>409 - Entry exists (<literal>EntryExists</literal>), +key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>413 - Request Entity Too Large, 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>
--- a/yaml/nginx_api.yaml +++ b/yaml/nginx_api.yaml @@ -896,6 +896,10 @@ paths: description: Method disabled (*MethodDisabled*) schema: $ref: '#/definitions/NginxError' + '409': + description: Entry exists (*EntryExists*) + schema: + $ref: '#/definitions/NginxError' '415': description: JSON error (*JsonError*) schema: @@ -1145,7 +1149,9 @@ paths: schema: $ref: '#/definitions/NginxError' '409': - description: Key already exists (*KeyvalKeyExists*) + description: | + Entry exists (*EntryExists*), + key already exists (*KeyvalKeyExists*) schema: $ref: '#/definitions/NginxError' '413': @@ -1602,6 +1608,10 @@ paths: description: Method disabled (*MethodDisabled*) schema: $ref: '#/definitions/NginxError' + '409': + description: Entry exists (*EntryExists*) + schema: + $ref: '#/definitions/NginxError' '415': description: JSON error (*JsonError*) schema: @@ -1851,7 +1861,9 @@ paths: schema: $ref: '#/definitions/NginxError' '409': - description: Key already exists (*KeyvalKeyExists*) + description: | + Entry exists (*EntryExists*), + key already exists (*KeyvalKeyExists*) schema: $ref: '#/definitions/NginxError' '413':