Mercurial > hg > nginx-site
changeset 2494:78d4e25adf49
Documented "BodyReadError" in the API.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Wed, 29 Jan 2020 19:21:26 +0000 |
parents | 407147d8020f |
children | e4332b7580bb |
files | xml/en/docs/http/ngx_http_api_module.xml yaml/nginx_api.yaml |
diffstat | 2 files changed, 26 insertions(+), 10 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 @@ -1011,6 +1011,7 @@ invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), +reading request body failed <literal>BodyReadError</literal>), route is too long (<literal>UpstreamBadRoute</literal>), “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), @@ -1083,6 +1084,7 @@ invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), +reading request body failed <literal>BodyReadError</literal>), route is too long (<literal>UpstreamBadRoute</literal>), “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), @@ -1194,7 +1196,8 @@ Possible responses: invalid key format (<literal>KeyvalFormatError</literal>), key required (<literal>KeyvalFormatError</literal>), keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), -only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> +only one key can be added (<literal>KeyvalFormatError</literal>), +reading request body failed <literal>BodyReadError</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> @@ -1222,7 +1225,8 @@ Possible responses: <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), key required (<literal>KeyvalFormatError</literal>), keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), -only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> +only one key can be updated (<literal>KeyvalFormatError</literal>), +reading request body failed <literal>BodyReadError</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> @@ -1545,7 +1549,8 @@ invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), no resolver defined to resolve (<literal>UpstreamConfNoResolver</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> +upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), +reading request body failed <literal>BodyReadError</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> @@ -1614,6 +1619,7 @@ invalid “<literal>max_conns</literal>” (<literal>UpstreamBadMaxConns</literal>), invalid “<literal>max_fails</literal>” (<literal>UpstreamBadMaxFails</literal>), invalid “<literal>fail_timeout</literal>” (<literal>UpstreamBadFailTimeout</literal>), invalid “<literal>slow_start</literal>” (<literal>UpstreamBadSlowStart</literal>), +reading request body failed <literal>BodyReadError</literal>), “<literal>service</literal>” is empty (<literal>UpstreamBadService</literal>), server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), @@ -1724,7 +1730,8 @@ Possible responses: invalid key format (<literal>KeyvalFormatError</literal>), key required (<literal>KeyvalFormatError</literal>), keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), -only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> +only one key can be added (<literal>KeyvalFormatError</literal>), +reading request body failed <literal>BodyReadError</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> @@ -1752,7 +1759,8 @@ Possible responses: <listitem>400 - Invalid JSON (<literal>KeyvalFormatError</literal>), key required (<literal>KeyvalFormatError</literal>), keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), -only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> +only one key can be updated (<literal>KeyvalFormatError</literal>), +reading request body failed <literal>BodyReadError</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>
--- a/yaml/nginx_api.yaml +++ b/yaml/nginx_api.yaml @@ -776,6 +776,7 @@ paths: invalid “*max_fails*” (*UpstreamBadMaxFails*), invalid “*fail_timeout*” (*UpstreamBadFailTimeout*), invalid “*slow_start*” (*UpstreamBadSlowStart*), + reading request body failed *BodyReadError*), route is too long (*UpstreamBadRoute*), “*service*” is empty (*UpstreamBadService*), no resolver defined to resolve (*UpstreamConfNoResolver*), @@ -873,6 +874,7 @@ paths: invalid “*max_fails*” (*UpstreamBadMaxFails*), invalid “*fail_timeout*” (*UpstreamBadFailTimeout*), invalid “*slow_start*” (*UpstreamBadSlowStart*), + reading request body failed *BodyReadError*), route is too long (*UpstreamBadRoute*), “*service*” is empty (*UpstreamBadService*), server “**ID**” address is immutable (*UpstreamServerImmutable*), @@ -1016,7 +1018,8 @@ paths: invalid key format (*KeyvalFormatError*), key required (*KeyvalFormatError*), keyval timeout is not enabled (*KeyvalFormatError*), - only one key can be added (*KeyvalFormatError*) + only one key can be added (*KeyvalFormatError*), + reading request body failed *BodyReadError*) schema: $ref: '#/definitions/NginxError' '404': @@ -1075,7 +1078,8 @@ paths: Invalid JSON (*KeyvalFormatError*), key required (*KeyvalFormatError*), keyval timeout is not enabled (*KeyvalFormatError*), - only one key can be updated (*KeyvalFormatError*) + only one key can be updated (*KeyvalFormatError*), + reading request body failed *BodyReadError*) schema: $ref: '#/definitions/NginxError' '404': @@ -1442,7 +1446,8 @@ paths: “*service*” is empty (*UpstreamBadService*), no resolver defined to resolve (*UpstreamConfNoResolver*), upstream “**name**” has no backup (*UpstreamNoBackup*), - upstream “**name**” memory exhausted (*UpstreamOutOfMemory*) + upstream “**name**” memory exhausted (*UpstreamOutOfMemory*), + reading request body failed *BodyReadError*) schema: $ref: '#/definitions/NginxError' '404': @@ -1537,6 +1542,7 @@ paths: invalid “*max_fails*” (*UpstreamBadMaxFails*), invalid “*fail_timeout*” (*UpstreamBadFailTimeout*), invalid “*slow_start*” (*UpstreamBadSlowStart*), + reading request body failed *BodyReadError*), “*service*” is empty (*UpstreamBadService*), server “**ID**” address is immutable (*UpstreamServerImmutable*), server “**ID**” weight is immutable (*UpstreamServerWeightImmutable*), @@ -1679,7 +1685,8 @@ paths: invalid key format (*KeyvalFormatError*), key required (*KeyvalFormatError*), keyval timeout is not enabled (*KeyvalFormatError*), - only one key can be added (*KeyvalFormatError*) + only one key can be added (*KeyvalFormatError*), + reading request body failed *BodyReadError*) schema: $ref: '#/definitions/NginxError' '404': @@ -1739,7 +1746,8 @@ paths: Invalid JSON (*KeyvalFormatError*), key required (*KeyvalFormatError*), keyval timeout is not enabled (*KeyvalFormatError*), - only one key can be updated (*KeyvalFormatError*) + only one key can be updated (*KeyvalFormatError*), + reading request body failed *BodyReadError*) schema: $ref: '#/definitions/NginxError' '404':