APIs which are being Obsoleted and return 410 like nova-net
only APIs, have been moved to "Obsolete API" section in api-ref.
In favour of moving them in "Obsolete API" section, "DEPRECATED"
tag on those API ref can be removed to avoid confusion whether
these APIs are deprecated or gone.
Part of blueprint remove-nova-network
ref- https://review.openstack.org/#/c/567682/1/api-ref/source/os-fping.inc@4
Change-Id: I47eaf08a9c06e33d707fdfe88f6771e165f377b5
This drops support for the os-fixed-ips compute REST API which has been
deprecated since
Newton: I1a8a44530be29292561e90d6f7bd7ed512a88ee3
Now it returns 410 response. Unit tests are removed and the functional API
sample test is just asserting the 410 response now. The API sample docs are
left intact since the API reference still builds from those and can be
considered more or less branchless, so people looking at the API reference
can apply it to older deployments of nova before os-fixed-ips was removed.
Part of blueprint remove-nova-network
Change-Id: I61f758ff9285448d431b45f67c70286082b4ee90
make it follow other descriptions, use start from to make
it clear 2.36 is the first microversion deprecate those proxy
Implements: blueprint api-ref-in-rst-ocata
Change-Id: Iadf4bb6fa8e4a959a734f354206e2e1f4739e367
v2.4 added 'reserved' param to fixed ip output, this patch
added it into doc.
Change-Id: I3be65d6aa5e36662cbb09f408124d0abb8bbfdf5
Implements: blueprint api-ref-in-rst-ocata
Proxy APIs are deprecated in microversion 2.36 which means
all proxy APIs will return 404 after 2.35 version.
It will be nice to mention that explicitly in api-ref too.
Partially implements blueprint deprecate-api-proxies
Change-Id: Iad210d215fb98bc247f049b23b97d8d7d4265c82
As first step to deprecate the proxy APIs,
this commit publish the deprecation of proxy APIs
in api ref doc.
Partially implements blueprint deprecate-api-proxies
Change-Id: Ie19ec5e27fef956061786646e8f9cc4e44d8ef0f
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.
This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.
Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
Verified the API document for os-fixed-ips with source for methods
available and response codes.
Part of bp:api-ref-in-rst
Change-Id: I60096911a7895d989e056958e175477987cc72f8
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
This fix sample file path and some satatus code for
-fixed ips
-floating ips
Part of bp:api-ref-in-rst
Change-Id: I33341d67e678f70b1a4feb9b39a14f5ac81e8c65
Heading for json response example is wrong,
it is json request instead of json response.
Part of bp:api-ref-in-rst
Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
HTTP 40X-50X are not normal response codes at all.
This patch removes them from api-ref.
Part of bp:api-ref-in-rst
Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
In the sphinx document h3 is supposed to be '-' not '^':
=, for sections
-, for subsections
^, for subsubsections
We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.
Part of bp:api-ref-in-rst
Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
