diff xml/en/docs/http/ngx_http_api_module_head.xml @ 2768:9dd8c203a54a

Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 22 Sep 2021 13:47:23 +0300
parents 407147d8020f
children 8bd6f772005f
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
@@ -110,21 +110,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/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
+http://127.0.0.1/api/7/
+http://127.0.0.1/api/7/nginx
+http://127.0.0.1/api/7/connections
+http://127.0.0.1/api/7/http/requests
+http://127.0.0.1/api/7/http/server_zones/server_backend
+http://127.0.0.1/api/7/http/caches/cache_backend
+http://127.0.0.1/api/7/http/upstreams/backend
+http://127.0.0.1/api/7/http/upstreams/backend/servers/
+http://127.0.0.1/api/7/http/upstreams/backend/servers/1
+http://127.0.0.1/api/7/http/keyvals/one?key=arg1
+http://127.0.0.1/api/7/stream/
+http://127.0.0.1/api/7/stream/server_zones/server_backend
+http://127.0.0.1/api/7/stream/upstreams/
+http://127.0.0.1/api/7/stream/upstreams/backend
+http://127.0.0.1/api/7/stream/upstreams/backend/servers/1
 </example>
 </para>
 
@@ -155,14 +155,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>6</literal>”.
+The current API version is “<literal>7</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/6/nginx?fields=version,build
+http://127.0.0.1/api/7/nginx?fields=version,build
 </example>
 </para>
 
@@ -208,6 +208,15 @@ redirect</link> happens during request p
 <list type="bullet">
 
 <listitem>
+The <literal>codes</literal> data
+in <literal>responses</literal> for each HTTP
+<link id="def_nginx_http_upstream">upstream</link>,
+<link id="def_nginx_http_server_zone">server zone</link>, and
+<link id="def_nginx_http_location_zone">location zone</link>
+were added in <link id="api_version">version</link> 7.
+</listitem>
+
+<listitem>
 The <link id="stream_limit_conns_">/stream/limit_conns/</link> data
 were added in <link id="api_version">version</link> 6.
 </listitem>