summaryrefslogtreecommitdiff
path: root/api-ref/source/flavors.inc
diff options
context:
space:
mode:
authorSean Dague <sean@dague.net>2016-04-12 09:03:46 -0400
committerSean Dague <sean@dague.net>2016-04-13 07:34:45 -0400
commitd4e27714405e064ba8f62070e8c48d7fa71b6996 (patch)
treebd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/flavors.inc
parentf1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff)
downloadnova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz
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
Diffstat (limited to 'api-ref/source/flavors.inc')
-rw-r--r--api-ref/source/flavors.inc169
1 files changed, 169 insertions, 0 deletions
diff --git a/api-ref/source/flavors.inc b/api-ref/source/flavors.inc
new file mode 100644
index 0000000000..abf042ad22
--- /dev/null
+++ b/api-ref/source/flavors.inc
@@ -0,0 +1,169 @@
+.. -*- rst -*-
+
+============================================
+ Flavors with extended attributes (flavors)
+============================================
+
+Shows information about flavors.
+
+List Flavors
+============
+
+.. rest_method:: GET /v2.1/{tenant_id}/flavors
+
+Lists flavors.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+
+Query Parameters
+~~~~~~~~~~~~~~~~
+
+.. rest_parameters:: parameters.yaml
+
+ - minDisk: minDisk
+ - minRam: minRam
+ - sort_key: sort_key
+ - sort_dir: sort_dir
+ - limit: limit
+ - marker: marker
+
+Response
+^^^^^^^^
+
+**Example List Flavors: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/flavors/flavors-list-resp.json
+ :language: javascript
+
+Create Flavor
+=============
+
+.. rest_method:: POST /v2.1/{tenant_id}/flavors
+
+Creates a flavor.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+
+**Example Create Flavor: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/flavors/flavor-create-req.json
+ :language: javascript
+
+Response
+^^^^^^^^
+
+**Example Create Flavor: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/flavors/flavor-create-resp.json
+ :language: javascript
+
+Show Flavor Details
+===================
+
+.. rest_method:: GET /v2.1/{tenant_id}/flavors/{flavor_id}
+
+Shows details for a flavor.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - flavor_id: flavor_id
+
+Response
+^^^^^^^^
+
+**Example Show Flavor Details: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/flavors/flavor-show-resp.json
+ :language: javascript
+
+Delete Flavor
+=============
+
+.. rest_method:: DELETE /v2.1/{tenant_id}/flavors/{flavor_id}
+
+Deletes a flavor.
+
+Normal response codes: 202
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+ - flavor_id: flavor_id
+
+Response
+^^^^^^^^
+
+List Flavors With Details
+=========================
+
+.. rest_method:: GET /v2.1/{tenant_id}/flavors/detail
+
+Lists flavors with details.
+
+Normal response codes: 200
+
+Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
+unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
+
+Request
+^^^^^^^
+
+.. rest_parameters:: parameters.yaml
+
+ - tenant_id: tenant_id
+
+Query Parameters
+~~~~~~~~~~~~~~~~
+
+.. rest_parameters:: parameters.yaml
+
+ - minDisk: minDisk
+ - minRam: minRam
+ - sort_key: sort_key
+ - sort_dir: sort_dir
+ - limit: limit
+ - marker: marker
+
+Response
+^^^^^^^^
+
+**Example List Flavors With Details: JSON request**
+
+.. literalinclude:: ../../doc/api_samples/flavors/flavors-list-detail-resp.json
+ :language: javascript
+