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

68 lines
2.0 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
.. 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
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-remote-consoles.inc
.. include:: servers-action-shelve.inc
.. include:: servers-action-crash-dump.inc
.. include:: servers-admin-action.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-virtual-interfaces.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-cloudpipe.inc
.. include:: os-consoles.inc
.. include:: os-hosts.inc
.. include:: os-hypervisors.inc
.. include:: os-instance-usage-audit-log.inc
.. include:: os-migrations.inc
.. include:: os-quota-sets.inc
.. 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
Deprecate os-certificates 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
2016-07-26 10:42:41 -04:00
.. include:: os-certificates.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
Copy Permalink