Mercurial > hg > nginx-site
changeset 2499:20dbb29cbe05
Documented the "Unknown version" error in the API.
| author | Yaroslav Zhuravlev <yar@nginx.com> |
|---|---|
| date | Mon, 03 Feb 2020 17:04:41 +0000 |
| parents | 9ceda894f3d7 |
| children | 8a9b2efa92aa |
| files | xml/en/docs/http/ngx_http_api_module.xml yaml/nginx_api.yaml |
| diffstat | 2 files changed, 321 insertions(+), 90 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_api_module.xml +++ b/xml/en/docs/http/ngx_http_api_module.xml @@ -284,6 +284,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns an array of strings</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -311,6 +312,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_object">nginx</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -329,6 +331,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteProcesses"> @@ -339,6 +342,7 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -366,6 +370,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteConnections"> @@ -376,6 +381,7 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -403,6 +409,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link>" objects for all slabs</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -437,7 +444,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link></listitem> -<listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Slab not found (<literal>SlabNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteSlabZoneStats"> @@ -448,7 +456,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Slab not found (<literal>SlabNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -468,6 +477,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns an array of strings</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -495,6 +505,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteHttpRequests"> @@ -505,6 +516,7 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -533,6 +545,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_server_zone">HTTP Server Zone</link>" objects for all HTTP server zones</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -567,7 +580,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_server_zone">HTTP Server Zone</link></listitem> -<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteHttpServerZoneStat"> @@ -578,7 +592,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -607,6 +622,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_location_zone">HTTP Location Zone</link>" objects for all HTTP location zones</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -641,7 +657,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_location_zone">HTTP Location Zone</link></listitem> -<listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteHttpLocationZoneStat"> @@ -652,7 +669,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -681,6 +699,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all HTTP caches</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -715,7 +734,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_cache">HTTP Cache</link></listitem> -<listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Cache not found (<literal>CacheNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteHttpCacheZoneStat"> @@ -726,7 +746,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Cache not found (<literal>CacheNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -755,6 +776,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link>" objects for all HTTP limit conns</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -789,7 +811,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link></listitem> -<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteHttpLimitConnZoneStat"> @@ -800,7 +823,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -829,6 +853,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link>" objects for all HTTP limit reqs</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -863,7 +888,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link></listitem> -<listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteHttpLimitReqZoneStat"> @@ -874,7 +900,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -903,6 +930,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all HTTP upstreams</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -938,7 +966,8 @@ Possible responses: <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_upstream">HTTP Upstream</link></listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteHttpUpstreamStat"> @@ -950,7 +979,8 @@ Possible responses: <list type="bullet"> <listitem>204 - Success</listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -978,7 +1008,8 @@ Possible responses: <list type="bullet"> <listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="postHttpUpstreamServer"> @@ -1017,7 +1048,8 @@ route is too long (<literal>UpstreamBadR no resolver defined to resolve (<literal>UpstreamConfNoResolver</literal>), upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> @@ -1051,8 +1083,9 @@ Possible responses: <listitem>200 - Success, returns <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Server</link></listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), -server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="patchHttpUpstreamPeer"> @@ -1090,8 +1123,9 @@ route is too long (<literal>UpstreamBadR server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), -server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> @@ -1107,8 +1141,9 @@ Possible responses: <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), invalid server ID (<literal>UpstreamBadServerId</literal>), server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), -server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1137,6 +1172,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link>" objects for all HTTP keyvals</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1172,7 +1208,8 @@ Possible responses: <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link></listitem> <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), -keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +keyval key not found (<literal>KeyvalKeyNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="postHttpKeyvalZoneData"> @@ -1198,7 +1235,8 @@ key required (<literal>KeyvalFormatError keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), only one key can be added (<literal>KeyvalFormatError</literal>), reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> @@ -1228,7 +1266,8 @@ keyval timeout is not enabled (<literal> only one key can be updated (<literal>KeyvalFormatError</literal>), reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), -keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +keyval key not found (<literal>KeyvalKeyNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> @@ -1242,7 +1281,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1262,6 +1302,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns an array of strings</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1289,6 +1330,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_server_zone">Stream Server Zone</link>" objects for all stream server zones</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1323,7 +1365,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem> -<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteStreamServerZoneStat"> @@ -1334,7 +1377,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1363,6 +1407,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link>" objects for all stream limit conns</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1397,7 +1442,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link></listitem> -<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteStreamLimitConnZoneStat"> @@ -1408,7 +1454,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1437,6 +1484,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1472,7 +1520,8 @@ Possible responses: <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_stream_upstream">Stream Upstream</link></listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteStreamUpstreamStat"> @@ -1484,7 +1533,8 @@ Possible responses: <list type="bullet"> <listitem>204 - Success</listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1512,7 +1562,8 @@ Possible responses: <list type="bullet"> <listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="postStreamUpstreamServer"> @@ -1551,7 +1602,8 @@ no resolver defined to resolve (<literal upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>), upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> @@ -1585,7 +1637,8 @@ Possible responses: <listitem>200 - Success, returns <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Server</link></listitem> <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1624,8 +1677,9 @@ reading request body failed <literal>Bod server “<value>ID</value>” address is immutable (<literal>UpstreamServerImmutable</literal>), server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>), upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), -server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> @@ -1641,8 +1695,9 @@ Possible responses: <listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), invalid server ID (<literal>UpstreamBadServerId</literal>), server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), -server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), +upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1671,6 +1726,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link>" objects for all stream keyvals</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1706,7 +1762,8 @@ Possible responses: <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link></listitem> <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), -keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +keyval key not found (<literal>KeyvalKeyNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="postStreamKeyvalZoneData"> @@ -1732,7 +1789,8 @@ key required (<literal>KeyvalFormatError keyval timeout is not enabled (<literal>KeyvalFormatError</literal>), only one key can be added (<literal>KeyvalFormatError</literal>), reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> -<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> @@ -1762,7 +1820,8 @@ keyval timeout is not enabled (<literal> only one key can be updated (<literal>KeyvalFormatError</literal>), reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), -keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +keyval key not found (<literal>KeyvalKeyNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem> <listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem> @@ -1776,7 +1835,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1796,6 +1856,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1823,6 +1884,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns a collection of "<link id="def_nginx_resolver_zone">Resolver Zone</link>" objects for all resolvers</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list> @@ -1857,7 +1919,8 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_resolver_zone">Resolver Zone</link></listitem> -<listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteResolverZoneStat"> @@ -1868,7 +1931,8 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> -<listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem> +<listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), +unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> <listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> @@ -1897,6 +1961,7 @@ Possible responses: </para> <list type="bullet"> <listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> <listitem id="deleteSslStat"> @@ -1907,6 +1972,7 @@ Possible responses: </para> <list type="bullet"> <listitem>204 - Success</listitem> +<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem> </list> </listitem> </list>
--- a/yaml/nginx_api.yaml +++ b/yaml/nginx_api.yaml @@ -54,6 +54,10 @@ paths: description: Success schema: $ref: '#/definitions/ArrayOfStrings' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' /nginx: get: tags: @@ -75,6 +79,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxObject' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' /processes: get: tags: @@ -91,6 +99,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxProcesses' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' delete: tags: - Processes @@ -102,6 +114,10 @@ paths: responses: '204': description: Success + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' /connections: get: tags: @@ -117,6 +133,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxConnections' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' parameters: - in: query name: fields @@ -133,6 +153,10 @@ paths: responses: '204': description: Success + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' /slabs/: get: tags: @@ -156,6 +180,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxSlabZoneMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/slabs/{slabZoneName}': parameters: - name: slabZoneName @@ -184,7 +212,9 @@ paths: schema: $ref: '#/definitions/NginxSlabZone' '404': - description: Slab not found (*SlabNotFound*) + description: | + Slab not found (*SlabNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -199,7 +229,9 @@ paths: '204': description: Success '404': - description: Slab not found (*SlabNotFound*) + description: | + Slab not found (*SlabNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -221,6 +253,10 @@ paths: description: Success schema: $ref: '#/definitions/ArrayOfStrings' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' /http/requests: get: tags: @@ -242,6 +278,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPRequests' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' delete: tags: - HTTP Requests @@ -252,6 +292,10 @@ paths: responses: '204': description: Success + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '405': description: Method disabled (*MethodDisabled*) schema: @@ -279,6 +323,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPServerZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/http/server_zones/{httpServerZoneName}': parameters: - name: httpServerZoneName @@ -306,7 +354,9 @@ paths: schema: $ref: '#/definitions/NginxHTTPServerZone' '404': - description: Server zone not found (*ServerZoneNotFound*) + description: | + Server zone not found (*ServerZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -321,7 +371,9 @@ paths: '204': description: Success '404': - description: Server zone not found (*ServerZoneNotFound*) + description: | + Server zone not found (*ServerZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -351,6 +403,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPLocationZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/http/location_zones/{httpLocationZoneName}': parameters: - name: httpLocationZoneName @@ -379,7 +435,9 @@ paths: schema: $ref: '#/definitions/NginxHTTPLocationZone' '404': - description: Location zone not found (*LocationZoneNotFound*) + description: | + Location zone not found (*LocationZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -394,7 +452,9 @@ paths: '204': description: Success '404': - description: Location zone not found (*LocationZoneNotFound*) + description: | + Location zone not found (*LocationZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -425,6 +485,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPCachesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/http/caches/{httpCacheZoneName}': parameters: - name: httpCacheZoneName @@ -452,7 +516,9 @@ paths: schema: $ref: '#/definitions/NginxHTTPCache' '404': - description: Cache not found (*CacheNotFound*) + description: | + Cache not found (*CacheNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -466,7 +532,9 @@ paths: '204': description: Success '404': - description: Cache not found (*CacheNotFound*) + description: | + Cache not found (*CacheNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -496,6 +564,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPLimitConnZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/http/limit_conns/{httpLimitConnZoneName}': parameters: - name: httpLimitConnZoneName @@ -527,7 +599,9 @@ paths: schema: $ref: '#/definitions/NginxHTTPLimitConnZone' '404': - description: limit_conn not found (*LimitConnNotFound*) + description: | + limit_conn not found (*LimitConnNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -541,7 +615,9 @@ paths: '204': description: Success '404': - description: limit_conn not found (*LimitConnNotFound*) + description: | + limit_conn not found (*LimitConnNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -571,6 +647,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPLimitReqZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/http/limit_reqs/{httpLimitReqZoneName}': parameters: - name: httpLimitReqZoneName @@ -602,7 +682,9 @@ paths: schema: $ref: '#/definitions/NginxHTTPLimitReqZone' '404': - description: limit_req not found (*LimitReqNotFound*) + description: | + limit_req not found (*LimitReqNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -616,7 +698,9 @@ paths: '204': description: Success '404': - description: limit_req not found (*LimitReqNotFound*) + description: | + limit_req not found (*LimitReqNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -646,6 +730,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPUpstreamMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/http/upstreams/{httpUpstreamName}/': parameters: - name: httpUpstreamName @@ -678,7 +766,9 @@ paths: schema: $ref: '#/definitions/NginxError' '404': - description: Upstream not found (*UpstreamNotFound*) + description: | + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' delete: @@ -699,7 +789,9 @@ paths: schema: $ref: '#/definitions/NginxError' '404': - description: Upstream not found (*UpstreamNotFound*) + description: | + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -733,7 +825,9 @@ paths: schema: $ref: '#/definitions/NginxError' '404': - description: Upstream not found (*UpstreamNotFound*) + description: | + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' post: @@ -785,7 +879,9 @@ paths: schema: $ref: '#/definitions/NginxError' '404': - description: Upstream not found (*UpstreamNotFound*) + description: | + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -831,8 +927,9 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*), - server with ID “**id**” does not exist (*UpstreamServerNotFound*) + Server with ID “**id**” does not exist (*UpstreamServerNotFound*), + unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' patch: @@ -884,8 +981,9 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*), - server with ID “**id**” does not exist (*UpstreamServerNotFound*) + Server with ID “**id**” does not exist (*UpstreamServerNotFound*), + unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -919,8 +1017,9 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*), - server with ID “**id**” does not exist (*UpstreamServerNotFound*) + Server with ID “**id**” does not exist (*UpstreamServerNotFound*), + unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -949,6 +1048,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxHTTPKeyvalZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/http/keyvals/{httpKeyvalZoneName}': parameters: - name: httpKeyvalZoneName @@ -979,7 +1082,8 @@ paths: '404': description: | Keyval not found (*KeyvalNotFound*), - keyval key not found (*KeyvalKeyNotFound*) + keyval key not found (*KeyvalKeyNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' post: @@ -1023,7 +1127,9 @@ paths: schema: $ref: '#/definitions/NginxError' '404': - description: Keyval not found (*KeyvalNotFound*) + description: | + Keyval not found (*KeyvalNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1085,7 +1191,8 @@ paths: '404': description: | Keyval not found (*KeyvalNotFound*), - keyval key not found (*KeyvalKeyNotFound*) + keyval key not found (*KeyvalKeyNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1116,7 +1223,9 @@ paths: '204': description: Success '404': - description: Keyval not found (*KeyvalNotFound*) + description: | + Keyval not found (*KeyvalNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1137,6 +1246,10 @@ paths: description: Success schema: $ref: '#/definitions/ArrayOfStrings' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' /stream/server_zones/: get: tags: @@ -1160,6 +1273,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxStreamServerZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/stream/server_zones/{streamServerZoneName}': parameters: - name: streamServerZoneName @@ -1188,7 +1305,8 @@ paths: $ref: '#/definitions/NginxStreamServerZone' '404': description: | - Server zone not found (*ServerZoneNotFound*) + Server zone not found (*ServerZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -1204,7 +1322,8 @@ paths: description: Success '404': description: | - Server zone not found (*ServerZoneNotFound*) + Server zone not found (*ServerZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1234,6 +1353,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxStreamLimitConnZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/stream/limit_conns/{streamLimitConnZoneName}': parameters: - name: streamLimitConnZoneName @@ -1265,7 +1388,9 @@ paths: schema: $ref: '#/definitions/NginxStreamLimitConnZone' '404': - description: limit_conn not found (*LimitConnNotFound*) + description: | + limit_conn not found (*LimitConnNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -1279,7 +1404,9 @@ paths: '204': description: Success '404': - description: limit_conn not found (*LimitConnNotFound*) + description: | + limit_conn not found (*LimitConnNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1309,6 +1436,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxStreamUpstreamMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/stream/upstreams/{streamUpstreamName}/': parameters: - name: streamUpstreamName @@ -1342,7 +1473,8 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*) + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' delete: @@ -1364,7 +1496,8 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*) + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -1399,7 +1532,8 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*) + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' post: @@ -1452,7 +1586,8 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*) + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -1498,7 +1633,8 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*), + Unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*), server with ID “**id**” does not exist (*UpstreamServerNotFound*) schema: $ref: '#/definitions/NginxError' @@ -1551,8 +1687,9 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*), - server with ID “**id**” does not exist (*UpstreamServerNotFound*) + Server with ID “**id**” does not exist (*UpstreamServerNotFound*), + unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -1586,8 +1723,9 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Upstream not found (*UpstreamNotFound*), - server with ID “**id**” does not exist (*UpstreamServerNotFound*) + Server with ID “**id**” does not exist (*UpstreamServerNotFound*), + unknown version (*UnknownVersion*), + upstream not found (*UpstreamNotFound*) schema: $ref: '#/definitions/NginxError' '405': @@ -1616,6 +1754,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxStreamKeyvalZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' '/stream/keyvals/{streamKeyvalZoneName}': parameters: - name: streamKeyvalZoneName @@ -1646,7 +1788,8 @@ paths: '404': description: | Keyval not found (*KeyvalNotFound*), - keyval key not found (*KeyvalKeyNotFound*) + keyval key not found (*KeyvalKeyNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' post: @@ -1691,7 +1834,8 @@ paths: $ref: '#/definitions/NginxError' '404': description: | - Keyval not found (*KeyvalNotFound*) + Keyval not found (*KeyvalNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1753,7 +1897,8 @@ paths: '404': description: | Keyval not found (*KeyvalNotFound*), - keyval key not found (*KeyvalKeyNotFound*) + keyval key not found (*KeyvalKeyNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1785,7 +1930,8 @@ paths: description: Success '404': description: | - Keyval not found (*KeyvalNotFound*) + Keyval not found (*KeyvalNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1807,6 +1953,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxStreamZoneSync' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' /resolvers/: get: tags: @@ -1823,6 +1973,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxResolverZonesMap' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' parameters: - in: query name: fields @@ -1858,7 +2012,8 @@ paths: $ref: '#/definitions/NginxResolverZone' '404': description: | - Resolver zone not found (*ResolverZoneNotFound*) + Resolver zone not found (*ResolverZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' delete: @@ -1872,7 +2027,9 @@ paths: '204': description: Success '404': - description: Resolver zone not found (*ResolverZoneNotFound*) + description: | + Resolver zone not found (*ResolverZoneNotFound*), + unknown version (*UnknownVersion*) schema: $ref: '#/definitions/NginxError' '405': @@ -1894,6 +2051,10 @@ paths: description: Success schema: $ref: '#/definitions/NginxSSLObject' + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' parameters: - in: query name: fields @@ -1909,6 +2070,10 @@ paths: responses: '204': description: Success + '404': + description: Unknown version (*UnknownVersion*) + schema: + $ref: '#/definitions/NginxError' ### ###DEFINITIONS ###