c9f5ad3bcf
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
157 lines
3.5 KiB
ReStructuredText
157 lines
3.5 KiB
ReStructuredText
.. -*- rst -*-
|
|
.. needs:parameter_verification
|
|
.. needs:example_verification
|
|
.. needs:body_verification
|
|
|
|
======================================================
|
|
Flavors extra-specs (flavors, os-flavor-extra-specs)
|
|
======================================================
|
|
|
|
Lists, creates, deletes, and updates the extra-specs or keys for a
|
|
flavor.
|
|
|
|
List Extra Specs For A Flavor
|
|
=============================
|
|
|
|
.. rest_method:: GET /flavors/{flavor_id}/os-extra_specs
|
|
|
|
Lists all extra specs for a flavor, by ID.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Extra Specs For A Flavor: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-extra-specs/flavor-extra-specs-list-resp.json
|
|
:language: javascript
|
|
|
|
Create Extra Specs For A Flavor
|
|
===============================
|
|
|
|
.. rest_method:: POST /flavors/{flavor_id}/os-extra_specs
|
|
|
|
Creates extra specs for a flavor, by ID.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
|
|
**Example Create Extra Specs For A Flavor: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-extra-specs/flavor-extra-specs-create-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Create Extra Specs For A Flavor: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-extra-specs/flavor-extra-specs-create-resp.json
|
|
:language: javascript
|
|
|
|
Show An Extra Spec For A Flavor
|
|
===============================
|
|
|
|
.. rest_method:: GET /flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key}
|
|
|
|
Shows an extra spec, by key, for a flavor, by ID.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
- flavor_extra_spec_key: flavor_extra_spec_key
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show An Extra Spec For A Flavor: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-extra-specs/flavor-extra-specs-get-resp.json
|
|
:language: javascript
|
|
|
|
Update An Extra Spec For A Flavor
|
|
=================================
|
|
|
|
.. rest_method:: PUT /flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key}
|
|
|
|
Updates an extra spec, by key, for a flavor, by ID.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), uauthorized(401), forbidden(403)
|
|
itemNotFound(404), conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
- flavor_extra_spec_key: flavor_extra_spec_key
|
|
|
|
**Example Update An Extra Spec For A Flavor: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-extra-specs/flavor-extra-specs-update-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Update An Extra Spec For A Flavor: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-extra-specs/flavor-extra-specs-update-resp.json
|
|
:language: javascript
|
|
|
|
Delete An Extra Spec For A Flavor
|
|
=================================
|
|
|
|
.. rest_method:: DELETE /flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key}
|
|
|
|
Deletes an extra spec, by key, for a flavor, by ID.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
- flavor_extra_spec_key: flavor_extra_spec_key
|
|
|
|
Response
|
|
--------
|
|
|