Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module.xml @ 2493:407147d8020f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented 413 error for PATCH and POST methods in the API.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 19 Dec 2019 16:29:20 +0300
parents 98fd810c13e0
children 78d4e25adf49
comparison
equal deleted inserted replaced
2492:70119804679c 2493:407147d8020f
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_api_module" 9 <module name="Module ngx_http_api_module"
10 link="/en/docs/http/ngx_http_api_module.html" 10 link="/en/docs/http/ngx_http_api_module.html"
11 lang="en" 11 lang="en"
12 rev="2"> 12 rev="3">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_api_module</literal> module (1.13.3) provides REST API 17 The <literal>ngx_http_api_module</literal> module (1.13.3) provides REST API
26 The module supersedes the 26 The module supersedes the
27 <link doc="ngx_http_status_module.xml">ngx_http_status_module</link> and 27 <link doc="ngx_http_status_module.xml">ngx_http_status_module</link> and
28 <link doc="ngx_http_upstream_conf_module.xml">ngx_http_upstream_conf_module</link> 28 <link doc="ngx_http_upstream_conf_module.xml">ngx_http_upstream_conf_module</link>
29 modules. 29 modules.
30 </note> 30 </note>
31 </para>
32
33 <para>
34 When using the <literal>PATCH</literal> or <literal>POST</literal> methods,
35 make sure that the payload does not exceed the
36 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">buffer size</link>
37 for reading the client request body, otherwise, the
38 <http-status code="413" text="Request Entity Too Large"/>
39 error may be returned.
31 </para> 40 </para>
32 41
33 <para> 42 <para>
34 <note> 43 <note>
35 This module is available as part of our 44 This module is available as part of our
1187 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1196 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1188 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1197 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1189 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1198 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1190 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1199 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1191 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1200 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1201 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1192 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1202 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1193 </list> 1203 </list>
1194 </listitem> 1204 </listitem>
1195 <listitem id="patchHttpKeyvalZoneKeyValue"> 1205 <listitem id="patchHttpKeyvalZoneKeyValue">
1196 <literal>PATCH</literal> - Modify a key-value or delete a key 1206 <literal>PATCH</literal> - Modify a key-value or delete a key
1214 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1224 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1215 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1225 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1216 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1226 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1217 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1227 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1218 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1228 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1229 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1219 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1230 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1220 </list> 1231 </list>
1221 </listitem> 1232 </listitem>
1222 <listitem id="deleteHttpKeyvalZoneData"> 1233 <listitem id="deleteHttpKeyvalZoneData">
1223 <literal>DELETE</literal> - Empty the HTTP keyval zone 1234 <literal>DELETE</literal> - Empty the HTTP keyval zone
1715 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1726 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1716 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1727 only one key can be added (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1717 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1728 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1718 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1729 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1719 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1730 <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1731 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1720 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1732 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1721 </list> 1733 </list>
1722 </listitem> 1734 </listitem>
1723 <listitem id="patchStreamKeyvalZoneKeyValue"> 1735 <listitem id="patchStreamKeyvalZoneKeyValue">
1724 <literal>PATCH</literal> - Modify a key-value or delete a key 1736 <literal>PATCH</literal> - Modify a key-value or delete a key
1742 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), 1754 keyval timeout is not enabled (<literal>KeyvalFormatError</literal>),
1743 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1755 only one key can be updated (<literal>KeyvalFormatError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1744 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), 1756 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
1745 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1757 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1746 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1758 <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1759 <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
1747 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> 1760 <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
1748 </list> 1761 </list>
1749 </listitem> 1762 </listitem>
1750 <listitem id="deleteStreamKeyvalZoneData"> 1763 <listitem id="deleteStreamKeyvalZoneData">
1751 <literal>DELETE</literal> - Empty the stream keyval zone 1764 <literal>DELETE</literal> - Empty the stream keyval zone