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
132 lines
3.3 KiB
ReStructuredText
132 lines
3.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
============================================
|
|
Flavors access (flavors, os-flavor-access)
|
|
============================================
|
|
|
|
Lists tenants who have access to a private flavor and adds private
|
|
flavor access to and removes private flavor access from tenants. By
|
|
default, only administrators can manage private flavor access. A private
|
|
flavor has ``is_public`` set to ``false`` while a public flavor has
|
|
``is_public`` set to ``true``.
|
|
|
|
List Flavor Access Information For Given Flavor
|
|
===============================================
|
|
|
|
.. rest_method:: GET /flavors/{flavor_id}/os-flavor-access
|
|
|
|
Lists flavor access information.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- flavor_access: flavor_access
|
|
- tenant_id: tenant_id_body
|
|
- flavor_id: flavor_id_body
|
|
|
|
**Example List Flavor Access Information For Given Flavor: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-list-resp.json
|
|
:language: javascript
|
|
|
|
Add Flavor Access To Tenant (addTenantAccess Action)
|
|
====================================================
|
|
|
|
.. rest_method:: POST /flavors/{flavor_id}/action
|
|
|
|
Adds flavor access to a tenant and flavor.
|
|
|
|
Specify the ``addTenantAccess`` action and the ``tenant`` in the request body.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
- addTenantAccess: addTenantAccess
|
|
- tenant: tenant_id_body
|
|
|
|
**Example Add Flavor Access To Tenant: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-add-tenant-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- flavor_access: flavor_access
|
|
- tenant_id: tenant_id_body
|
|
- flavor_id: flavor_id_body
|
|
|
|
**Example Add Flavor Access To Tenant: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-add-tenant-resp.json
|
|
:language: javascript
|
|
|
|
Remove Flavor Access From Tenant (removeTenantAccess Action)
|
|
============================================================
|
|
|
|
.. rest_method:: POST /flavors/{flavor_id}/action
|
|
|
|
Removes flavor access from a tenant and flavor.
|
|
|
|
Specify the ``removeTenantAccess`` action and the ``tenant`` in the request body.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
|
itemNotFound(404), conflict(409)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
|
|
- flavor_id: flavor_id
|
|
- removeTenantAccess: removeTenantAccess
|
|
- tenant: tenant_id_body
|
|
|
|
**Example Remove Flavor Access From Tenant: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-remove-tenant-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- flavor_access: flavor_access
|
|
- tenant_id: tenant_id_body
|
|
- flavor_id: flavor_id_body
|
|
|
|
**Example Remove Flavor Access From Tenant: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-remove-tenant-resp.json
|
|
:language: javascript
|
|
|