Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_api_module_head.xml @ 2866:8bd6f772005f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Sat, 25 Jun 2022 18:55:17 +0100
parents 9dd8c203a54a
children a85e4d126bc7
comparison
equal deleted inserted replaced
2865:0d355d154181 2866:8bd6f772005f
108 </example> 108 </example>
109 All API requests include 109 All API requests include
110 a supported API <link id="api_version">version</link> in the URI. 110 a supported API <link id="api_version">version</link> in the URI.
111 Examples of API requests with this configuration: 111 Examples of API requests with this configuration:
112 <example> 112 <example>
113 http://127.0.0.1/api/7/ 113 http://127.0.0.1/api/8/
114 http://127.0.0.1/api/7/nginx 114 http://127.0.0.1/api/8/nginx
115 http://127.0.0.1/api/7/connections 115 http://127.0.0.1/api/8/connections
116 http://127.0.0.1/api/7/http/requests 116 http://127.0.0.1/api/8/http/requests
117 http://127.0.0.1/api/7/http/server_zones/server_backend 117 http://127.0.0.1/api/8/http/server_zones/server_backend
118 http://127.0.0.1/api/7/http/caches/cache_backend 118 http://127.0.0.1/api/8/http/caches/cache_backend
119 http://127.0.0.1/api/7/http/upstreams/backend 119 http://127.0.0.1/api/8/http/upstreams/backend
120 http://127.0.0.1/api/7/http/upstreams/backend/servers/ 120 http://127.0.0.1/api/8/http/upstreams/backend/servers/
121 http://127.0.0.1/api/7/http/upstreams/backend/servers/1 121 http://127.0.0.1/api/8/http/upstreams/backend/servers/1
122 http://127.0.0.1/api/7/http/keyvals/one?key=arg1 122 http://127.0.0.1/api/8/http/keyvals/one?key=arg1
123 http://127.0.0.1/api/7/stream/ 123 http://127.0.0.1/api/8/stream/
124 http://127.0.0.1/api/7/stream/server_zones/server_backend 124 http://127.0.0.1/api/8/stream/server_zones/server_backend
125 http://127.0.0.1/api/7/stream/upstreams/ 125 http://127.0.0.1/api/8/stream/upstreams/
126 http://127.0.0.1/api/7/stream/upstreams/backend 126 http://127.0.0.1/api/8/stream/upstreams/backend
127 http://127.0.0.1/api/7/stream/upstreams/backend/servers/1 127 http://127.0.0.1/api/8/stream/upstreams/backend/servers/1
128 </example> 128 </example>
129 </para> 129 </para>
130 130
131 </section> 131 </section>
132 132
153 153
154 <para id="api_version"> 154 <para id="api_version">
155 All API requests should contain a supported API version in the URI. 155 All API requests should contain a supported API version in the URI.
156 If the request URI equals the location prefix, 156 If the request URI equals the location prefix,
157 the list of supported API versions is returned. 157 the list of supported API versions is returned.
158 The current API version is “<literal>7</literal>”. 158 The current API version is “<literal>8</literal>”.
159 </para> 159 </para>
160 160
161 <para> 161 <para>
162 The optional “<literal>fields</literal>” argument in the request line 162 The optional “<literal>fields</literal>” argument in the request line
163 specifies which fields of the requested objects will be output: 163 specifies which fields of the requested objects will be output:
164 <example> 164 <example>
165 http://127.0.0.1/api/7/nginx?fields=version,build 165 http://127.0.0.1/api/8/nginx?fields=version,build
166 </example> 166 </example>
167 </para> 167 </para>
168 168
169 </directive> 169 </directive>
170 170
206 206
207 <para> 207 <para>
208 <list type="bullet"> 208 <list type="bullet">
209 209
210 <listitem> 210 <listitem>
211 The <literal>ssl</literal> data
212 for each HTTP
213 <link id="def_nginx_http_upstream">upstream</link>,
214 <link id="def_nginx_http_server_zone">server zone</link>,
215 and stream
216 <link id="def_nginx_stream_upstream">upstream</link>,
217 <link id="def_nginx_stream_server_zone">server zone</link>,
218 were added in <link id="api_version">version</link> 8.
219 </listitem>
220
221 <listitem>
211 The <literal>codes</literal> data 222 The <literal>codes</literal> data
212 in <literal>responses</literal> for each HTTP 223 in <literal>responses</literal> for each HTTP
213 <link id="def_nginx_http_upstream">upstream</link>, 224 <link id="def_nginx_http_upstream">upstream</link>,
214 <link id="def_nginx_http_server_zone">server zone</link>, and 225 <link id="def_nginx_http_server_zone">server zone</link>, and
215 <link id="def_nginx_http_location_zone">location zone</link> 226 <link id="def_nginx_http_location_zone">location zone</link>