openstack/nova
Code Issues Proposed changes
a40c00957e
nova/api-ref/source/index.rst

84 lines
2.6 KiB
ReStructuredText
Raw Normal View History

Add sample API content 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
2016-03-29 11:56:21 -04:00
:tocdepth: 2
=============
Compute API
=============
Add 'Show All' / 'Hide All' toggle 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
2016-04-14 07:34:15 -04:00
Replace "Openstack" with "OpenStack" According to the word choice convention in http://docs.openstack.org/contributor-guide/writing-style/word-choice.html We should use "OpenStack" instead of "Openstack". Change-Id: Ie55354adb17fb3617995cf9463e670e4788723ca
2016-12-22 23:15:37 +08:00
This is a reference for the OpenStack Compute API which is provided by the Nova
project. To learn more about the OpenStack Compute API concepts, please refer to
[api-ref] Minor text clean-up, formatting - 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
2016-11-29 12:31:46 -05:00
the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
Add link ref to nova api concept doc This patch adds link to the api concept doc. Change-Id: I3c9f7ebce7f4241a41492511b39f8649190b53eb Partial-implements: blueprint api-ref-in-rst-ocata
2016-09-19 10:35:14 +08:00
Add 'Show All' / 'Hide All' toggle 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
2016-04-14 07:34:15 -04:00
.. rest_expand_all::
Import RST files for documentation 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
2016-04-12 09:03:46 -04:00
.. include:: versions.inc
remove /v2.1/{tenant_id} from all urls 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
2016-06-02 08:50:03 -04:00
.. include:: urls.inc
api-ref: Add X-Openstack-Request-Id description 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
2017-06-16 11:38:55 +09:00
.. include:: request-ids.inc
Import RST files for documentation 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
2016-04-12 09:03:46 -04:00
.. include:: servers.inc
.. include:: servers-actions.inc
.. include:: servers-action-fixed-ip.inc
.. include:: servers-action-evacuate.inc
.. include:: servers-action-deferred-delete.inc
.. include:: servers-action-console-output.inc
.. include:: servers-action-shelve.inc
.. include:: servers-action-crash-dump.inc
api-ref: Complete all the verifications of remote consoles 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
2016-07-06 14:35:08 +08:00
.. include:: servers-action-remote-consoles.inc
Import RST files for documentation 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
2016-04-12 09:03:46 -04:00
.. include:: servers-admin-action.inc
api-ref: Complete all the verifications of remote consoles 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
2016-07-06 14:35:08 +08:00
.. include:: servers-remote-consoles.inc
Separate api-ref for list security groups by server 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
2016-07-21 16:42:57 +09:00
.. include:: server-security-groups.inc
Import RST files for documentation 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
2016-04-12 09:03:46 -04:00
.. include:: diagnostics.inc
.. include:: ips.inc
.. include:: metadata.inc
.. include:: os-instance-actions.inc
.. include:: os-interface.inc
.. include:: os-server-password.inc
.. include:: os-volume-attachments.inc
.. include:: flavors.inc
.. include:: os-flavor-access.inc
.. include:: os-flavor-extra-specs.inc
.. include:: os-keypairs.inc
.. include:: limits.inc
.. include:: os-agents.inc
.. include:: os-aggregates.inc
.. include:: os-assisted-volume-snapshots.inc
.. include:: os-availability-zone.inc
.. include:: os-cells.inc
.. include:: os-consoles.inc
.. include:: os-hypervisors.inc
.. include:: os-instance-usage-audit-log.inc
.. include:: os-migrations.inc
api-ref: method verification for server-migrations 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
2016-11-14 16:12:29 -05:00
.. include:: server-migrations.inc
Import RST files for documentation 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
2016-04-12 09:03:46 -04:00
.. include:: os-quota-sets.inc
Add api-ref for os-quota-class-set APIs 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
2017-05-25 12:06:11 +03:00
.. include:: os-quota-class-sets.inc
Import RST files for documentation 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
2016-04-12 09:03:46 -04:00
.. include:: os-server-groups.inc
api-ref: added docs for microversion 2.26 Part of bp:tag-instances Part of bp:api-ref-in-rst Change-Id: Ifd0d518d086719eb248b442359c272b1799544c6
2016-06-08 16:16:45 +03:00
.. include:: os-server-tags.inc
Import RST files for documentation 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
2016-04-12 09:03:46 -04:00
.. include:: os-services.inc
.. include:: os-simple-tenant-usage.inc
api-ref: finish validation for os-server-external-events.inc 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
2016-05-11 14:47:13 -04:00
.. include:: os-server-external-events.inc
Deprecated the concept of extensions in v2.1. 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
2016-04-27 15:26:03 +05:30
.. include:: extensions.inc
Publish proxy APIs deprecation in api ref doc 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
2016-06-14 15:31:18 +09:00
.. include:: os-networks.inc
.. include:: os-volumes.inc
.. include:: images.inc
.. include:: os-baremetal-nodes.inc
.. include:: os-tenant-network.inc
.. include:: os-fixed-ips.inc
.. include:: os-floating-ip-dns.inc
.. include:: os-floating-ip-pools.inc
.. include:: os-floating-ips.inc
.. include:: os-floating-ips-bulk.inc
.. include:: os-fping.inc
.. include:: os-security-groups.inc
.. include:: os-security-group-default-rules.inc
.. include:: os-security-group-rules.inc
Deprecate os-hosts API 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
2017-03-27 17:49:11 +08:00
.. include:: os-hosts.inc
Deprecate Multinic, floatingip action and os-virtual-interface API 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
2017-04-17 15:45:17 +08:00
.. include:: os-virtual-interfaces.inc
Remove nova-cert 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
2017-04-24 17:57:57 -04:00
=============
Obsolete APIs
=============
This section contains the reference for APIs that were part of the OpenStack
Compute API in the past, but no longer exist.
.. include:: os-certificates.inc
Remove cloudpipe APIs 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
2017-04-24 19:43:54 -04:00
.. include:: os-cloudpipe.inc
Copy Permalink