Changeset 2499:20dbb29cbe05 in nginx_org


Ignore:
Timestamp:
02/03/20 17:04:41 (2 weeks ago)
Author:
Yaroslav Zhuravlev <yar@…>
Branch:
default
Phase:
public
Message:

Documented the "Unknown version" error in the API.

Files:
2 edited

Legend:

Unmodified
Added
Removed
  • xml/en/docs/http/ngx_http_api_module.xml

    r2494 r2499  
    285285<list type="bullet">
    286286<listitem>200 - Success, returns an array of strings</listitem>
     287<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    287288</list>
    288289</listitem>
     
    312313<list type="bullet">
    313314<listitem>200 - Success, returns <link id="def_nginx_object">nginx</link></listitem>
     315<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    314316</list>
    315317</listitem>
     
    330332<list type="bullet">
    331333<listitem>200 - Success, returns <link id="def_nginx_processes">Processes</link></listitem>
     334<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    332335</list>
    333336</listitem>
     
    340343<list type="bullet">
    341344<listitem>204 - Success</listitem>
     345<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    342346</list>
    343347</listitem>
     
    367371<list type="bullet">
    368372<listitem>200 - Success, returns <link id="def_nginx_connections">Connections</link></listitem>
     373<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    369374</list>
    370375</listitem>
     
    377382<list type="bullet">
    378383<listitem>204 - Success</listitem>
     384<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    379385</list>
    380386</listitem>
     
    404410<list type="bullet">
    405411<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>
     412<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    406413</list>
    407414</listitem>
     
    438445<list type="bullet">
    439446<listitem>200 - Success, returns <link id="def_nginx_slab_zone">Shared memory zone with slab allocator</link></listitem>
    440 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     447<listitem>404 - Slab not found (<literal>SlabNotFound</literal>),
     448unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    441449</list>
    442450</listitem>
     
    449457<list type="bullet">
    450458<listitem>204 - Success</listitem>
    451 <listitem>404 - Slab not found (<literal>SlabNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     459<listitem>404 - Slab not found (<literal>SlabNotFound</literal>),
     460unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    452461<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    453462</list>
     
    469478<list type="bullet">
    470479<listitem>200 - Success, returns an array of strings</listitem>
     480<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    471481</list>
    472482</listitem>
     
    496506<list type="bullet">
    497507<listitem>200 - Success, returns <link id="def_nginx_http_requests">HTTP Requests</link></listitem>
     508<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    498509</list>
    499510</listitem>
     
    506517<list type="bullet">
    507518<listitem>204 - Success</listitem>
     519<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    508520<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    509521</list>
     
    534546<list type="bullet">
    535547<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>
     548<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    536549</list>
    537550</listitem>
     
    568581<list type="bullet">
    569582<listitem>200 - Success, returns <link id="def_nginx_http_server_zone">HTTP Server Zone</link></listitem>
    570 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     583<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
     584unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    571585</list>
    572586</listitem>
     
    579593<list type="bullet">
    580594<listitem>204 - Success</listitem>
    581 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     595<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
     596unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    582597<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    583598</list>
     
    608623<list type="bullet">
    609624<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>
     625<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    610626</list>
    611627</listitem>
     
    642658<list type="bullet">
    643659<listitem>200 - Success, returns <link id="def_nginx_http_location_zone">HTTP Location Zone</link></listitem>
    644 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     660<listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>),
     661unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    645662</list>
    646663</listitem>
     
    653670<list type="bullet">
    654671<listitem>204 - Success</listitem>
    655 <listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     672<listitem>404 - Location zone not found (<literal>LocationZoneNotFound</literal>),
     673unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    656674<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    657675</list>
     
    682700<list type="bullet">
    683701<listitem>200 - Success, returns a collection of "<link id="def_nginx_http_cache">HTTP Cache</link>" objects for all HTTP caches</listitem>
     702<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    684703</list>
    685704</listitem>
     
    716735<list type="bullet">
    717736<listitem>200 - Success, returns <link id="def_nginx_http_cache">HTTP Cache</link></listitem>
    718 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     737<listitem>404 - Cache not found (<literal>CacheNotFound</literal>),
     738unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    719739</list>
    720740</listitem>
     
    727747<list type="bullet">
    728748<listitem>204 - Success</listitem>
    729 <listitem>404 - Cache not found (<literal>CacheNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     749<listitem>404 - Cache not found (<literal>CacheNotFound</literal>),
     750unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    730751<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    731752</list>
     
    756777<list type="bullet">
    757778<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>
     779<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    758780</list>
    759781</listitem>
     
    790812<list type="bullet">
    791813<listitem>200 - Success, returns <link id="def_nginx_http_limit_conn_zone">HTTP Connections Limiting</link></listitem>
    792 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     814<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
     815unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    793816</list>
    794817</listitem>
     
    801824<list type="bullet">
    802825<listitem>204 - Success</listitem>
    803 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     826<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
     827unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    804828<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    805829</list>
     
    830854<list type="bullet">
    831855<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>
     856<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    832857</list>
    833858</listitem>
     
    864889<list type="bullet">
    865890<listitem>200 - Success, returns <link id="def_nginx_http_limit_req_zone">HTTP Requests Rate Limiting</link></listitem>
    866 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     891<listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>),
     892unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    867893</list>
    868894</listitem>
     
    875901<list type="bullet">
    876902<listitem>204 - Success</listitem>
    877 <listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     903<listitem>404 - limit_req not found (<literal>LimitReqNotFound</literal>),
     904unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    878905<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    879906</list>
     
    904931<list type="bullet">
    905932<listitem>200 - Success, returns a collection of "<link id="def_nginx_http_upstream">HTTP Upstream</link>" objects for all HTTP upstreams</listitem>
     933<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    906934</list>
    907935</listitem>
     
    939967<listitem>200 - Success, returns <link id="def_nginx_http_upstream">HTTP Upstream</link></listitem>
    940968<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    941 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     969<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     970upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    942971</list>
    943972</listitem>
     
    951980<listitem>204 - Success</listitem>
    952981<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    953 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     982<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     983upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    954984<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    955985</list>
     
    9791009<listitem>200 - Success, returns an array of <link id="def_nginx_http_upstream_conf_server">HTTP Upstream Servers</link></listitem>
    9801010<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    981 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1011<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     1012upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    9821013</list>
    9831014</listitem>
     
    10181049upstream “<value>name</value>” has no backup (<literal>UpstreamNoBackup</literal>),
    10191050upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1020 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1051<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     1052upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    10211053<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    10221054<listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     
    10521084<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
    10531085invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1054 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
    1055 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1086<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
     1087unknown version (<literal>UnknownVersion</literal>),
     1088upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    10561089</list>
    10571090</listitem>
     
    10911124server “<literal>ID</literal>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>),
    10921125upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1093 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
    1094 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1126<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
     1127unknown version (<literal>UnknownVersion</literal>),
     1128upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    10951129<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    10961130<listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     
    11081142invalid server ID (<literal>UpstreamBadServerId</literal>),
    11091143server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1110 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
    1111 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1144<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
     1145unknown version (<literal>UnknownVersion</literal>),
     1146upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    11121147<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    11131148</list>
     
    11381173<list type="bullet">
    11391174<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>
     1175<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    11401176</list>
    11411177</listitem>
     
    11731209<listitem>200 - Success, returns <link id="def_nginx_http_keyval_zone">HTTP Keyval Shared Memory Zone</link></listitem>
    11741210<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
    1175 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1211keyval key not found (<literal>KeyvalKeyNotFound</literal>),
     1212unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    11761213</list>
    11771214</listitem>
     
    11991236only one key can be added (<literal>KeyvalFormatError</literal>),
    12001237reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1201 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1238<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
     1239unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12021240<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12031241<listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     
    12291267reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12301268<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
    1231 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1269keyval key not found (<literal>KeyvalKeyNotFound</literal>),
     1270unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12321271<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12331272<listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
     
    12431282<list type="bullet">
    12441283<listitem>204 - Success</listitem>
    1245 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1284<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
     1285unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12461286<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12471287</list>
     
    12631303<list type="bullet">
    12641304<listitem>200 - Success, returns an array of strings</listitem>
     1305<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12651306</list>
    12661307</listitem>
     
    12901331<list type="bullet">
    12911332<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>
     1333<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    12921334</list>
    12931335</listitem>
     
    13241366<list type="bullet">
    13251367<listitem>200 - Success, returns <link id="def_nginx_stream_server_zone">Stream Server Zone</link></listitem>
    1326 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1368<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
     1369unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    13271370</list>
    13281371</listitem>
     
    13351378<list type="bullet">
    13361379<listitem>204 - Success</listitem>
    1337 <listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1380<listitem>404 - Server zone not found (<literal>ServerZoneNotFound</literal>),
     1381unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    13381382<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    13391383</list>
     
    13641408<list type="bullet">
    13651409<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>
     1410<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    13661411</list>
    13671412</listitem>
     
    13981443<list type="bullet">
    13991444<listitem>200 - Success, returns <link id="def_nginx_stream_limit_conn_zone">Stream Connections Limiting</link></listitem>
    1400 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1445<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
     1446unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    14011447</list>
    14021448</listitem>
     
    14091455<list type="bullet">
    14101456<listitem>204 - Success</listitem>
    1411 <listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1457<listitem>404 - limit_conn not found (<literal>LimitConnNotFound</literal>),
     1458unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    14121459<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    14131460</list>
     
    14381485<list type="bullet">
    14391486<listitem>200 - Success, returns a collection of "<link id="def_nginx_stream_upstream">Stream Upstream</link>" objects for all stream upstreams</listitem>
     1487<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    14401488</list>
    14411489</listitem>
     
    14731521<listitem>200 - Success, returns <link id="def_nginx_stream_upstream">Stream Upstream</link></listitem>
    14741522<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1475 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1523<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     1524upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    14761525</list>
    14771526</listitem>
     
    14851534<listitem>204 - Success</listitem>
    14861535<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1487 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1536<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     1537upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    14881538<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    14891539</list>
     
    15131563<listitem>200 - Success, returns an array of <link id="def_nginx_stream_upstream_conf_server">Stream Upstream Servers</link></listitem>
    15141564<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1515 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1565<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     1566upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    15161567</list>
    15171568</listitem>
     
    15521603upstream “<value>name</value>” memory exhausted (<literal>UpstreamOutOfMemory</literal>),
    15531604reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1554 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1605<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     1606upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    15551607<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    15561608<listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     
    15861638<listitem>400 - Upstream is static (<literal>UpstreamStatic</literal>),
    15871639invalid server ID (<literal>UpstreamBadServerId</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1588 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
     1640<listitem>404 - Unknown version (<literal>UnknownVersion</literal>),
     1641upstream not found (<literal>UpstreamNotFound</literal>),
    15891642server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    15901643</list>
     
    16251678server “<value>ID</value>” weight is immutable (<literal>UpstreamServerWeightImmutable</literal>),
    16261679upstream “<literal>name</literal>” memory exhausted (<literal>UpstreamOutOfMemory</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1627 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
    1628 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1680<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
     1681unknown version (<literal>UnknownVersion</literal>),
     1682upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    16291683<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    16301684<listitem>415 - JSON error (<literal>JsonError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     
    16421696invalid server ID (<literal>UpstreamBadServerId</literal>),
    16431697server “<value>id</value>” not removable (<literal>UpstreamServerImmutable</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1644 <listitem>404 - Upstream not found (<literal>UpstreamNotFound</literal>),
    1645 server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1698<listitem>404 - Server with ID “<value>id</value>” does not exist (<literal>UpstreamServerNotFound</literal>),
     1699unknown version (<literal>UnknownVersion</literal>),
     1700upstream not found (<literal>UpstreamNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    16461701<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    16471702</list>
     
    16721727<list type="bullet">
    16731728<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>
     1729<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    16741730</list>
    16751731</listitem>
     
    17071763<listitem>200 - Success, returns <link id="def_nginx_stream_keyval_zone">Stream Keyval Shared Memory Zone</link></listitem>
    17081764<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
    1709 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1765keyval key not found (<literal>KeyvalKeyNotFound</literal>),
     1766unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17101767</list>
    17111768</listitem>
     
    17331790only one key can be added (<literal>KeyvalFormatError</literal>),
    17341791reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    1735 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1792<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
     1793unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17361794<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17371795<listitem>409 - Key already exists (<literal>KeyvalKeyExists</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     
    17631821reading request body failed <literal>BodyReadError</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17641822<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
    1765 keyval key not found (<literal>KeyvalKeyNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1823keyval key not found (<literal>KeyvalKeyNotFound</literal>),
     1824unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17661825<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17671826<listitem>413 - Request Entity Too Large, returns <link id="def_nginx_error">Error</link></listitem>
     
    17771836<list type="bullet">
    17781837<listitem>204 - Success</listitem>
    1779 <listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1838<listitem>404 - Keyval not found (<literal>KeyvalNotFound</literal>),
     1839unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17801840<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17811841</list>
     
    17971857<list type="bullet">
    17981858<listitem>200 - Success, returns <link id="def_nginx_stream_zone_sync">Stream Zone Sync Node</link></listitem>
     1859<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    17991860</list>
    18001861</listitem>
     
    18241885<list type="bullet">
    18251886<listitem>200 - Success, returns a collection of "<link id="def_nginx_resolver_zone">Resolver Zone</link>" objects for all resolvers</listitem>
     1887<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    18261888</list>
    18271889</listitem>
     
    18581920<list type="bullet">
    18591921<listitem>200 - Success, returns <link id="def_nginx_resolver_zone">Resolver Zone</link></listitem>
    1860 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1922<listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>),
     1923unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    18611924</list>
    18621925</listitem>
     
    18691932<list type="bullet">
    18701933<listitem>204 - Success</listitem>
    1871 <listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>), returns <link id="def_nginx_error">Error</link></listitem>
     1934<listitem>404 - Resolver zone not found (<literal>ResolverZoneNotFound</literal>),
     1935unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    18721936<listitem>405 - Method disabled (<literal>MethodDisabled</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    18731937</list>
     
    18981962<list type="bullet">
    18991963<listitem>200 - Success, returns <link id="def_nginx_ssl_object">SSL</link></listitem>
     1964<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    19001965</list>
    19011966</listitem>
     
    19081973<list type="bullet">
    19091974<listitem>204 - Success</listitem>
     1975<listitem>404 - Unknown version (<literal>UnknownVersion</literal>), returns <link id="def_nginx_error">Error</link></listitem>
    19101976</list>
    19111977</listitem>
  • yaml/nginx_api.yaml

    r2494 r2499  
    5555          schema:
    5656            $ref: '#/definitions/ArrayOfStrings'
     57        '404':
     58          description: Unknown version (*UnknownVersion*)
     59          schema:
     60            $ref: '#/definitions/NginxError'
    5761  /nginx:
    5862    get:
     
    7680          schema:
    7781            $ref: '#/definitions/NginxObject'
     82        '404':
     83          description: Unknown version (*UnknownVersion*)
     84          schema:
     85            $ref: '#/definitions/NginxError'
    7886  /processes:
    7987    get:
     
    92100          schema:
    93101            $ref: '#/definitions/NginxProcesses'
     102        '404':
     103          description: Unknown version (*UnknownVersion*)
     104          schema:
     105            $ref: '#/definitions/NginxError'
    94106    delete:
    95107      tags:
     
    103115        '204':
    104116          description: Success
     117        '404':
     118          description: Unknown version (*UnknownVersion*)
     119          schema:
     120            $ref: '#/definitions/NginxError'
    105121  /connections:
    106122    get:
     
    118134          schema:
    119135            $ref: '#/definitions/NginxConnections'
     136        '404':
     137          description: Unknown version (*UnknownVersion*)
     138          schema:
     139            $ref: '#/definitions/NginxError'
    120140      parameters:
    121141        - in: query
     
    134154        '204':
    135155          description: Success
     156        '404':
     157          description: Unknown version (*UnknownVersion*)
     158          schema:
     159            $ref: '#/definitions/NginxError'
    136160  /slabs/:
    137161    get:
     
    157181          schema:
    158182            $ref: '#/definitions/NginxSlabZoneMap'
     183        '404':
     184          description: Unknown version (*UnknownVersion*)
     185          schema:
     186            $ref: '#/definitions/NginxError'
    159187  '/slabs/{slabZoneName}':
    160188    parameters:
     
    185213            $ref: '#/definitions/NginxSlabZone'
    186214        '404':
    187           description: Slab not found (*SlabNotFound*)
     215          description: |
     216            Slab not found (*SlabNotFound*),
     217            unknown version (*UnknownVersion*)
    188218          schema:
    189219            $ref: '#/definitions/NginxError'
     
    200230          description: Success
    201231        '404':
    202           description: Slab not found (*SlabNotFound*)
     232          description: |
     233            Slab not found (*SlabNotFound*),
     234            unknown version (*UnknownVersion*)
    203235          schema:
    204236            $ref: '#/definitions/NginxError'
     
    222254          schema:
    223255            $ref: '#/definitions/ArrayOfStrings'
     256        '404':
     257          description: Unknown version (*UnknownVersion*)
     258          schema:
     259            $ref: '#/definitions/NginxError'
    224260  /http/requests:
    225261    get:
     
    243279          schema:
    244280            $ref: '#/definitions/NginxHTTPRequests'
     281        '404':
     282          description: Unknown version (*UnknownVersion*)
     283          schema:
     284            $ref: '#/definitions/NginxError'
    245285    delete:
    246286      tags:
     
    253293        '204':
    254294          description: Success
     295        '404':
     296          description: Unknown version (*UnknownVersion*)
     297          schema:
     298            $ref: '#/definitions/NginxError'
    255299        '405':
    256300          description: Method disabled (*MethodDisabled*)
     
    280324          schema:
    281325            $ref: '#/definitions/NginxHTTPServerZonesMap'
     326        '404':
     327          description: Unknown version (*UnknownVersion*)
     328          schema:
     329            $ref: '#/definitions/NginxError'
    282330  '/http/server_zones/{httpServerZoneName}':
    283331    parameters:
     
    307355            $ref: '#/definitions/NginxHTTPServerZone'
    308356        '404':
    309           description: Server zone not found (*ServerZoneNotFound*)
     357          description: |
     358            Server zone not found (*ServerZoneNotFound*),
     359            unknown version (*UnknownVersion*)
    310360          schema:
    311361            $ref: '#/definitions/NginxError'
     
    322372          description: Success
    323373        '404':
    324           description: Server zone not found (*ServerZoneNotFound*)
     374          description: |
     375            Server zone not found (*ServerZoneNotFound*),
     376            unknown version (*UnknownVersion*)
    325377          schema:
    326378            $ref: '#/definitions/NginxError'
     
    352404          schema:
    353405            $ref: '#/definitions/NginxHTTPLocationZonesMap'
     406        '404':
     407          description: Unknown version (*UnknownVersion*)
     408          schema:
     409            $ref: '#/definitions/NginxError'
    354410  '/http/location_zones/{httpLocationZoneName}':
    355411    parameters:
     
    380436            $ref: '#/definitions/NginxHTTPLocationZone'
    381437        '404':
    382           description: Location zone not found (*LocationZoneNotFound*)
     438          description: |
     439            Location zone not found (*LocationZoneNotFound*),
     440            unknown version (*UnknownVersion*)
    383441          schema:
    384442            $ref: '#/definitions/NginxError'
     
    395453          description: Success
    396454        '404':
    397           description: Location zone not found (*LocationZoneNotFound*)
     455          description: |
     456            Location zone not found (*LocationZoneNotFound*),
     457            unknown version (*UnknownVersion*)
    398458          schema:
    399459            $ref: '#/definitions/NginxError'
     
    426486          schema:
    427487            $ref: '#/definitions/NginxHTTPCachesMap'
     488        '404':
     489          description: Unknown version (*UnknownVersion*)
     490          schema:
     491            $ref: '#/definitions/NginxError'
    428492  '/http/caches/{httpCacheZoneName}':
    429493    parameters:
     
    453517            $ref: '#/definitions/NginxHTTPCache'
    454518        '404':
    455           description: Cache not found (*CacheNotFound*)
     519          description: |
     520            Cache not found (*CacheNotFound*),
     521            unknown version (*UnknownVersion*)
    456522          schema:
    457523            $ref: '#/definitions/NginxError'
     
    467533          description: Success
    468534        '404':
    469           description: Cache not found (*CacheNotFound*)
     535          description: |
     536            Cache not found (*CacheNotFound*),
     537            unknown version (*UnknownVersion*)
    470538          schema:
    471539            $ref: '#/definitions/NginxError'
     
    497565          schema:
    498566            $ref: '#/definitions/NginxHTTPLimitConnZonesMap'
     567        '404':
     568          description: Unknown version (*UnknownVersion*)
     569          schema:
     570            $ref: '#/definitions/NginxError'
    499571  '/http/limit_conns/{httpLimitConnZoneName}':
    500572    parameters:
     
    528600            $ref: '#/definitions/NginxHTTPLimitConnZone'
    529601        '404':
    530           description: limit_conn not found (*LimitConnNotFound*)
     602          description: |
     603            limit_conn not found (*LimitConnNotFound*),
     604            unknown version (*UnknownVersion*)
    531605          schema:
    532606            $ref: '#/definitions/NginxError'
     
    542616          description: Success
    543617        '404':
    544           description: limit_conn not found (*LimitConnNotFound*)
     618          description: |
     619            limit_conn not found (*LimitConnNotFound*),
     620            unknown version (*UnknownVersion*)
    545621          schema:
    546622            $ref: '#/definitions/NginxError'
     
    572648          schema:
    573649            $ref: '#/definitions/NginxHTTPLimitReqZonesMap'
     650        '404':
     651          description: Unknown version (*UnknownVersion*)
     652          schema:
     653            $ref: '#/definitions/NginxError'
    574654  '/http/limit_reqs/{httpLimitReqZoneName}':
    575655    parameters:
     
    603683            $ref: '#/definitions/NginxHTTPLimitReqZone'
    604684        '404':
    605           description: limit_req not found (*LimitReqNotFound*)
     685          description: |
     686            limit_req not found (*LimitReqNotFound*),
     687            unknown version (*UnknownVersion*)
    606688          schema:
    607689            $ref: '#/definitions/NginxError'
     
    617699          description: Success
    618700        '404':
    619           description: limit_req not found (*LimitReqNotFound*)
     701          description: |
     702            limit_req not found (*LimitReqNotFound*),
     703            unknown version (*UnknownVersion*)
    620704          schema:
    621705            $ref: '#/definitions/NginxError'
     
    647731          schema:
    648732            $ref: '#/definitions/NginxHTTPUpstreamMap'
     733        '404':
     734          description: Unknown version (*UnknownVersion*)
     735          schema:
     736            $ref: '#/definitions/NginxError'
    649737  '/http/upstreams/{httpUpstreamName}/':
    650738    parameters:
     
    679767            $ref: '#/definitions/NginxError'
    680768        '404':
    681           description: Upstream not found (*UpstreamNotFound*)
     769          description: |
     770            Unknown version (*UnknownVersion*),
     771            upstream not found (*UpstreamNotFound*)
    682772          schema:
    683773            $ref: '#/definitions/NginxError'
     
    700790            $ref: '#/definitions/NginxError'
    701791        '404':
    702           description: Upstream not found (*UpstreamNotFound*)
     792          description: |
     793            Unknown version (*UnknownVersion*),
     794            upstream not found (*UpstreamNotFound*)
    703795          schema:
    704796            $ref: '#/definitions/NginxError'
     
    734826            $ref: '#/definitions/NginxError'
    735827        '404':
    736           description: Upstream not found (*UpstreamNotFound*)
     828          description: |
     829            Unknown version (*UnknownVersion*),
     830            upstream not found (*UpstreamNotFound*)
    737831          schema:
    738832            $ref: '#/definitions/NginxError'
     
    786880            $ref: '#/definitions/NginxError'
    787881        '404':
    788           description: Upstream not found (*UpstreamNotFound*)
     882          description: |
     883            Unknown version (*UnknownVersion*),
     884            upstream not found (*UpstreamNotFound*)
    789885          schema:
    790886            $ref: '#/definitions/NginxError'
     
    832928        '404':
    833929          description: |
    834             Upstream not found (*UpstreamNotFound*),
    835             server with ID “**id**” does not exist (*UpstreamServerNotFound*)
     930            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
     931            unknown version (*UnknownVersion*),
     932            upstream not found (*UpstreamNotFound*)
    836933          schema:
    837934            $ref: '#/definitions/NginxError'
     
    885982        '404':
    886983          description: |
    887             Upstream not found (*UpstreamNotFound*),
    888             server with ID “**id**” does not exist (*UpstreamServerNotFound*)
     984            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
     985            unknown version (*UnknownVersion*),
     986            upstream not found (*UpstreamNotFound*)
    889987          schema:
    890988            $ref: '#/definitions/NginxError'
     
    9201018        '404':
    9211019          description: |
    922             Upstream not found (*UpstreamNotFound*),
    923             server with ID “**id**” does not exist (*UpstreamServerNotFound*)
     1020            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
     1021            unknown version (*UnknownVersion*),
     1022            upstream not found (*UpstreamNotFound*)
    9241023          schema:
    9251024            $ref: '#/definitions/NginxError'
     
    9501049          schema:
    9511050            $ref: '#/definitions/NginxHTTPKeyvalZonesMap'
     1051        '404':
     1052          description: Unknown version (*UnknownVersion*)
     1053          schema:
     1054            $ref: '#/definitions/NginxError'
    9521055  '/http/keyvals/{httpKeyvalZoneName}':
    9531056    parameters:
     
    9801083          description: |
    9811084            Keyval not found (*KeyvalNotFound*),
    982             keyval key not found (*KeyvalKeyNotFound*)
     1085            keyval key not found (*KeyvalKeyNotFound*),
     1086            unknown version (*UnknownVersion*)
    9831087          schema:
    9841088            $ref: '#/definitions/NginxError'
     
    10241128            $ref: '#/definitions/NginxError'
    10251129        '404':
    1026           description: Keyval not found (*KeyvalNotFound*)
     1130          description: |
     1131            Keyval not found (*KeyvalNotFound*),
     1132            unknown version (*UnknownVersion*)
    10271133          schema:
    10281134            $ref: '#/definitions/NginxError'
     
    10861192          description: |
    10871193            Keyval not found (*KeyvalNotFound*),
    1088             keyval key not found (*KeyvalKeyNotFound*)
     1194            keyval key not found (*KeyvalKeyNotFound*),
     1195            unknown version (*UnknownVersion*)
    10891196          schema:
    10901197            $ref: '#/definitions/NginxError'
     
    11171224          description: Success
    11181225        '404':
    1119           description: Keyval not found (*KeyvalNotFound*)
     1226          description: |
     1227            Keyval not found (*KeyvalNotFound*),
     1228            unknown version (*UnknownVersion*)
    11201229          schema:
    11211230            $ref: '#/definitions/NginxError'
     
    11381247          schema:
    11391248            $ref: '#/definitions/ArrayOfStrings'
     1249        '404':
     1250          description: Unknown version (*UnknownVersion*)
     1251          schema:
     1252            $ref: '#/definitions/NginxError'
    11401253  /stream/server_zones/:
    11411254    get:
     
    11611274          schema:
    11621275            $ref: '#/definitions/NginxStreamServerZonesMap'
     1276        '404':
     1277          description: Unknown version (*UnknownVersion*)
     1278          schema:
     1279            $ref: '#/definitions/NginxError'
    11631280  '/stream/server_zones/{streamServerZoneName}':
    11641281    parameters:
     
    11891306        '404':
    11901307          description: |
    1191             Server zone not found (*ServerZoneNotFound*)
     1308            Server zone not found (*ServerZoneNotFound*),
     1309            unknown version (*UnknownVersion*)
    11921310          schema:
    11931311            $ref: '#/definitions/NginxError'
     
    12051323        '404':
    12061324          description: |
    1207             Server zone not found (*ServerZoneNotFound*)
     1325            Server zone not found (*ServerZoneNotFound*),
     1326            unknown version (*UnknownVersion*)
    12081327          schema:
    12091328            $ref: '#/definitions/NginxError'
     
    12351354          schema:
    12361355            $ref: '#/definitions/NginxStreamLimitConnZonesMap'
     1356        '404':
     1357          description: Unknown version (*UnknownVersion*)
     1358          schema:
     1359            $ref: '#/definitions/NginxError'
    12371360  '/stream/limit_conns/{streamLimitConnZoneName}':
    12381361    parameters:
     
    12661389            $ref: '#/definitions/NginxStreamLimitConnZone'
    12671390        '404':
    1268           description: limit_conn not found (*LimitConnNotFound*)
     1391          description: |
     1392            limit_conn not found (*LimitConnNotFound*),
     1393            unknown version (*UnknownVersion*)
    12691394          schema:
    12701395            $ref: '#/definitions/NginxError'
     
    12801405          description: Success
    12811406        '404':
    1282           description: limit_conn not found (*LimitConnNotFound*)
     1407          description: |
     1408            limit_conn not found (*LimitConnNotFound*),
     1409            unknown version (*UnknownVersion*)
    12831410          schema:
    12841411            $ref: '#/definitions/NginxError'
     
    13101437          schema:
    13111438            $ref: '#/definitions/NginxStreamUpstreamMap'
     1439        '404':
     1440          description: Unknown version (*UnknownVersion*)
     1441          schema:
     1442            $ref: '#/definitions/NginxError'
    13121443  '/stream/upstreams/{streamUpstreamName}/':
    13131444    parameters:
     
    13431474        '404':
    13441475          description: |
    1345             Upstream not found (*UpstreamNotFound*)
     1476            Unknown version (*UnknownVersion*),
     1477            upstream not found (*UpstreamNotFound*)
    13461478          schema:
    13471479            $ref: '#/definitions/NginxError'
     
    13651497        '404':
    13661498          description: |
    1367             Upstream not found (*UpstreamNotFound*)
     1499            Unknown version (*UnknownVersion*),
     1500            upstream not found (*UpstreamNotFound*)
    13681501          schema:
    13691502            $ref: '#/definitions/NginxError'
     
    14001533        '404':
    14011534          description: |
    1402             Upstream not found (*UpstreamNotFound*)
     1535            Unknown version (*UnknownVersion*),
     1536            upstream not found (*UpstreamNotFound*)
    14031537          schema:
    14041538            $ref: '#/definitions/NginxError'
     
    14531587        '404':
    14541588          description: |
    1455             Upstream not found (*UpstreamNotFound*)
     1589            Unknown version (*UnknownVersion*),
     1590            upstream not found (*UpstreamNotFound*)
    14561591          schema:
    14571592            $ref: '#/definitions/NginxError'
     
    14991634        '404':
    15001635          description: |
    1501             Upstream not found (*UpstreamNotFound*),
     1636            Unknown version (*UnknownVersion*),
     1637            upstream not found (*UpstreamNotFound*),
    15021638            server with ID “**id**” does not exist (*UpstreamServerNotFound*)
    15031639          schema:
     
    15521688        '404':
    15531689          description: |
    1554             Upstream not found (*UpstreamNotFound*),
    1555             server with ID “**id**” does not exist (*UpstreamServerNotFound*)
     1690            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
     1691            unknown version (*UnknownVersion*),
     1692            upstream not found (*UpstreamNotFound*)
    15561693          schema:
    15571694            $ref: '#/definitions/NginxError'
     
    15871724        '404':
    15881725          description: |
    1589             Upstream not found (*UpstreamNotFound*),
    1590             server with ID “**id**” does not exist (*UpstreamServerNotFound*)
     1726            Server with ID “**id**” does not exist (*UpstreamServerNotFound*),
     1727            unknown version (*UnknownVersion*),
     1728            upstream not found (*UpstreamNotFound*)
    15911729          schema:
    15921730            $ref: '#/definitions/NginxError'
     
    16171755          schema:
    16181756            $ref: '#/definitions/NginxStreamKeyvalZonesMap'
     1757        '404':
     1758          description: Unknown version (*UnknownVersion*)
     1759          schema:
     1760            $ref: '#/definitions/NginxError'
    16191761  '/stream/keyvals/{streamKeyvalZoneName}':
    16201762    parameters:
     
    16471789          description: |
    16481790            Keyval not found (*KeyvalNotFound*),
    1649             keyval key not found (*KeyvalKeyNotFound*)
     1791            keyval key not found (*KeyvalKeyNotFound*),
     1792            unknown version (*UnknownVersion*)
    16501793          schema:
    16511794            $ref: '#/definitions/NginxError'
     
    16921835        '404':
    16931836          description: |
    1694             Keyval not found (*KeyvalNotFound*)
     1837            Keyval not found (*KeyvalNotFound*),
     1838            unknown version (*UnknownVersion*)
    16951839          schema:
    16961840            $ref: '#/definitions/NginxError'
     
    17541898          description: |
    17551899            Keyval not found (*KeyvalNotFound*),
    1756             keyval key not found (*KeyvalKeyNotFound*)
     1900            keyval key not found (*KeyvalKeyNotFound*),
     1901            unknown version (*UnknownVersion*)
    17571902          schema:
    17581903            $ref: '#/definitions/NginxError'
     
    17861931        '404':
    17871932          description: |
    1788             Keyval not found (*KeyvalNotFound*)
     1933            Keyval not found (*KeyvalNotFound*),
     1934            unknown version (*UnknownVersion*)
    17891935          schema:
    17901936            $ref: '#/definitions/NginxError'
     
    18081954          schema:
    18091955            $ref: '#/definitions/NginxStreamZoneSync'
     1956        '404':
     1957          description: Unknown version (*UnknownVersion*)
     1958          schema:
     1959            $ref: '#/definitions/NginxError'
    18101960  /resolvers/:
    18111961    get:
     
    18241974          schema:
    18251975            $ref: '#/definitions/NginxResolverZonesMap'
     1976        '404':
     1977          description: Unknown version (*UnknownVersion*)
     1978          schema:
     1979            $ref: '#/definitions/NginxError'
    18261980      parameters:
    18271981        - in: query
     
    18592013        '404':
    18602014          description: |
    1861             Resolver zone not found (*ResolverZoneNotFound*)
     2015            Resolver zone not found (*ResolverZoneNotFound*),
     2016            unknown version (*UnknownVersion*)
    18622017          schema:
    18632018            $ref: '#/definitions/NginxError'
     
    18732028          description: Success
    18742029        '404':
    1875           description: Resolver zone not found (*ResolverZoneNotFound*)
     2030          description: |
     2031            Resolver zone not found (*ResolverZoneNotFound*),
     2032            unknown version (*UnknownVersion*)
    18762033          schema:
    18772034            $ref: '#/definitions/NginxError'
     
    18952052          schema:
    18962053            $ref: '#/definitions/NginxSSLObject'
     2054        '404':
     2055          description: Unknown version (*UnknownVersion*)
     2056          schema:
     2057            $ref: '#/definitions/NginxError'
    18972058      parameters:
    18982059        - in: query
     
    19102071        '204':
    19112072          description: Success
     2073        '404':
     2074          description: Unknown version (*UnknownVersion*)
     2075          schema:
     2076            $ref: '#/definitions/NginxError'
    19122077###
    19132078###DEFINITIONS
Note: See TracChangeset for help on using the changeset viewer.