openstack/cinder
Code Issues Proposed changes

api-ref: Normalize response codes

Browse Source 
We had a mix of formatting for our API response codes. This
makes it so all have a leading space, no trailing comma, and
no empty Error response labels.

This also addresses a formatting issue with due to the spacing
between the Normal and Error lines that was causing the two to
run together in the formatted HTML, making it harder to read.

Change-Id: Ic411ee9f671c48ce60bda21984dafe55135685ba
This commit is contained in:
Sean McGinnis 2017-09-03 18:13:01 -05:00
parent bd27f8ec6c
commit 117f614428
25 changed files with 52 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-ref/source/v2/capabilities-v2.inc
View File

@ -16,7 +16,6 @@ The ``hostname`` takes the form of ``hostname@volume_backend_name``.
Normal response codes: 200
Error response codes:
Request
-------

3
api-ref/source/v2/consistencygroups-v2.inc
View File

@ -23,7 +23,6 @@ Lists consistency groups.
Normal response codes: 200
Error response codes:
Request
@ -107,7 +106,6 @@ Show consistency group details
Shows details for a consistency group.
Normal response codes: 200
Error response codes:
Request
-------
@ -203,7 +201,6 @@ Lists consistency groups with details.
Normal response codes: 200
Error response codes:
Request

2
api-ref/source/v2/ext-backups-actions-v2.inc
View File

@ -19,6 +19,7 @@ The backup driver returns the ``405`` status code if it does not
support this operation.
Normal response codes: 202
Error response codes: itemNotFound(404), badMethod(405)
@ -47,6 +48,7 @@ Reset backup's status
Reset a backup's status. Specify the ``os-reset_status`` action in the request body.
Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404)

12
api-ref/source/v2/ext-backups.inc
View File

@ -46,7 +46,6 @@ Lists Block Storage backups, with details, to which the tenant has access.
Normal response codes: 200
Error response codes:
Request
@ -101,7 +100,6 @@ Shows details for a backup.
Normal response codes: 200
Error response codes:
Request
@ -151,7 +149,8 @@ Delete backup
Deletes a backup.
Normal response codes: 202,
Normal response codes: 202
Error response codes: Bad Request(400)
@ -176,7 +175,8 @@ Restores a Block Storage backup to an existing or new Block Storage volume.
You must specify either the UUID or name of the volume. If you
specify both the UUID and name, the UUID takes priority.
Normal response codes: 202,
Normal response codes: 202
Error response codes: Bad Request(400), Request Entity Too Large(413)
@ -221,6 +221,7 @@ Create backup
Creates a Block Storage backup from a volume.
Normal response codes: 202,
Error response codes: Bad Request(400), Internal Server Error(500)
Request
@ -262,7 +263,6 @@ List backups
Lists Block Storage backups to which the tenant has access.
Normal response codes: 200
Error response codes:
Request
-------
@ -301,6 +301,7 @@ Export information about a backup.
Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404)
@ -337,6 +338,7 @@ Import information about a backup.
Normal response codes: 201
Error response codes: badRequest(400), serviceUnavailable(503)

1
api-ref/source/v2/hosts.inc
View File

@ -16,7 +16,6 @@ List all hosts
Lists all hosts summary info that is not disabled.
Normal response codes: 200
Error response codes:
Request
-------

3
api-ref/source/v2/limits.inc
View File

@ -21,7 +21,8 @@ for the item is infinite.
Normal response codes: 200
Error response codes:203,
Error response codes: 203
Request
-------

7
api-ref/source/v2/os-cgsnapshots-v2.inc
View File

@ -14,7 +14,7 @@ Delete consistency group snapshot
Deletes a consistency group snapshot.
Normal response codes: 202,
Normal response codes: 202
Request
@ -35,7 +35,6 @@ Shows details for a consistency group snapshot.
Normal response codes: 200
Error response codes:
Request
@ -75,7 +74,6 @@ Lists all consistency group snapshots with details.
Normal response codes: 200
Error response codes:
Request
-------
@ -112,7 +110,6 @@ Lists all consistency group snapshots.
Normal response codes: 200
Error response codes:
Request
@ -149,7 +146,7 @@ Create consistency group snapshot
Creates a consistency group snapshot.
Normal response codes: 202,
Normal response codes: 202
Request
-------

1
api-ref/source/v2/os-vol-pool-v2.inc
View File

@ -16,7 +16,6 @@ Lists all back-end storage pools.
Normal response codes: 200
Error response codes:
Request
-------

9
api-ref/source/v2/os-vol-transfer-v2.inc
View File

@ -13,7 +13,7 @@ Accept volume transfer
Accepts a volume transfer.
Normal response codes: 202,
Normal response codes: 202
Request
@ -51,7 +51,7 @@ Create volume transfer
Creates a volume transfer.
Normal response codes: 202,
Normal response codes: 202
Request
@ -92,7 +92,6 @@ Lists volume transfers.
Normal response codes: 200
Error response codes:
Request
@ -130,7 +129,6 @@ Shows details for a volume transfer.
Normal response codes: 200
Error response codes:
Request
@ -168,7 +166,7 @@ Delete volume transfer
Deletes a volume transfer.
Normal response codes: 202,
Normal response codes: 202
Request
@ -189,7 +187,6 @@ Lists volume transfers, with details.
Normal response codes: 200
Error response codes:
Request
-------

18
api-ref/source/v2/qos-specs-v2-qos-specs.inc
View File

@ -17,7 +17,7 @@ Disassociate QoS specification from all associations
Disassociates a QoS specification from all associations.
Normal response codes: 202,
Normal response codes: 202
Request
@ -38,7 +38,6 @@ Unsets keys in a QoS specification.
Normal response codes: 200
Error response codes:
Request
@ -74,7 +73,6 @@ Lists all associations for a QoS specification.
Normal response codes: 200
Error response codes:
Request
@ -100,7 +98,7 @@ Associate QoS specification with volume type
Associates a QoS specification with a volume type.
Normal response codes: 202,
Normal response codes: 202
Request
@ -120,7 +118,7 @@ Disassociate QoS specification from volume type
Disassociates a QoS specification from a volume type.
Normal response codes: 202,
Normal response codes: 202
Request
@ -142,7 +140,8 @@ Shows details for a QoS specification.
Normal response codes: 200
Error response codes: 413, 405, 404, 403, 401, 400, 503,
Error response codes: 413, 405, 404, 403, 401, 400, 503
Request
@ -183,7 +182,6 @@ Sets keys in a QoS specification.
Normal response codes: 200
Error response codes:
Request
@ -217,7 +215,7 @@ Delete QoS specification
Deletes a QoS specification.
Normal response codes: 202,
Normal response codes: 202
Request
@ -239,7 +237,7 @@ Creates a QoS specification.
Specify one or more key and value pairs in the request body.
Normal response codes: 202,
Normal response codes: 202
Request
@ -281,7 +279,7 @@ List QoS specs
Lists quality of service (QoS) specifications.
Normal response codes: 200, 300,
Normal response codes: 200
Request

2
api-ref/source/v2/quota-classes.inc
View File

@ -16,6 +16,7 @@ Shows quota class set for a tenant. If no specific value for the quota class
resource exists, then the default value will be reported.
Normal response codes: 200
Error response codes: 403, 404
@ -58,6 +59,7 @@ Updates quota class set for a tenant. If the ``quota_class_name`` key does not
exist, then the API will create one.
Normal response codes: 200
Error response codes: 400, 403, 404

4
api-ref/source/v2/quota-sets.inc
View File

@ -16,7 +16,6 @@ Shows quotas for a tenant.
Normal response codes: 200
Error response codes:
Request
@ -67,7 +66,6 @@ Updates quotas for a tenant.
Normal response codes: 200
Error response codes:
Request
@ -138,7 +136,6 @@ Deletes quotas for a tenant so the quotas revert to default values.
Normal response codes: 200
Error response codes:
Request
@ -164,7 +161,6 @@ Gets default quotas for a tenant.
Normal response codes: 200
Error response codes:
Request

2
api-ref/source/v2/volume-manage.inc
View File

@ -23,7 +23,7 @@ or source-name element, if possible.
The API chooses the size of the volume by rounding up the size of
the existing storage volume to the next gibibyte (GiB).
Normal response codes: 202,
Normal response codes: 202
Request

5
api-ref/source/v2/volume-type-access.inc
View File

@ -20,7 +20,7 @@ Add private volume type access
Adds private volume type access to a project.
Normal response codes: 202,
Normal response codes: 202
Request
@ -46,7 +46,7 @@ Remove private volume type access
Removes private volume type access from a project.
Normal response codes: 202,
Normal response codes: 202
Request
@ -74,7 +74,6 @@ Lists project IDs that have access to private volume type.
Normal response codes: 200
Error response codes:
Request

2
api-ref/source/v2/volumes-v2-extensions.inc
View File

@ -14,7 +14,7 @@ List API extensions
Lists Block Storage API extensions.
Normal response codes: 200, 300
Normal response codes: 200
Request

2
api-ref/source/v2/volumes-v2-snapshots-actions.inc
View File

@ -14,7 +14,7 @@ Reset a snapshot's status
Resets the status. Specify the ``os-reset_status`` action in the request body.
Normal response codes: 202,
Normal response codes: 202
Request

11
api-ref/source/v2/volumes-v2-snapshots.inc
View File

@ -43,7 +43,6 @@ Lists all Block Storage snapshots, with details, that the tenant can access.
Normal response codes: 200
Error response codes:
Request
@ -84,7 +83,7 @@ Create snapshot
Creates a volume snapshot, which is a point-in-time, complete copy of a volume. You can create a volume from a snapshot.
Normal response codes: 202,
Normal response codes: 202
Request
@ -130,7 +129,6 @@ Lists all Block Storage snapshots, with summary information, that the tenant can
Normal response codes: 200
Error response codes:
Request
@ -176,7 +174,6 @@ Shows metadata for a snapshot.
Normal response codes: 200
Error response codes:
Request
@ -224,7 +221,6 @@ are not in the request.
Normal response codes: 200
Error response codes:
Request
@ -259,7 +255,6 @@ Replaces all the snapshot's metadata with the key-value pairs in the request.
Normal response codes: 200
Error response codes:
Request
@ -294,7 +289,6 @@ Shows details for a snapshot.
Normal response codes: 200
Error response codes:
Request
@ -339,7 +333,6 @@ Updates a snapshot.
Normal response codes: 200
Error response codes:
Request
@ -390,7 +383,7 @@ Delete snapshot
Deletes a snapshot.
Normal response codes: 202,
Normal response codes: 202
Request

11
api-ref/source/v2/volumes-v2-types.inc
View File

@ -26,7 +26,6 @@ guide/blockstorage_multi_backend.html>`_.
Normal response codes: 200
Error response codes:
Request
@ -73,7 +72,6 @@ Updates the extra specifications that are assigned to a volume type.
Normal response codes: 200
Error response codes:
Request
@ -122,7 +120,6 @@ Shows details for a volume type.
Normal response codes: 200
Error response codes:
Request
-------
@ -159,7 +156,7 @@ Delete volume type
Deletes a volume type.
Normal response codes: 202,
Normal response codes: 202
Request
@ -180,7 +177,6 @@ Lists volume types.
Normal response codes: 200
Error response codes:
Request
@ -235,7 +231,6 @@ guide/blockstorage_multi_backend.html>`_.
Normal response codes: 200
Error response codes:
Request
@ -281,7 +276,6 @@ Show an encryption type.
To show an encryption type for an existing volume type.
Normal response codes: 200
Error response codes:
Request
@ -327,7 +321,6 @@ Delete an encryption type.
To delete an encryption type for an existing volume type.
Normal response codes: 202
Error response codes:
Request
@ -349,7 +342,6 @@ Creates an encryption type.
To create an encryption type for an existing volume type.
Normal response codes: 200
Error response codes:
Request
@ -402,7 +394,6 @@ Update an encryption type.
To update an encryption type for an existing volume type.
Normal response codes: 200
Error response codes:
Request

27
api-ref/source/v2/volumes-v2-volumes-actions.inc
View File

@ -32,7 +32,7 @@ Troubleshooting
request. If the request fails again, investigate the storage back
end.
Normal response codes: 202,
Normal response codes: 202
Request
@ -64,7 +64,7 @@ Reset volume statuses
Administrator only. Resets the status, attach status, and migration status for a volume. Specify the ``os-reset_status`` action in the request body.
Normal response codes: 202,
Normal response codes: 202
Request
@ -86,11 +86,6 @@ Request Example
:language: javascript
Set image metadata for volume
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -118,11 +113,6 @@ Request Example
:language: javascript
Remove image metadata from volume
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -208,7 +198,7 @@ Preconditions
- You should set ``instance_uuid`` or ``host_name``.
Normal response codes: 202,
Normal response codes: 202
Request
@ -230,11 +220,6 @@ Request Example
:language: javascript
Detach volume from a server
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -246,7 +231,7 @@ Preconditions
- Volume status must be ``in-use``.
Normal response codes: 202,
Normal response codes: 202
Request
@ -285,7 +270,7 @@ Preconditions
- Volume status must be ``available``.
Normal response codes: 202,
Normal response codes: 202
Request
@ -319,7 +304,7 @@ Forces a volume to detach. Specify the ``os-force_detach`` action in the request
Rolls back an unsuccessful detach operation after you disconnect
the volume.
Normal response codes: 202,
Normal response codes: 202
Request

12
api-ref/source/v2/volumes-v2-volumes.inc
View File

@ -68,7 +68,6 @@ Lists all Block Storage volumes, with details, that the tenant can access.
Normal response codes: 200
Error response codes:
Request
@ -164,7 +163,7 @@ Troubleshooting
- The storage node needs enough free storage space to match the size
of the volume creation request.
Normal response codes: 202,
Normal response codes: 202
Request
@ -239,7 +238,6 @@ Lists summary information for all Block Storage volumes that the tenant can acce
Normal response codes: 200
Error response codes:
Request
@ -288,7 +286,6 @@ Preconditions
Normal response codes: 200
Error response codes:
Request
@ -354,7 +351,6 @@ Updates a volume.
Normal response codes: 200
Error response codes:
Request
@ -448,7 +444,7 @@ Troubleshooting
- The volume managed by OpenStack Block Storage is not deleted from
the storage system.
Normal response codes: 202,
Normal response codes: 202
Request
@ -473,7 +469,7 @@ Create volume metadata
Creates or replaces metadata for a volume. Does not modify items that are not
in the request.
Normal response codes: 202,
Normal response codes: 202
Request
@ -518,7 +514,6 @@ Shows metadata for a volume.
Normal response codes: 200
Error response codes:
Request
@ -557,7 +552,6 @@ Replaces all the volume's metadata with the key-value pairs in the request.
Normal response codes: 200
Error response codes:
Request

1
api-ref/source/v3/attachments.inc
View File

@ -268,6 +268,7 @@ Complete attachment
Complete an attachment for a cinder volume.
Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404)

8
api-ref/source/v3/ext-backups.inc
View File

@ -156,7 +156,7 @@ Delete a backup
Deletes a backup.
Normal response codes: 202,
Normal response codes: 202
Error response codes: Bad Request(400)
@ -179,7 +179,7 @@ Restores a Block Storage backup to an existing or new Block Storage volume.
You must specify either the UUID or name of the volume. If you
specify both the UUID and name, the UUID takes priority.
Normal response codes: 202,
Normal response codes: 202
Error response codes: Bad Request(400), Request Entity Too Large(413)
@ -224,7 +224,7 @@ Create a backup
Creates a Block Storage backup from a volume.
Normal response codes: 202,
Normal response codes: 202
Error response codes: Bad Request(400), Internal Server Error(500)
@ -356,6 +356,7 @@ Export information about a backup.
Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404)
@ -392,6 +393,7 @@ Import information about a backup.
Normal response codes: 201
Error response codes: badRequest(400), serviceUnavailable(503)

2
api-ref/source/v3/volumes-v3-extensions.inc
View File

@ -16,7 +16,7 @@ Lists Block Storage API extensions.
Normal response codes: 200
Error response codes:300,
Error response codes: 300
Request

2
api-ref/source/v3/volumes-v3-snapshots-actions.inc
View File

@ -14,7 +14,7 @@ Reset a snapshot's status
Resets the status. Specify the ``os-reset_status`` action in the request body.
Normal response codes: 202,
Normal response codes: 202
Request

9
api-ref/source/v3/volumes-v3-versions.inc
View File

@ -4,9 +4,6 @@ API versions
============
Show API v3 details
~~~~~~~~~~~~~~~~~~~
@ -17,14 +14,12 @@ Shows details for Block Storage API v3.
Normal response codes: 200
Error response codes:203,
Error response codes: 203
Request
-------
Response Parameters
-------------------
@ -32,8 +27,6 @@ Response Parameters
- location: location
Response Example
----------------