womax/nova
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix api samples references in 3 more files

Browse Source 
This fixes more api samples references which were autogenerated
incorrectly, and brings our api-ref warnings down to 175.

It also removes the os-volume-types API references, which turns out to
be a complete work of fiction, and never existed.

Part of bp:api-ref-in-rst

Change-Id: I1395c5e5986d8810ed91e9c9f132ec04f620497c
This commit is contained in:
Sean Dague
2016-04-18 08:58:58 -04:00
parent 16cea9cdc5
commit 516bd072bc
3 changed files with 18 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-ref/source/os-simple-tenant-usage.inc
+2 -3
View File
@@ -30,7 +30,7 @@ Response
**Example List Tenant Usage For All Tenants: JSON response**
.. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-show-general-resp.json
.. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-get.json
:language: javascript
Show Usage Details For Tenant
@@ -57,6 +57,5 @@ Response
**Example Show Usage Details For Tenant: JSON response**
.. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-simple-tenant-usage/simple-tenant-usage-get-specific.json
:language: javascript
api-ref/source/os-tenant-network.inc
+8 -9
View File
@@ -29,7 +29,7 @@ Request
**Example Create Project Network: JSON request**
.. literalinclude:: ../../doc/api_samples/os-tenant-networks/network-create-req.json
.. literalinclude:: ../../doc/api_samples/os-tenant-networks/networks-post-req.json
:language: javascript
Response
@@ -37,7 +37,7 @@ Response
**Example Create Project Network: JSON response**
.. literalinclude:: ../../doc/api_samples/os-tenant-networks/network-create-resp.json
.. literalinclude:: ../../doc/api_samples/os-tenant-networks/networks-post-res.json
:language: javascript
List Project Networks
@@ -66,7 +66,7 @@ Response
**Example List Project Networks: JSON response**
.. literalinclude:: ../../doc/api_samples/os-networks/networks-list-resp.json
.. literalinclude:: ../../doc/api_samples/os-tenant-networks/networks-list-res.json
:language: javascript
Show Project Network Details
@@ -96,7 +96,7 @@ Response
**Example Show Project Network Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-tenant-networks/network-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-tenant-networks/networks-post-res.json
:language: javascript
Delete Project Network
@@ -148,7 +148,7 @@ Request
**Example Associate Host: JSON request**
.. literalinclude:: ../../doc/api_samples/os-networks/network-associate-host-req.json
.. literalinclude:: ../../doc/api_samples/os-networks-associate/network-associate-host-req.json
:language: javascript
Response
@@ -178,7 +178,7 @@ Request
**Example Disassociate Host: JSON request**
.. literalinclude:: ../../doc/api_samples/os-networks/network-disassociate-host-req.json
.. literalinclude:: ../../doc/api_samples/os-networks-associate/network-disassociate-host-req.json
:language: javascript
Response
@@ -208,7 +208,7 @@ Request
**Example Disassociate Network: JSON request**
.. literalinclude:: ../../doc/api_samples/os-networks/network-disassociate-req.json
.. literalinclude:: ../../doc/api_samples/os-networks/networks-disassociate-req.json
:language: javascript
Response
@@ -238,9 +238,8 @@ Request
**Example Disassociate Project: JSON request**
.. literalinclude:: ../../doc/api_samples/os-networks/network-disassociate-project-req.json
.. literalinclude:: ../../doc/api_samples/os-networks-associate/network-disassociate-project-req.json
:language: javascript
Response
--------
api-ref/source/os-volumes.inc
+8 -81
View File
@@ -30,7 +30,7 @@ Response
**Example List Volumes: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/volumes-list-resp.json
.. literalinclude:: ../../doc/api_samples/os-volumes/os-volumes-index-resp.json
:language: javascript
Create Volume
@@ -62,7 +62,7 @@ Request
**Example Create Volume: JSON request**
.. literalinclude:: ../../doc/api_samples/os-volumes/volume-create-req.json
.. literalinclude:: ../../doc/api_samples/os-volumes/os-volumes-post-req.json
:language: javascript
Response
@@ -70,7 +70,7 @@ Response
**Example Create Volume: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/volume-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-volumes/os-volumes-post-resp.json
:language: javascript
List Volumes With Details
@@ -97,7 +97,7 @@ Response
**Example List Volumes With Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/volumes-list-detail-resp.json
.. literalinclude:: ../../doc/api_samples/os-volumes/os-volumes-detail-resp.json
:language: javascript
Show Volume Details
@@ -125,7 +125,7 @@ Response
**Example Show Volume Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/volume-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-volumes/os-volumes-get-resp.json
:language: javascript
Delete Volume
@@ -151,73 +151,6 @@ Request
Response
--------
**Example Delete Volume: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/volume-delete-json-http.txt
:language: javascript
List Volume Types
=================
.. rest_method:: GET /v2.1/{tenant_id}/os-volume-types
Lists volume types.
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
Response
--------
.. rest_parameters:: parameters.yaml
- volume_types: volume_types
- id: id
- name: name
- extra_specs: extra_specs
**Example List Volume Types: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/volume-types-list-resp.json
:language: javascript
Show Volume Type Details
========================
.. rest_method:: GET /v2.1/{tenant_id}/os-volume-types/{volume_type_id}
Shows details for a volume type.
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
- volume_type_id: volume_type_id
Response
--------
**Example Show Volume Type Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/volume-type-show-resp.json
:language: javascript
Create Snapshot
===============
@@ -248,7 +181,7 @@ Response
**Example Create Snapshot: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/snapshot-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-volumes/snapshot-create-resp.json
:language: javascript
List Snapshots
@@ -302,7 +235,7 @@ Response
**Example List Snapshots With Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/snapshots-list-resp.json
.. literalinclude:: ../../doc/api_samples/os-volumes/snapshots-detail-resp.json
:language: javascript
Show Snapshot Details
@@ -330,7 +263,7 @@ Response
**Example Show Snapshot Details: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/snapshot-show-resp.json
.. literalinclude:: ../../doc/api_samples/os-volumes/snapshots-show-resp.json
:language: javascript
Delete Snapshot
@@ -357,9 +290,3 @@ Request
Response
--------
**Example Delete Snapshot: JSON response**
.. literalinclude:: ../../doc/api_samples/os-volumes/snapshot-delete-json-http.txt
:language: javascript