diff xml/en/docs/http/ngx_http_api_module_head.xml @ 2469:98fd810c13e0

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 02 Dec 2019 13:23:05 +0300
parents dd3ac7eefeed
children 407147d8020f
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_api_module_head.xml
+++ b/xml/en/docs/http/ngx_http_api_module_head.xml
@@ -101,21 +101,21 @@ All API requests include
 a supported API <link id="api_version">version</link> in the URI.
 Examples of API requests with this configuration:
 <example>
-http://127.0.0.1/api/5/
-http://127.0.0.1/api/5/nginx
-http://127.0.0.1/api/5/connections
-http://127.0.0.1/api/5/http/requests
-http://127.0.0.1/api/5/http/server_zones/server_backend
-http://127.0.0.1/api/5/http/caches/cache_backend
-http://127.0.0.1/api/5/http/upstreams/backend
-http://127.0.0.1/api/5/http/upstreams/backend/servers/
-http://127.0.0.1/api/5/http/upstreams/backend/servers/1
-http://127.0.0.1/api/5/http/keyvals/one?key=arg1
-http://127.0.0.1/api/5/stream/
-http://127.0.0.1/api/5/stream/server_zones/server_backend
-http://127.0.0.1/api/5/stream/upstreams/
-http://127.0.0.1/api/5/stream/upstreams/backend
-http://127.0.0.1/api/5/stream/upstreams/backend/servers/1
+http://127.0.0.1/api/6/
+http://127.0.0.1/api/6/nginx
+http://127.0.0.1/api/6/connections
+http://127.0.0.1/api/6/http/requests
+http://127.0.0.1/api/6/http/server_zones/server_backend
+http://127.0.0.1/api/6/http/caches/cache_backend
+http://127.0.0.1/api/6/http/upstreams/backend
+http://127.0.0.1/api/6/http/upstreams/backend/servers/
+http://127.0.0.1/api/6/http/upstreams/backend/servers/1
+http://127.0.0.1/api/6/http/keyvals/one?key=arg1
+http://127.0.0.1/api/6/stream/
+http://127.0.0.1/api/6/stream/server_zones/server_backend
+http://127.0.0.1/api/6/stream/upstreams/
+http://127.0.0.1/api/6/stream/upstreams/backend
+http://127.0.0.1/api/6/stream/upstreams/backend/servers/1
 </example>
 </para>
 
@@ -146,14 +146,14 @@ By default, the API is read-only.
 All API requests should contain a supported API version in the URI.
 If the request URI equals the location prefix,
 the list of supported API versions is returned.
-The current API version is “<literal>5</literal>”.
+The current API version is “<literal>6</literal>”.
 </para>
 
 <para>
 The optional “<literal>fields</literal>” argument in the request line
 specifies which fields of the requested objects will be output:
 <example>
-http://127.0.0.1/api/5/nginx?fields=version,build
+http://127.0.0.1/api/6/nginx?fields=version,build
 </example>
 </para>
 
@@ -199,6 +199,21 @@ redirect</link> happens during request p
 <list type="bullet">
 
 <listitem>
+The <link id="stream_limit_conns_">/stream/limit_conns/</link> data
+were added in <link id="api_version">version</link> 6.
+</listitem>
+
+<listitem>
+The <link id="http_limit_conns_">/http/limit_conns/</link> data
+were added in <link id="api_version">version</link> 6.
+</listitem>
+
+<listitem>
+The <link id="http_limit_reqs_">/http/limit_reqs/</link> data
+were added in <link id="api_version">version</link> 6.
+</listitem>
+
+<listitem>
 The “<literal>expire</literal>” parameter of a
 <link doc="ngx_http_keyval_module.xml">key-value</link> pair can be
 <link id="postHttpKeyvalZoneData">set</link> or