diff xml/en/docs/http/ngx_http_api_module_head.xml @ 2359:d5e576eb7677

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 08 Apr 2019 11:45:08 +0300
parents 45a2b90247ad
children dd3ac7eefeed
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/3/
-http://127.0.0.1/api/3/nginx
-http://127.0.0.1/api/3/connections
-http://127.0.0.1/api/3/http/requests
-http://127.0.0.1/api/3/http/server_zones/server_backend
-http://127.0.0.1/api/3/http/caches/cache_backend
-http://127.0.0.1/api/3/http/upstreams/backend
-http://127.0.0.1/api/3/http/upstreams/backend/servers/
-http://127.0.0.1/api/3/http/upstreams/backend/servers/1
-http://127.0.0.1/api/3/http/keyvals/one?key=arg1
-http://127.0.0.1/api/3/stream/
-http://127.0.0.1/api/3/stream/server_zones/server_backend
-http://127.0.0.1/api/3/stream/upstreams/
-http://127.0.0.1/api/3/stream/upstreams/backend
-http://127.0.0.1/api/3/stream/upstreams/backend/servers/1
+http://127.0.0.1/api/4/
+http://127.0.0.1/api/4/nginx
+http://127.0.0.1/api/4/connections
+http://127.0.0.1/api/4/http/requests
+http://127.0.0.1/api/4/http/server_zones/server_backend
+http://127.0.0.1/api/4/http/caches/cache_backend
+http://127.0.0.1/api/4/http/upstreams/backend
+http://127.0.0.1/api/4/http/upstreams/backend/servers/
+http://127.0.0.1/api/4/http/upstreams/backend/servers/1
+http://127.0.0.1/api/4/http/keyvals/one?key=arg1
+http://127.0.0.1/api/4/stream/
+http://127.0.0.1/api/4/stream/server_zones/server_backend
+http://127.0.0.1/api/4/stream/upstreams/
+http://127.0.0.1/api/4/stream/upstreams/backend
+http://127.0.0.1/api/4/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>3</literal>”.
+The current API version is “<literal>4</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/3/nginx?fields=version,build
+http://127.0.0.1/api/4/nginx?fields=version,build
 </example>
 </para>
 
@@ -185,6 +185,14 @@ Several servers may share the same zone.
 <list type="bullet">
 
 <listitem>
+The <literal>path</literal> and <literal>method</literal> fields of
+<link id="def_nginx_error">nginx error object</link>
+were removed in <link id="api_version">version</link> 4.
+These fields continue to exist in earlier api versions,
+but show an empty value.
+</listitem>
+
+<listitem>
 The <link id="stream_zone_sync_">/stream/zone_sync/</link> data
 were added in <link id="api_version">version</link> 3.
 </listitem>