Mercurial > hg > nginx-site
changeset 2221:45a2b90247ad
Added "status_zone" to the API module.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 24 Apr 2018 18:55:54 +0300 |
parents | 896562a1ccde |
children | 0974dc0a6209 |
files | xml/en/docs/http/ngx_http_api_module.xml xml/en/docs/http/ngx_http_api_module_head.xml yaml/nginx_api.yaml |
diffstat | 3 files changed, 44 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_api_module.xml Wed Aug 15 13:52:53 2018 +0300 +++ b/xml/en/docs/http/ngx_http_api_module.xml Tue Apr 24 18:55:54 2018 +0300 @@ -9,7 +9,7 @@ <module name="Module ngx_http_api_module" link="/en/docs/http/ngx_http_api_module.html" lang="en" - rev="1"> + rev="2"> <section id="summary"> @@ -159,6 +159,24 @@ </directive> + +<directive name="status_zone"> +<syntax><value>zone</value></syntax> +<default/> +<context>server</context> +<appeared-in>1.13.12</appeared-in> + +<para> +Enables collection of virtual +<link doc="ngx_http_core_module.xml" id="server">http</link> +or +<link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link> +server status information in the specified <value>zone</value>. +Several servers may share the same zone. +</para> + +</directive> + </section> <section id="compatibility" name="Compatibility"> @@ -473,7 +491,7 @@ <list type="bullet" compact="yes"> <listitem id="getHttpServerZones"> <literal>GET</literal> - Return status of all HTTP server zones -<para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">server zone</link>.</para> +<para>Returns status information for each HTTP <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para> <para> Request parameters: <list type="tag"> @@ -998,7 +1016,7 @@ <list type="bullet" compact="yes"> <listitem id="getStreamServerZones"> <literal>GET</literal> - Return status of all stream server zones -<para>Returns status information for each stream <link url="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">server zone</link>.</para> +<para>Returns status information for each stream <link url="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">server zone</link>.</para> <para> Request parameters: <list type="tag">
--- a/xml/en/docs/http/ngx_http_api_module_head.xml Wed Aug 15 13:52:53 2018 +0300 +++ b/xml/en/docs/http/ngx_http_api_module_head.xml Tue Apr 24 18:55:54 2018 +0300 @@ -9,7 +9,7 @@ <module name="Module ngx_http_api_module" link="/en/docs/http/ngx_http_api_module.html" lang="en" - rev="1"> + rev="2"> <section id="summary"> @@ -159,6 +159,24 @@ </directive> + +<directive name="status_zone"> +<syntax><value>zone</value></syntax> +<default/> +<context>server</context> +<appeared-in>1.13.12</appeared-in> + +<para> +Enables collection of virtual +<link doc="ngx_http_core_module.xml" id="server">http</link> +or +<link doc="../stream/ngx_stream_core_module.xml" id="server">stream</link> +server status information in the specified <value>zone</value>. +Several servers may share the same zone. +</para> + +</directive> + </section> <section id="compatibility" name="Compatibility">
--- a/yaml/nginx_api.yaml Wed Aug 15 13:52:53 2018 +0300 +++ b/yaml/nginx_api.yaml Tue Apr 24 18:55:54 2018 +0300 @@ -288,7 +288,7 @@ - Method GET summary: Return status of all HTTP server zones description: Returns status information for each HTTP - [server zone](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone). + [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone). operationId: getHttpServerZones produces: - application/json @@ -910,7 +910,7 @@ - Method GET summary: Return status of all stream server zones description: Returns status information for each stream - [server zone](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone). + [server zone](https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone). operationId: getStreamServerZones produces: - application/json @@ -1768,7 +1768,7 @@ title: HTTP Server Zones description: | Status data for all HTTP - <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">status zones</a>. + <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">status zones</a>. type: object additionalProperties: $ref: '#/definitions/NginxHTTPServerZone' @@ -2630,7 +2630,7 @@ title: Stream Server Zones description: | Status information for all stream - <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone">status zones</a>. + <a href="https://nginx.org/en/docs/http/ngx_http_api_module.html#status_zone">status zones</a>. type: object additionalProperties: $ref: '#/definitions/NginxStreamServerZone'