openstack/nova - nova - OpenDev: Free Software Needs Free Tools

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

.. -*- rst -*-

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

=====================================

Extensions (extensions) (DEPRECATED)

=====================================

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

Lists available extensions and shows information for an extension, by

alias.

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

Nova originally supported the concept of API extensions, that allowed

implementations of Nova to change the API (add new resources, or

attributes to existing resource objects) via extensions. In an attempt

to expose to the user what was supported in a particular site, the

extensions resource provided a list of extensions and detailed

information on each. The net result was gratuitous differentiation in

the API that required all users of OpenStack clouds to write specific

code to interact with every cloud.

As such, the entire extensions concept is deprecated, and will be

removed in the near future.

List Extensions

===============

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

.. rest_method:: GET /extensions

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

Lists all extensions to the API.

Normal response codes: 200

Error response codes: unauthorized(401)

Response

--------

.. rest_parameters:: parameters.yaml

- extensions: extensions

- name: extension_name

- alias: alias

- links: extension_links

- namespace: namespace

- description: extension_description

- updated: updated

**Example List Extensions**

Lists all extensions to the API.

Enable all extension for all remaining sample tests As extensions options has been deprecated, API sample tests should run against all extension enable. This commit enables all extensions for all the remaining sample tests and remove extensions specific tests and sample files. Also remove extension setting specific logic from base test class along with TODOs. Partially implements blueprint api-sample-tests-with-all-extensions Change-Id: I66b593760789e5b3b92137a672246f8d91e44cba

2016年06月10日 14:56:46 +09:00

.. literalinclude:: ../../doc/api_samples/extension-info/extensions-list-resp.json

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

:language: javascript

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

Show Extension Details

======================

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

.. rest_method:: GET /extensions/{alias}

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

Shows details for an extension, by alias.

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

Normal response codes: 200

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

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

Error response codes: unauthorized(401), itemNotFound(404)

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

Request

move sphinx h3 to '-' instead of '^' 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

2016年04月14日 13:10:59 -04:00

-------

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

.. rest_parameters:: parameters.yaml

- alias: alias

Response

move sphinx h3 to '-' instead of '^' 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

2016年04月14日 13:10:59 -04:00

--------

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

.. rest_parameters:: parameters.yaml

- extension: extension

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

- name: extension_name

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

- alias: alias

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

- links: extension_links

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

- namespace: namespace

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

- description: extension_description

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

- updated: updated

api-ref: complete verification for extensions resource This completes all 4 phases of the extensions resource. * List method was added * Error codes updated as exist in code * Updates parameters.yaml to match actual descriptions for parameters * Update body to be a lot stronger about what our deprecation means and why. Part of bp:api-ref-in-rst Change-Id: I003fc1cc84cd429fbdc0c4f0847be81d920d3561

2016年05月09日 09:25:37 -04:00

**Example Show Extension Details**

Shows details about the ``os-agents`` extension.

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

Fix remaining json reference warnings This fixes the last json reference warning which exist. It also trims out the baremetal API calls that we don't support any more (we only have the readonly proxy). That was erroneously added to the compute API docs in refactors of api-site last cycle. Change-Id: I08be639b610304049b0959902ed8876559111274

2016年04月20日 08:42:24 -04:00

.. literalinclude:: ../../doc/api_samples/extension-info/extensions-get-resp.json

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

:language: javascript

openstack/nova - nova - OpenDev: Free Software Needs Free Tools

92 lines 2.1 KiB PHP Raw Normal View History Unescape Escape

92 lines

2.1 KiB

PHP

Raw Normal View History