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-virtual-interfaces 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-virtual-interfaces was
removed.
Depends-On: https://review.openstack.org/571556/
Part of blueprint remove-nova-network
Change-Id: Id7f94a643e5d7b8a842c0f4a5c9f796d6566b365
The following APIs which are considered as proxies of Neutron networking
API, are deprecated and will result in a 404 error response in new
Microversion:
POST /servers/{server_uuid}/action
{
"addFixedIp": {...}
}
POST /servers/{server_uuid}/action
{
"removeFixedIp": {...}
}
POST /servers/{server_uuid}/action
{
"addFloatingIp": {...}
}
POST /servers/{server_uuid}/action
{
"removeFloatingIp": {...}
And the nova-network specific API for query server's interfaces is
deprecated also:
GET /servers/{server_uuid}/os-virtual-interfaces
Partial implement blueprint deprecate-multinic-proxy-api
Change-Id: I1848db384a825d3b166f113b30ebad92113af8e5
some api-ref have sentence like '..for a server instance'
which is inconsistent and confusing as we use server for VM terminology.
I think here 'instance' word is being considered object of server which
is wrong.
We should always mention server only.
part of bp:api-ref-in-rst-pike
Change-Id: I32afe56cfc66b34b76d1f7e1b507d3d5e722e6a1
A number of endpoints enable pagination via 'limit' & 'offset' query
parameters, but don't document or test this functionality.
- os-cells
- os-security-groups
- os-server-groups
- os-snapshots
- os-virtual-interfaces
- os-volume-attachments
- os-volumes
Change-Id: I5b0ad25f7282f4a13bbb6f21b76e986e1008936a
Let's avoid confusion over errors from the os-virtual-interfaces
exception when using Neutron and make a note that it's only
implemented for nova-network.
Change-Id: I7a136eecbeb5f89dfe98f51abf1188213bdca9fd
Closes-Bug: #1648047
This includes the parameter, example, and body verifications
for api-ref os-virtual-interfaces.
part of bp:api-ref-in-rst
Change-Id: I7fea91f046de9c0765b6c317c5cf310bc76be78b
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 doc for os-virtual-interfaces,
Also, remove some common error code like 500, 503 etc
Part of bp:api-ref-in-rst
Change-Id: Iaaae9932d27d8fe7db529d101536bcd3dacb33cb
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
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
fix api-sample reference to flavors
make some changes to os-virtual-interfaces so don't talk
about microversion in contents(will add microversion later)
also, fix id param reference
Part of bp:api-ref-in-rst
Change-Id: I6eb8a14fce1c1048506cd5b990576ca5ecf44b6c
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
