Mercurial > hg > nginx-site

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

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 Ruslan Ermilov <ru@nginx.com>
date Mon, 08 Apr 2019 11:45:08 +0300
parents 45a2b90247ad
children dd3ac7eefeed
comparison
equal deleted inserted replaced
2358:ee4eccd811cd 2359:d5e576eb7677
99 </example> 99 </example>
100 All API requests include 100 All API requests include
101 a supported API <link id="api_version">version</link> in the URI. 101 a supported API <link id="api_version">version</link> in the URI.
102 Examples of API requests with this configuration: 102 Examples of API requests with this configuration:
103 <example> 103 <example>
104 http://127.0.0.1/api/3/ 104 http://127.0.0.1/api/4/
105 http://127.0.0.1/api/3/nginx 105 http://127.0.0.1/api/4/nginx
106 http://127.0.0.1/api/3/connections 106 http://127.0.0.1/api/4/connections
107 http://127.0.0.1/api/3/http/requests 107 http://127.0.0.1/api/4/http/requests
108 http://127.0.0.1/api/3/http/server_zones/server_backend 108 http://127.0.0.1/api/4/http/server_zones/server_backend
109 http://127.0.0.1/api/3/http/caches/cache_backend 109 http://127.0.0.1/api/4/http/caches/cache_backend
110 http://127.0.0.1/api/3/http/upstreams/backend 110 http://127.0.0.1/api/4/http/upstreams/backend
111 http://127.0.0.1/api/3/http/upstreams/backend/servers/ 111 http://127.0.0.1/api/4/http/upstreams/backend/servers/
112 http://127.0.0.1/api/3/http/upstreams/backend/servers/1 112 http://127.0.0.1/api/4/http/upstreams/backend/servers/1
113 http://127.0.0.1/api/3/http/keyvals/one?key=arg1 113 http://127.0.0.1/api/4/http/keyvals/one?key=arg1
114 http://127.0.0.1/api/3/stream/ 114 http://127.0.0.1/api/4/stream/
115 http://127.0.0.1/api/3/stream/server_zones/server_backend 115 http://127.0.0.1/api/4/stream/server_zones/server_backend
116 http://127.0.0.1/api/3/stream/upstreams/ 116 http://127.0.0.1/api/4/stream/upstreams/
117 http://127.0.0.1/api/3/stream/upstreams/backend 117 http://127.0.0.1/api/4/stream/upstreams/backend
118 http://127.0.0.1/api/3/stream/upstreams/backend/servers/1 118 http://127.0.0.1/api/4/stream/upstreams/backend/servers/1
119 </example> 119 </example>
120 </para> 120 </para>
121 121
122 </section> 122 </section>
123 123
144 144
145 <para id="api_version"> 145 <para id="api_version">
146 All API requests should contain a supported API version in the URI. 146 All API requests should contain a supported API version in the URI.
147 If the request URI equals the location prefix, 147 If the request URI equals the location prefix,
148 the list of supported API versions is returned. 148 the list of supported API versions is returned.
149 The current API version is “<literal>3</literal>”. 149 The current API version is “<literal>4</literal>”.
150 </para> 150 </para>
151 151
152 <para> 152 <para>
153 The optional “<literal>fields</literal>” argument in the request line 153 The optional “<literal>fields</literal>” argument in the request line
154 specifies which fields of the requested objects will be output: 154 specifies which fields of the requested objects will be output:
155 <example> 155 <example>
156 http://127.0.0.1/api/3/nginx?fields=version,build 156 http://127.0.0.1/api/4/nginx?fields=version,build
157 </example> 157 </example>
158 </para> 158 </para>
159 159
160 </directive> 160 </directive>
161 161
183 183
184 <para> 184 <para>
185 <list type="bullet"> 185 <list type="bullet">
186 186
187 <listitem> 187 <listitem>
188 The <literal>path</literal> and <literal>method</literal> fields of
189 <link id="def_nginx_error">nginx error object</link>
190 were removed in <link id="api_version">version</link> 4.
191 These fields continue to exist in earlier api versions,
192 but show an empty value.
193 </listitem>
194
195 <listitem>
188 The <link id="stream_zone_sync_">/stream/zone_sync/</link> data 196 The <link id="stream_zone_sync_">/stream/zone_sync/</link> data
189 were added in <link id="api_version">version</link> 3. 197 were added in <link id="api_version">version</link> 3.
190 </listitem> 198 </listitem>
191 199
192 <listitem> 200 <listitem>