Add the description for the following items
in the API reference and the API guide.
* 'X-Openstack-Request-Id' header in request
* 'X-Openstack-Request-Id' header in response
* 'X-Compute-Request-Id' in response
Change-Id: Idd9181c1530eb9576da9941416b697a97c0cfb8d
Closes-Bug: #1693555
This commit adds the api doc for os-quota-class-set GET & PUT
APIs.
- Also mentioned about the recommendation over usage of this API.
- Added warning for current bug in v2.1 API #1693168
This is also needed by BP
- https://blueprints.launchpad.net/nova/+spec/fix-quota-classes-api
Change-Id: Ib765e2d1dec7b236a2009148e0b1067a46326ce9
Related-Bug: #1693168
Closes-Bug: #1602400
This commit removes the cloudpipe API from nova. This has been
deprecated since change I415760ff634dd85974f0c3f79e788e633852efb5 and no
longer works without nova-cert and the pending removal of the deprecated
nova-network.
Implements bp remove-nova-cert
Change-Id: Ifd1fb13a5953cc66f9cc2561d30a9efcd3f4c92e
This commit removes nova-cert which has been deprecated since change
Id7a1fc943cbe6d860a50d3cc776717b55351004b. The APIs have been hard coded
to return a 410 whenever they're called now. For the API ref a new
section for obsolete apis is added to the bottom of the page and the
certificates api ref is moved there.
Implements bp remove-nova-cert
Change-Id: I2c78a0c6599b92040146cf9f0042cff8fd2509c3
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
This patch deprecates os-hosts APIs including:
GET /os-hosts - list hosts
GET /os-hosts/{host_name} - show host details
PUT /os-hosts/{host_name} - update host status
GET /os-hosts/{host_name}/reboot - reboot host
GET /os-hosts/{host_name}/shutdown - shutdown host
GET /os-hosts/{host_name}/startup - start host
Much of the ``os-hosts`` API is duplicated with the ``os-services`` and
``os-hypervisors`` APIs. It's not a good idea to make nova have the
compute related API, so this patch deprecated them.
Implements blueprint deprecate-os-hosts
Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>
Change-Id: Ieb85653b85a1eff38a9fb0c9ff05e4cd39150ecc
This patch includes all the verifications of remote consoles
part of blueprint api-ref-in-rst-pike
Co-Authored-By: Markus Zoeller <mzoeller@linux.vnet.ibm.com>
Change-Id: Ib169e4bd931b5a04f31cd0e7c43c161b49eafe5c
- Cleaned up some wording, and formatted
two rst notes.
- Moved cloudpipe.inc in index.rst to be located
with other deprecated apis.
Change-Id: Ic3740540e8cc626110c77214acf87338e1abdd76
We don't have any api-ref for server-migrations. os-migrations
is frozen and server-migrations replaces it, but we don't
have any docs for it, so this is a start.
Partial-Bug: #1641713
Part of blueprint api-ref-in-rst-ocata
Change-Id: I3da6ff6a4a0abf2f9c8bae3fb28fe23fdc3b0959
Coming out of the Nova midcycle we decided we really needed to
deprecate the os-certificates API and service. It is not used by any
of the rest of Nova. It's an API that requires a dedicated daemon to
be run. It's making Nova assume the responsibility for generating
secure certificates, even though it's not really managing entropy in
any sane way (which is why nova-cert is a service, so you could stick
these on all your computes so as to not run out of entropy).
Change-Id: I0ffa9200d8b4f52da4751e731aecffe09fd3d4be
All proxy APIs are now deprecated which includes
sec grp APIs also.
But list sec grps by server API-
(/servers/{server_id}/os-security-groups) is not
deprecated so this should be separated from deprecated
sec grp APIs in api-ref.
Partially implements blueprint deprecate-api-proxies
Change-Id: I9f9e2cf5f8e390cecd9e1794a0af1a3fcc24f149
This creates a new way to describe multiple create as a dedicated
create call in the normal servers list. It only lists additional
parameters so that we're not copy / pasting between the 2 lists.
Part of bp:api-ref-in-rst
Change-Id: Ib15f224cf6a9432ae638c8b57a2156cd7b98215d
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
This completes the validation for the admin event interface, including
detailing the codes we currently return in the parameter list.
Because os-service was incorrectly using the 'status' key, when I
renamed status => event_status I needed to also create a
service_status to make things compile. It's accurate enough to move
forward.
Because this is really a Neutron only API, this is moved towards the
bottom of the API list, to make it clear this isn't really designed to
be used by end user apps.
Part of bp:api-ref-in-rst
Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56
The extensions in api-ref-compute-v2.1 is deprecated. This patch
depricates the extension infrastructure in v2.1.
Change-Id: Ie7731c25ee7c5c662c22835add3314ffa51f37bc
Closes-Bug: #1490531
This adds a global control that does show / hide of all collapseable
sections. Which is extremely useful in seeing the entire API at once.
Part of bp:api-ref-in-rst
Change-Id: I814e6b2c20c25bf3d4cb4e722bc8157ca0aa1b89
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
This adds sample API content for versions and servers resources,
including the parameters.yaml that is needed in both of these cases.
It also makes a new tox.ini target 'api-ref' for building these docs,
which will be used as part of the publishing pipeline.
Change-Id: I310ed352dc5dd81d01f2fd5f1a2fab662c29f0dc
Takashi NATSUME