Mercurial > hg > nginx-site
diff xml/en/docs/http/ngx_http_api_module_head.xml @ 2139:f6e578b1b02d
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Mon, 09 Apr 2018 11:52:48 +0300 |
parents | fee7627f6a5a |
children | 45a2b90247ad |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_api_module_head.xml Thu Apr 05 16:14:30 2018 +0000 +++ b/xml/en/docs/http/ngx_http_api_module_head.xml Mon Apr 09 11:52:48 2018 +0300 @@ -101,21 +101,21 @@ 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/2/ -http://127.0.0.1/api/2/nginx -http://127.0.0.1/api/2/connections -http://127.0.0.1/api/2/http/requests -http://127.0.0.1/api/2/http/server_zones/server_backend -http://127.0.0.1/api/2/http/caches/cache_backend -http://127.0.0.1/api/2/http/upstreams/backend -http://127.0.0.1/api/2/http/upstreams/backend/servers/ -http://127.0.0.1/api/2/http/upstreams/backend/servers/1 -http://127.0.0.1/api/2/http/keyvals/one?key=arg1 -http://127.0.0.1/api/2/stream/ -http://127.0.0.1/api/2/stream/server_zones/server_backend -http://127.0.0.1/api/2/stream/upstreams/ -http://127.0.0.1/api/2/stream/upstreams/backend -http://127.0.0.1/api/2/stream/upstreams/backend/servers/1 +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 </example> </para> @@ -146,14 +146,14 @@ 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>2</literal>”. +The current API version is “<literal>3</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/2/nginx?fields=version,build +http://127.0.0.1/api/3/nginx?fields=version,build </example> </para> @@ -167,6 +167,11 @@ <list type="bullet"> <listitem> +The <link id="stream_zone_sync_">/stream/zone_sync/</link> data +were added in <link id="api_version">version</link> 3. +</listitem> + +<listitem> The <link id="def_nginx_http_upstream_conf_server">drain</link> parameter was added in <link id="api_version">version</link> 2. </listitem>