openstack/nova
Code Issues Proposed changes
a99d74155b
nova/api-ref/source/os-flavor-access.inc

113 lines
2.9 KiB
PHP
Raw Normal View History

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 -*-
add tags to files for the content verification phase This adds a set of tags in comments to the beginning of files so that we can process them according to the documentation here: https://wiki.openstack.org/wiki/NovaAPIRef Part of bp:api-ref-in-rst Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
2016-04-20 16:10:51 -04:00
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
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
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
============================================
Flavors access (flavors, os-flavor-access)
============================================
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 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
===============================================
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
.. rest_method:: GET /v2.1/{tenant_id}/flavors/{flavor_id}/os-flavor-access
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 flavor access information.
Normal response codes: 200
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
Error response codes: unauthorized(401), forbidden(403), 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
- tenant_id: tenant_id
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
- flavor_id: flavor_id
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
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
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example List Flavor Access Information For Given Flavor: JSON response**
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 flavor-access and flavor-extras api-ref flavor-access and flavor-extras api-ref has wrong reference this patch fixed it. Part of bp:api-ref-in-rst Change-Id: I07fed203b2f3908bade0e087265384349e21830c
2016-03-23 19:56:48 +08:00
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-list-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
Add Flavor Access To Tenant
===========================
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
.. rest_method:: POST /v2.1/{tenant_id}/flavors/{flavor_id}/action
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
Adds flavor access to a tenant and flavor.
Specify the ``addTenantAccess`` action and the ``tenant_id`` in the request body.
Normal response codes: 200
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
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
- tenant_id: tenant_id
- flavor_id: flavor_id
**Example Add Flavor Access To Tenant: JSON request**
Fix flavor-access and flavor-extras api-ref flavor-access and flavor-extras api-ref has wrong reference this patch fixed it. Part of bp:api-ref-in-rst Change-Id: I07fed203b2f3908bade0e087265384349e21830c
2016-03-23 19:56:48 +08:00
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-add-tenant-req.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
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
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example Add Flavor Access To Tenant: JSON response**
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 flavor-access and flavor-extras api-ref flavor-access and flavor-extras api-ref has wrong reference this patch fixed it. Part of bp:api-ref-in-rst Change-Id: I07fed203b2f3908bade0e087265384349e21830c
2016-03-23 19:56:48 +08:00
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-add-tenant-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
Remove Flavor Access From Tenant
================================
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
.. rest_method:: POST /v2.1/{tenant_id}/flavors/{flavor_id}/action
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
Removes flavor access from a tenant and flavor.
Specify the ``removeTenantAccess`` action and the ``tenant_id`` in the request body.
Normal response codes: 200
Complet Method Verification of flavor-access verified the API doc for os-flavor-access, changes several incorrect path per test result Also, remove some common error code like 500, 503 etc detail log: http://paste.openstack.org/show/495498/ Part of bp:api-ref-in-rst Change-Id: Ia8c4e5ada61a279a26b58081a0b771b5b8bd75f3
2016-04-23 11:14:16 +08:00
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
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
- tenant_id: tenant_id
- flavor_id: flavor_id
**Example Remove Flavor Access From Tenant: JSON request**
Fix flavor-access and flavor-extras api-ref flavor-access and flavor-extras api-ref has wrong reference this patch fixed it. Part of bp:api-ref-in-rst Change-Id: I07fed203b2f3908bade0e087265384349e21830c
2016-03-23 19:56:48 +08:00
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-remove-tenant-req.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
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
Fix json response example heading in api ref Heading for json response example is wrong, it is json request instead of json response. Part of bp:api-ref-in-rst Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
2016-04-19 17:52:18 +09:00
**Example Remove Flavor Access From Tenant: JSON response**
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 flavor-access and flavor-extras api-ref flavor-access and flavor-extras api-ref has wrong reference this patch fixed it. Part of bp:api-ref-in-rst Change-Id: I07fed203b2f3908bade0e087265384349e21830c
2016-03-23 19:56:48 +08:00
.. literalinclude:: ../../doc/api_samples/flavor-access/flavor-access-remove-tenant-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
Copy Permalink