diff --git a/api-ref/source/status.yaml b/api-ref/source/status.yaml new file mode 100644 index 00000000000..7bc348c70bb --- /dev/null +++ b/api-ref/source/status.yaml @@ -0,0 +1,54 @@ + 200: + default: | + Request was successful. + 201: + default: | + Request has been fulfilled and new resource created. + 202: + default: | + Request is accepted, but processing may take some time. + 203: + default: | + Returned information is not full set, but a subset. + 204: + default: | + Request fulfilled but service does not return anything. + 300: + default: | + The resource corresponds to more than one representation. + 400: + default: | + Some content in the request was invalid. + 401: + default: | + User must authenticate before making a request. + 403: + default: | + Policy does not allow current user to do this operation. + 404: + default: | + The requested resource could not be found. + 405: + default: | + Method is not valid for this endpoint and resource. + 409: + default: | + This resource has an action in progress that would conflict with this request. + 413: + default: | + This operation cannot be completed. + 415: + default: | + The entity of the request is in a format not supported by the requested + resource for the method. + 500: + default: | + Something went wrong with the service which prevents it from fulfilling + the request. + 501: + default: | + The service does not have the functionality required to fulfill this + request. + 503: + default: | + The service cannot handle the request right now. diff --git a/api-ref/source/v2/api-versions.inc b/api-ref/source/v2/api-versions.inc index 7dbc4761a9b..e032dbf1919 100644 --- a/api-ref/source/v2/api-versions.inc +++ b/api-ref/source/v2/api-versions.inc @@ -7,14 +7,23 @@ List Api Versions Lists information for all Block Storage API versions. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200,300 +.. rest_status_code:: success ../status.yaml -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + - 200 + - 300 -Request -~~~~~~~ +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 + - 405 + - 500 + - 503 Response ~~~~~~~~ diff --git a/api-ref/source/v2/capabilities-v2.inc b/api-ref/source/v2/capabilities-v2.inc index c07742a0186..e33c766e7f3 100644 --- a/api-ref/source/v2/capabilities-v2.inc +++ b/api-ref/source/v2/capabilities-v2.inc @@ -14,8 +14,12 @@ Show back-end capabilities Shows capabilities for a storage back end on the host. The ``hostname`` takes the form of ``hostname@volume_backend_name``. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- diff --git a/api-ref/source/v2/consistencygroups-v2.inc b/api-ref/source/v2/consistencygroups-v2.inc index 86a9ab614b0..246ca128335 100644 --- a/api-ref/source/v2/consistencygroups-v2.inc +++ b/api-ref/source/v2/consistencygroups-v2.inc @@ -21,9 +21,12 @@ List consistency groups Lists consistency groups. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -60,8 +63,12 @@ Create consistency group Creates a consistency group. -Normal response codes: 202, +Response codes +~~~~~~~~~~~~~~ +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- @@ -106,7 +113,12 @@ Show consistency group details Shows details for a consistency group. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -143,8 +155,12 @@ Create consistency group from source Creates a consistency group from source. -Normal response codes: 202, +Response codes +~~~~~~~~~~~~~~ +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- @@ -174,7 +190,12 @@ Delete consistency group Deletes a consistency group. -Normal response codes: 202, +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -200,9 +221,12 @@ List consistency groups with details Lists consistency groups with details. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -244,8 +268,12 @@ Update consistency group Updates a consistency group. -Normal response codes: 202, +Response codes +~~~~~~~~~~~~~~ +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- diff --git a/api-ref/source/v2/ext-backups-actions-v2.inc b/api-ref/source/v2/ext-backups-actions-v2.inc index 969c7a6e459..76a9bbf703c 100644 --- a/api-ref/source/v2/ext-backups-actions-v2.inc +++ b/api-ref/source/v2/ext-backups-actions-v2.inc @@ -18,10 +18,17 @@ This operations deletes the backup and any backup data. The backup driver returns the ``405`` status code if it does not support this operation. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404), badMethod(405) +.. rest_status_code:: success ../status.yaml + - 202 + +.. rest_status_code:: error ../status.yaml + + - 404 + - 405 Request ------- @@ -47,10 +54,17 @@ Reset backup's status Reset a backup's status. Specify the ``os-reset_status`` action in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request ------- diff --git a/api-ref/source/v2/ext-backups.inc b/api-ref/source/v2/ext-backups.inc index 4263c65cff3..4bb17b4e95a 100644 --- a/api-ref/source/v2/ext-backups.inc +++ b/api-ref/source/v2/ext-backups.inc @@ -44,9 +44,12 @@ List backups with details Lists Block Storage backups, with details, to which the project has access. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -99,9 +102,12 @@ Show backup details Shows details for a backup. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -150,12 +156,16 @@ Delete backup Deletes a backup. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: Bad Request(400) +.. rest_status_code:: success ../status.yaml + - 202 +.. rest_status_code:: error ../status.yaml + - 400 Request ------- @@ -176,10 +186,17 @@ 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 +Response codes +~~~~~~~~~~~~~~ -Error response codes: Bad Request(400), Request Entity Too Large(413) +.. rest_status_code:: success ../status.yaml + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 413 Request ------- @@ -221,9 +238,17 @@ Create backup Creates a Block Storage backup from a volume. -Normal response codes: 202, +Response codes +~~~~~~~~~~~~~~ -Error response codes: Bad Request(400), Internal Server Error(500) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 500 Request ------- @@ -263,7 +288,12 @@ List backups Lists Block Storage backups to which the project has access. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -301,11 +331,17 @@ Export backup Export information about a backup. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400), itemNotFound(404) + - 200 +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request ------- @@ -338,11 +374,17 @@ Import backup Import information about a backup. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 201 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400), serviceUnavailable(503) + - 201 +.. rest_status_code:: error ../status.yaml + + - 400 + - 503 Request ------- diff --git a/api-ref/source/v2/hosts.inc b/api-ref/source/v2/hosts.inc index a68fa4f0061..12c86288acd 100644 --- a/api-ref/source/v2/hosts.inc +++ b/api-ref/source/v2/hosts.inc @@ -15,9 +15,18 @@ List all hosts Lists all hosts summary info that is not disabled. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 Request ------- @@ -56,9 +65,19 @@ Shows volume and snapshot details for a cinder-volume host. It is not valid against other Cinder service hosts or hosts where the cinder-volume service has been disabled. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 Request ------- diff --git a/api-ref/source/v2/limits.inc b/api-ref/source/v2/limits.inc index 7503d434a02..a143e473891 100644 --- a/api-ref/source/v2/limits.inc +++ b/api-ref/source/v2/limits.inc @@ -19,10 +19,16 @@ Shows absolute limits for a project. An absolute limit value of ``-1`` indicates that the absolute limit for the item is infinite. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: forbidden(403) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 Request ------- diff --git a/api-ref/source/v2/os-cgsnapshots-v2.inc b/api-ref/source/v2/os-cgsnapshots-v2.inc index 7d136f65c10..06ee6d60cdc 100644 --- a/api-ref/source/v2/os-cgsnapshots-v2.inc +++ b/api-ref/source/v2/os-cgsnapshots-v2.inc @@ -14,8 +14,12 @@ Delete consistency group snapshot Deletes a consistency group snapshot. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- @@ -33,9 +37,12 @@ Show consistency group snapshot details Shows details for a consistency group snapshot. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -72,8 +79,12 @@ List consistency group snapshots with details Lists all consistency group snapshots with details. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -109,9 +120,12 @@ List consistency group snapshots Lists all consistency group snapshots. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -139,8 +153,6 @@ Response Example :language: javascript - - Create consistency group snapshot ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -148,7 +160,12 @@ Create consistency group snapshot Creates a consistency group snapshot. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- diff --git a/api-ref/source/v2/os-vol-pool-v2.inc b/api-ref/source/v2/os-vol-pool-v2.inc index 8f2a83c0d7a..21f7da1564e 100644 --- a/api-ref/source/v2/os-vol-pool-v2.inc +++ b/api-ref/source/v2/os-vol-pool-v2.inc @@ -14,8 +14,12 @@ List back-end storage pools Lists all back-end storage pools. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- diff --git a/api-ref/source/v2/os-vol-transfer-v2.inc b/api-ref/source/v2/os-vol-transfer-v2.inc index 77599637e56..ba6930b802a 100644 --- a/api-ref/source/v2/os-vol-transfer-v2.inc +++ b/api-ref/source/v2/os-vol-transfer-v2.inc @@ -13,7 +13,12 @@ Accept volume transfer Accepts a volume transfer. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -55,8 +60,12 @@ Create volume transfer Creates a volume transfer. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- @@ -100,9 +109,12 @@ List volume transfers Lists volume transfers. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -138,9 +150,12 @@ Show volume transfer details Shows details for a volume transfer. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -177,8 +192,12 @@ Delete volume transfer Deletes a volume transfer. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- @@ -196,8 +215,12 @@ List volume transfers, with details Lists volume transfers, with details. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- diff --git a/api-ref/source/v2/qos-specs-v2-qos-specs.inc b/api-ref/source/v2/qos-specs-v2-qos-specs.inc index 64514c19087..2bf1dd6d400 100644 --- a/api-ref/source/v2/qos-specs-v2-qos-specs.inc +++ b/api-ref/source/v2/qos-specs-v2-qos-specs.inc @@ -17,7 +17,12 @@ Disassociate QoS specification from all associations Disassociates a QoS specification from all associations. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -36,8 +41,12 @@ Unset keys in QoS specification Unsets keys in a QoS specification. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -72,7 +81,12 @@ Get all associations for QoS specification Lists all associations for a QoS specification. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -98,7 +112,12 @@ Associate QoS specification with volume type Associates a QoS specification with a volume type. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -118,7 +137,12 @@ Disassociate QoS specification from volume type Disassociates a QoS specification from a volume type. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -138,13 +162,22 @@ Show QoS specification details Shows details for a QoS specification. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: Request Entity Too Large(413), badMethod(405), -itemNotFound(404), forbidden(403), unauthorized(401), badRequest(400), -serviceUnavailable(503) + - 200 +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 + - 405 + - 413 + - 503 Request ------- @@ -182,9 +215,12 @@ Set keys in QoS specification Sets keys in a QoS specification. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + - 200 Request ------- @@ -217,7 +253,12 @@ Delete QoS specification Deletes a QoS specification. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -239,7 +280,12 @@ Creates a QoS specification. Specify one or more key and value pairs in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -281,7 +327,12 @@ List QoS specs Lists quality of service (QoS) specifications. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v2/quota-classes.inc b/api-ref/source/v2/quota-classes.inc index 6a13272d822..584a0b8886a 100644 --- a/api-ref/source/v2/quota-classes.inc +++ b/api-ref/source/v2/quota-classes.inc @@ -15,10 +15,17 @@ Show quota classes Shows quota class set for a project. If no specific value for the quota class resource exists, then the default value will be reported. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 + - 404 Request ------- @@ -58,9 +65,18 @@ Update quota classes Updates quota class set for a project. If the ``quota_class_name`` key does not exist, then the API will create one. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 403 + - 404 Request diff --git a/api-ref/source/v2/quota-sets.inc b/api-ref/source/v2/quota-sets.inc index d3947b2dbec..5fa55ea7ddb 100644 --- a/api-ref/source/v2/quota-sets.inc +++ b/api-ref/source/v2/quota-sets.inc @@ -14,8 +14,12 @@ Show quotas Shows quotas for a project. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -64,8 +68,12 @@ Update quotas Updates quotas for a project. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -133,8 +141,12 @@ Delete quotas Deletes quotas for a project so the quotas revert to default values. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -159,7 +171,12 @@ Get default quotas Gets default quotas for a project. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v2/volume-manage.inc b/api-ref/source/v2/volume-manage.inc index 59ffc333f77..3d06ffcaa1a 100644 --- a/api-ref/source/v2/volume-manage.inc +++ b/api-ref/source/v2/volume-manage.inc @@ -23,7 +23,12 @@ 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 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request diff --git a/api-ref/source/v2/volume-type-access.inc b/api-ref/source/v2/volume-type-access.inc index c2426272527..488c2733fb8 100644 --- a/api-ref/source/v2/volume-type-access.inc +++ b/api-ref/source/v2/volume-type-access.inc @@ -20,7 +20,12 @@ Add private volume type access Adds private volume type access to a project. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -46,7 +51,12 @@ Remove private volume type access Removes private volume type access from a project. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -72,8 +82,12 @@ List private volume type access details Lists project IDs that have access to private volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v2/volumes-v2-extensions.inc b/api-ref/source/v2/volumes-v2-extensions.inc index 89a9178268f..f220deb8257 100644 --- a/api-ref/source/v2/volumes-v2-extensions.inc +++ b/api-ref/source/v2/volumes-v2-extensions.inc @@ -13,8 +13,12 @@ List API extensions Lists Block Storage API extensions. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v2/volumes-v2-snapshots-actions.inc b/api-ref/source/v2/volumes-v2-snapshots-actions.inc index 789b3825bae..bb5157dbad0 100644 --- a/api-ref/source/v2/volumes-v2-snapshots-actions.inc +++ b/api-ref/source/v2/volumes-v2-snapshots-actions.inc @@ -14,7 +14,12 @@ Reset a snapshot's status Resets the status. Specify the ``os-reset_status`` action in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request diff --git a/api-ref/source/v2/volumes-v2-snapshots.inc b/api-ref/source/v2/volumes-v2-snapshots.inc index 2d888bd20da..45672af3ad6 100644 --- a/api-ref/source/v2/volumes-v2-snapshots.inc +++ b/api-ref/source/v2/volumes-v2-snapshots.inc @@ -42,7 +42,12 @@ List snapshots with details Lists all Block Storage snapshots, with details, that the project can access. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -84,7 +89,12 @@ 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 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -128,8 +138,12 @@ List snapshots Lists all Block Storage snapshots, with summary information, that the project can access. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -174,8 +188,12 @@ Show snapshot metadata Shows metadata for a snapshot. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -222,7 +240,12 @@ Creates or replaces metadata items that match keys. Does not modify items that are not in the request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -256,7 +279,12 @@ Update snapshot metadata Replaces all the snapshot's metadata with the key-value pairs in the request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -290,7 +318,12 @@ Show snapshot details Shows details for a snapshot. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -334,7 +367,12 @@ Update snapshot Updates a snapshot. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -385,7 +423,12 @@ Delete snapshot Deletes a snapshot. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request diff --git a/api-ref/source/v2/volumes-v2-types.inc b/api-ref/source/v2/volumes-v2-types.inc index 5bb361f38bd..aa22ba957ef 100644 --- a/api-ref/source/v2/volumes-v2-types.inc +++ b/api-ref/source/v2/volumes-v2-types.inc @@ -25,7 +25,12 @@ storage back ends, see `Configure multiple-storage back ends blockstorage-multi-backend.html>`_. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -71,7 +76,12 @@ Update extra specs for a volume type Updates the extra specifications that are assigned to a volume type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -119,7 +129,12 @@ Show volume type details for v2 Shows details for a volume type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -156,7 +171,12 @@ Delete volume type Deletes a volume type. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -176,7 +196,12 @@ List all volume types for v2 Lists volume types. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -230,7 +255,12 @@ storage back ends, see `Configure multiple-storage back ends blockstorage-multi-backend.html>`_. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -275,7 +305,13 @@ Show an encryption type. To show an encryption type for an existing volume type. -Normal response codes: 200 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -320,7 +356,12 @@ Delete an encryption type. To delete an encryption type for an existing volume type. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -341,7 +382,13 @@ Creates an encryption type. To create an encryption type for an existing volume type. -Normal response codes: 200 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -393,7 +440,13 @@ Update an encryption type. To update an encryption type for an existing volume type. -Normal response codes: 200 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v2/volumes-v2-versions.inc b/api-ref/source/v2/volumes-v2-versions.inc index d47bd5f6017..4b53774a9bb 100644 --- a/api-ref/source/v2/volumes-v2-versions.inc +++ b/api-ref/source/v2/volumes-v2-versions.inc @@ -14,7 +14,12 @@ Show API v2 details Shows details for Block Storage API v2. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v2/volumes-v2-volumes-actions.inc b/api-ref/source/v2/volumes-v2-volumes-actions.inc index 5aa78540573..d10a13f03a3 100644 --- a/api-ref/source/v2/volumes-v2-volumes-actions.inc +++ b/api-ref/source/v2/volumes-v2-volumes-actions.inc @@ -32,7 +32,13 @@ Troubleshooting request. If the request fails again, investigate the storage back end. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -52,11 +58,6 @@ Request Example :language: javascript - - - - - Reset volume statuses ~~~~~~~~~~~~~~~~~~~~~ @@ -64,7 +65,13 @@ 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 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -93,7 +100,12 @@ Set image metadata for volume Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -120,7 +132,13 @@ Remove image metadata from volume Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove. -Normal response codes: 200 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -140,9 +158,6 @@ Request Example :language: javascript - - - Show image metadata for volume ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -150,7 +165,12 @@ Show image metadata for volume Shows image metadata for a volume. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -184,7 +204,6 @@ Response Example - Attach volume to server ~~~~~~~~~~~~~~~~~~~~~~~ @@ -198,7 +217,12 @@ Preconditions - You should set ``instance_uuid`` or ``host_name``. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -231,7 +255,12 @@ Preconditions - Volume status must be ``in-use``. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -252,13 +281,6 @@ Request Example - - - - - - - Unmanage volume ~~~~~~~~~~~~~~~ @@ -270,7 +292,12 @@ Preconditions - Volume status must be ``available``. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -290,10 +317,6 @@ Request Example - - - - Force detach volume ~~~~~~~~~~~~~~~~~~~ @@ -309,7 +332,13 @@ perform this operation. Cloud providers can change these permissions through the ``volume_extension:volume_admin_actions:force_detach`` rule in the ``policy.json`` file. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -331,10 +360,6 @@ Request Example - - - - Retype volume ~~~~~~~~~~~~~ @@ -354,7 +379,12 @@ Policy defaults enable only users with the administrative role or the owner of the volume to perform this operation. Cloud providers can change these permissions through the policy.json file. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -375,11 +405,6 @@ Request Example :language: javascript - - - - - Force delete volume ~~~~~~~~~~~~~~~~~~~ @@ -388,8 +413,12 @@ Force delete volume Attempts force-delete of volume, regardless of state. Specify the ``os-force_delete`` action in the request body. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 202 +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -408,11 +437,6 @@ Request Example :language: javascript - - - - - Update volume bootable status ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -420,7 +444,13 @@ Update volume bootable status Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body. -Normal response codes: 200 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v2/volumes-v2-volumes.inc b/api-ref/source/v2/volumes-v2-volumes.inc index c7bf50841e2..fb0af63a151 100644 --- a/api-ref/source/v2/volumes-v2-volumes.inc +++ b/api-ref/source/v2/volumes-v2-volumes.inc @@ -66,8 +66,12 @@ List volumes with details Lists all Block Storage volumes, with details, that the project can access. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -128,7 +132,6 @@ Response Example - Create volume ~~~~~~~~~~~~~ @@ -165,7 +168,12 @@ Troubleshooting - The storage node needs enough free storage space to match the size of the volume creation request. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -239,7 +247,12 @@ List volumes Lists summary information for all Block Storage volumes that the project can access. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -287,8 +300,12 @@ Preconditions - The volume must exist. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -354,7 +371,12 @@ Update volume Updates a volume. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -406,7 +428,6 @@ Response Parameters - volume_type: volume_type - Response Example ---------------- @@ -414,8 +435,6 @@ Response Example :language: javascript - - Delete volume ~~~~~~~~~~~~~ @@ -448,7 +467,13 @@ Troubleshooting - The volume managed by OpenStack Block Storage is not deleted from the storage system. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -462,9 +487,6 @@ Request - - - Create volume metadata ~~~~~~~~~~~~~~~~~~~~~~ @@ -473,7 +495,12 @@ Create volume metadata Creates or replaces metadata for a volume. Does not modify items that are not in the request. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -517,7 +544,12 @@ Show volume metadata Shows metadata for a volume. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -554,8 +586,12 @@ Update volume metadata Replaces all the volume's metadata with the key-value pairs in the request. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -599,7 +635,12 @@ Show volume metadata for a specific key Shows metadata for a volume for a specific key. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -620,7 +661,6 @@ Response Parameters - metadata: metadata_3 - Response Example ---------------- @@ -628,8 +668,6 @@ Response Example :language: javascript - - Delete volume metadata ~~~~~~~~~~~~~~~~~~~~~~ @@ -637,7 +675,12 @@ Delete volume metadata Deletes metadata for a volume. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -650,8 +693,6 @@ Request - key: key_1 - - Update volume metadata for a specific key ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -659,7 +700,12 @@ Update volume metadata for a specific key Update metadata for a volume for a specific key. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/api-versions.inc b/api-ref/source/v3/api-versions.inc index 41ec0e8a073..1f7034a8bdd 100644 --- a/api-ref/source/v3/api-versions.inc +++ b/api-ref/source/v3/api-versions.inc @@ -7,11 +7,23 @@ List All Api Versions Lists information for all Block Storage API versions. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 300 +.. rest_status_code:: success ../status.yaml -Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), -unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), conflict(409) + - 300 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 405 + - 404 + - 409 + - 500 + - 503 Request ~~~~~~~ diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index 97435dbd3c3..2401d096426 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -20,9 +20,17 @@ Deletes an attachment. Available starting in the 3.27 microversion. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -43,9 +51,17 @@ Shows details for an attachment. Available starting in the 3.27 microversion. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -88,9 +104,16 @@ users specify invalid filters in the url, API will return bad request. Available starting in the 3.27 microversion. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request ------- @@ -135,9 +158,16 @@ specify invalid filters in the url, API will return bad request. Available starting in the 3.27 microversion. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -180,9 +210,17 @@ Creates an attachment. Available starting in the 3.27 microversion. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -234,9 +272,17 @@ and set up the appropriate connection_info from the driver. Available starting in the 3.27 microversion. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request ------- @@ -285,9 +331,17 @@ Complete an attachment for a cinder volume. Available starting in the 3.44 microversion. -Normal response codes: 204 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 204 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request diff --git a/api-ref/source/v3/capabilities-v3.inc b/api-ref/source/v3/capabilities-v3.inc index ab10fa360fe..b51f47adf15 100644 --- a/api-ref/source/v3/capabilities-v3.inc +++ b/api-ref/source/v3/capabilities-v3.inc @@ -14,7 +14,12 @@ Show all back-end capabilities Shows capabilities for a storage back end on the host. The ``hostname`` takes the form of ``hostname@volume_backend_name``. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- diff --git a/api-ref/source/v3/consistencygroups-v3.inc b/api-ref/source/v3/consistencygroups-v3.inc index 6e5ee4180df..4b77622e040 100644 --- a/api-ref/source/v3/consistencygroups-v3.inc +++ b/api-ref/source/v3/consistencygroups-v3.inc @@ -22,7 +22,12 @@ List project's consistency groups Lists consistency groups. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -60,7 +65,12 @@ Create a consistency group Creates a consistency group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -108,7 +118,12 @@ Show a consistency group's details Shows details for a consistency group. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -145,7 +160,13 @@ Create a consistency group from source Creates a consistency group from source. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -177,7 +198,12 @@ Delete a consistency group Deletes a consistency group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -205,7 +231,12 @@ List consistency groups and details Lists consistency groups with details. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -248,7 +279,13 @@ Update a consistency group Updates a consistency group. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request diff --git a/api-ref/source/v3/ext-backups-actions-v3.inc b/api-ref/source/v3/ext-backups-actions-v3.inc index fd357e9b8c0..0a5ce8f95bf 100644 --- a/api-ref/source/v3/ext-backups-actions-v3.inc +++ b/api-ref/source/v3/ext-backups-actions-v3.inc @@ -19,9 +19,17 @@ This operations deletes the backup and any backup data. The backup driver returns the ``405`` status code if it does not support this operation. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404), badMethod(405) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 404 + - 405 Request ------- @@ -48,9 +56,17 @@ Reset a backup's status Reset a backup's status. Specify the ``os-reset_status`` action in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index 05a8305e159..98808274643 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -47,9 +47,16 @@ since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -106,8 +113,12 @@ Show backup detail Shows details for a backup. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -159,9 +170,16 @@ Delete a backup Deletes a backup. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: Bad Request(400) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 Request ------- @@ -188,9 +206,17 @@ new volume matching the size and name of the originally backed up volume. In this case, if the name parameter is provided, it will be used as the name of the new volume. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: Bad Request(400), Request Entity Too Large(413) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 413 Request @@ -233,9 +259,17 @@ Create a backup Creates a Block Storage backup from a volume. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: Bad Request(400), Internal Server Error(500) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 500 Request ------- @@ -277,9 +311,16 @@ Update a backup Update a Block Storage backup. This API is available since v3.9. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: Bad Request(400) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 Request ------- @@ -325,9 +366,16 @@ Lists Block Storage backups to which the project has access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request ------- @@ -367,9 +415,17 @@ Export a backup Export information about a backup. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -404,9 +460,17 @@ Import a backup Import information about a backup. -Normal response codes: 201 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), serviceUnavailable(503) +.. rest_status_code:: success ../status.yaml + + - 201 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 503 Request diff --git a/api-ref/source/v3/group-replication.inc b/api-ref/source/v3/group-replication.inc index 6bedfd96816..1aaa064d288 100644 --- a/api-ref/source/v3/group-replication.inc +++ b/api-ref/source/v3/group-replication.inc @@ -15,9 +15,17 @@ List replication targets Lists replication targets for a group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -57,9 +65,17 @@ Enable group replication Enable replication for a group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request ------- @@ -82,9 +98,17 @@ Disable group replication Disable replication for a group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request ------- @@ -107,9 +131,17 @@ Failover replication Failover a replicated group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request ------- diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index 70f01e01338..51193ce0f85 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -14,9 +14,18 @@ Delete group snapshot Deletes a group snapshot. -Normal response codes: 202 -Error response codes: badRequest(400), itemNotFound(404) +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -36,9 +45,17 @@ Show group snapshot details Shows details for a group snapshot. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -80,9 +97,16 @@ Lists all group snapshots with details. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request ------- @@ -127,9 +151,16 @@ Lists all group snapshots, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -170,9 +201,17 @@ Create group snapshot Creates a group snapshot. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -216,9 +255,17 @@ Reset group snapshot status Resets the status for a group snapshot. Specifies the ``reset_status`` action in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request diff --git a/api-ref/source/v3/group-type-specs.inc b/api-ref/source/v3/group-type-specs.inc index 11d6ecdbaac..b151ec58106 100644 --- a/api-ref/source/v3/group-type-specs.inc +++ b/api-ref/source/v3/group-type-specs.inc @@ -11,10 +11,18 @@ Create or update group specs for a group type Create group specs for a group type, if the specification key already exists in group specs, this API will update the specification as well. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 202 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400), forbidden(403), itemNotFound(404) + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 403 + - 404 Request @@ -57,9 +65,17 @@ List group specs for a group type List all the group specs for a group type, -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 + - 404 Request @@ -94,9 +110,17 @@ Show one specific group spec for a group type Show a group spec for a group type, -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 + - 404 Request @@ -131,9 +155,17 @@ Update one specific group spec for a group type Update a group spec for a group type, -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 + - 404 Request @@ -174,9 +206,17 @@ Delete one specific group spec for a group type Delete a group spec for a group type, -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 403 + - 404 Request diff --git a/api-ref/source/v3/group-types.inc b/api-ref/source/v3/group-types.inc index 9b6a2198130..5a380fd66f6 100644 --- a/api-ref/source/v3/group-types.inc +++ b/api-ref/source/v3/group-types.inc @@ -13,10 +13,20 @@ Update group type Updates a group type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), forbidden(403), itemNotFound(404), -conflict(409), computeFault(500) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 403 + - 404 + - 409 + - 500 Request @@ -64,10 +74,16 @@ Show group type details Shows details for a group type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: itemNotFound(404) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 404 Request ------- @@ -106,9 +122,16 @@ Show default group type details Shows details for the default group type if configured. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 404 Request ------- @@ -145,9 +168,18 @@ Delete group type Deletes a group type. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 403 + - 404 Request @@ -166,8 +198,12 @@ List group types Lists group types. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -206,11 +242,19 @@ Create group type Creates a group type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 202 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400), forbidden(403), itemNotFound(404), -conflict(409) + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 403 + - 404 + - 409 Request diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index 79ed7a8bc74..d8e1c7dec14 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -25,10 +25,16 @@ List groups Lists groups. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -67,9 +73,17 @@ Create group Creates a group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -99,9 +113,16 @@ Show group details Shows details for a group. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 404 Request ------- @@ -143,9 +164,18 @@ Create group from source Creates a group from source. -Normal response codes: 202 -Error response codes: badRequest(400), itemNotFound(404) +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -174,9 +204,17 @@ Delete group Deletes a group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -205,9 +243,16 @@ Lists groups with details, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -254,9 +299,17 @@ Update group Updates a group. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -286,9 +339,17 @@ Reset group status Resets the status for a group. Specify the ``reset_status`` action in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request diff --git a/api-ref/source/v3/hosts.inc b/api-ref/source/v3/hosts.inc index 3e4b2a93082..0a8d26fc236 100644 --- a/api-ref/source/v3/hosts.inc +++ b/api-ref/source/v3/hosts.inc @@ -15,9 +15,18 @@ List all hosts for a project Lists all hosts summary info that is not disabled. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 Request ------- @@ -57,9 +66,19 @@ Shows volume and snapshot details for a cinder-volume host. It is not valid against other Cinder service hosts or hosts where the cinder-volume service has been disabled. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 Request ------- diff --git a/api-ref/source/v3/limits.inc b/api-ref/source/v3/limits.inc index 0e6909e9fbf..8aa0813b3f9 100644 --- a/api-ref/source/v3/limits.inc +++ b/api-ref/source/v3/limits.inc @@ -19,10 +19,16 @@ Shows absolute limits for a project. An absolute limit value of ``-1`` indicates that the absolute limit for the item is infinite. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: forbidden(403) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 Request ------- diff --git a/api-ref/source/v3/messages.inc b/api-ref/source/v3/messages.inc index 956dd25f551..5424f327a1b 100644 --- a/api-ref/source/v3/messages.inc +++ b/api-ref/source/v3/messages.inc @@ -13,9 +13,17 @@ Delete message Deletes a message. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -35,9 +43,17 @@ Show message details Shows details for a message. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 404 Request @@ -82,9 +98,16 @@ Lists all messages, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request diff --git a/api-ref/source/v3/os-cgsnapshots-v3.inc b/api-ref/source/v3/os-cgsnapshots-v3.inc index 9875a4eafd1..029eb8a2ad3 100644 --- a/api-ref/source/v3/os-cgsnapshots-v3.inc +++ b/api-ref/source/v3/os-cgsnapshots-v3.inc @@ -14,7 +14,12 @@ Delete a consistency group snapshot Deletes a consistency group snapshot. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -33,8 +38,12 @@ Show consistency group snapshot detail Shows details for a consistency group snapshot. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -73,8 +82,12 @@ List all consistency group snapshots with details Lists all consistency group snapshots with details. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -112,7 +125,12 @@ List all consistency group snapshots Lists all consistency group snapshots. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -151,7 +169,12 @@ Create a consistency group snapshot Creates a consistency group snapshot. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request ------- diff --git a/api-ref/source/v3/os-services.inc b/api-ref/source/v3/os-services.inc index 47fa81d4694..7fdf9c2bbd6 100644 --- a/api-ref/source/v3/os-services.inc +++ b/api-ref/source/v3/os-services.inc @@ -16,9 +16,18 @@ List All Cinder Services Lists all Cinder services. Provides details why any services were disabled. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 Request ------- @@ -62,9 +71,19 @@ Disable a Cinder Service Disables a Cinder service. Specify the service by its host name and binary name. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 Request ------- @@ -108,9 +127,19 @@ Logs information to the Cinder service table about why a Cinder service was disa Specify the service by its host name and binary name. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 Request ------- @@ -155,9 +184,19 @@ Enable a Cinder Service Enables a Cinder service. Specify the service by its host name and binary name. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 Request ------- @@ -201,9 +240,18 @@ Get Current Log Levels for Cinder Services Get current log levels for services, supported since v3.32. Filter the services by binary, server name and prefix for the log path. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 Request ------- @@ -246,9 +294,18 @@ Set Log Levels of Cinder Services Dynamically Set log levels of services dynamically, supported since v3.32. Filter the services by binary, server name and prefix for the log path. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 Request ------- @@ -276,9 +333,18 @@ Freeze a Cinder Backend Host Freeze and disable the specified cinder-volume host, and set ``Disabled Reason`` of Cinder service table to ``frozen``. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 Request ------- @@ -303,9 +369,18 @@ Thaw a Cinder Backend Host Thaw and enable the specified cinder-volume host, and clean ``Disabled Reason`` of Cinder service table. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 Request ------- @@ -331,10 +406,19 @@ Failover a replicating cinder-volume host. Since Cinder Volume API Version 3.26, you can use ``failover`` in request URL instead of ``failover_host``, and the cluster name in request body is supported. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), unauthorized(401), forbidden(403), -itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 Request ------- diff --git a/api-ref/source/v3/os-vol-pool-v3.inc b/api-ref/source/v3/os-vol-pool-v3.inc index aaffd190c2f..c526266aa60 100644 --- a/api-ref/source/v3/os-vol-pool-v3.inc +++ b/api-ref/source/v3/os-vol-pool-v3.inc @@ -16,9 +16,16 @@ Lists all back-end storage pools. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request ------- diff --git a/api-ref/source/v3/os-vol-transfer-v3.inc b/api-ref/source/v3/os-vol-transfer-v3.inc index 1ee49d7c714..2f0edddfa61 100644 --- a/api-ref/source/v3/os-vol-transfer-v3.inc +++ b/api-ref/source/v3/os-vol-transfer-v3.inc @@ -13,7 +13,12 @@ Accept a volume transfer Accepts a volume transfer. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -55,7 +60,12 @@ Create a volume transfer Creates a volume transfer. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -101,8 +111,12 @@ List volume transfers for a project Lists volume transfers. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -139,8 +153,12 @@ Show volume transfer detail Shows details for a volume transfer. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -178,7 +196,12 @@ Delete a volume transfer Deletes a volume transfer. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -197,8 +220,12 @@ List volume transfers and details Lists volume transfers, with details. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- diff --git a/api-ref/source/v3/qos-specs-v3-qos-specs.inc b/api-ref/source/v3/qos-specs-v3-qos-specs.inc index a765c049ca8..265d924414e 100644 --- a/api-ref/source/v3/qos-specs-v3-qos-specs.inc +++ b/api-ref/source/v3/qos-specs-v3-qos-specs.inc @@ -17,7 +17,12 @@ Disassociate a QoS specification from all associations Disassociates a QoS specification from all associations. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -36,8 +41,12 @@ Unset keys in a QoS specification Unsets keys in a QoS specification. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -64,7 +73,12 @@ Get all associations for a QoS specification Lists all associations for a QoS specification. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -103,7 +117,13 @@ Associate QoS specification with a volume type Associates a QoS specification with a volume type. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -123,7 +143,13 @@ Disassociate QoS specification from a volume type Disassociates a QoS specification from a volume type. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -143,12 +169,22 @@ Show a QoS specification details Shows details for a QoS specification. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: Request Entity Too Large(413), badMethod(405), -itemNotFound(404), forbidden(403), unauthorized(401), badRequest(400), -serviceUnavailable(503) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 401 + - 403 + - 404 + - 405 + - 413 + - 503 Request @@ -187,8 +223,12 @@ Set keys in a QoS specification Sets keys in a QoS specification. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -228,7 +268,12 @@ Delete a QoS specification Deletes a QoS specification. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -250,7 +295,13 @@ Creates a QoS specification. Specify one or more key and value pairs in the request body. -Normal response codes: 202 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -269,7 +320,6 @@ Request Example :language: javascript - Response Parameters ------------------- @@ -291,9 +341,16 @@ List QoS Specifications Lists quality of service (QoS) specifications. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: 300 +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 300 Request diff --git a/api-ref/source/v3/quota-classes.inc b/api-ref/source/v3/quota-classes.inc index 914ad45cb2b..37da6cd4242 100644 --- a/api-ref/source/v3/quota-classes.inc +++ b/api-ref/source/v3/quota-classes.inc @@ -15,9 +15,17 @@ Show quota classes for a project Shows quota class set for a project. If no specific value for the quota class resource exists, then the default value will be reported. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 + - 404 Request @@ -59,9 +67,18 @@ Update quota classes for a project Updates quota class set for a project. If the ``quota_class_name`` key does not exist, then the API will create one. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400), forbidden(403), itemNotFound(404) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 403 + - 404 Request diff --git a/api-ref/source/v3/quota-sets.inc b/api-ref/source/v3/quota-sets.inc index 467a651ef9b..feebee67901 100644 --- a/api-ref/source/v3/quota-sets.inc +++ b/api-ref/source/v3/quota-sets.inc @@ -16,7 +16,12 @@ Show quotas for a project Shows quotas for a project. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -61,8 +66,12 @@ Show quota usage for a project Shows quota usage for a project. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -109,7 +118,12 @@ Update quotas for a project Updates quotas for a project. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -168,8 +182,12 @@ Delete quotas for a project Deletes quotas for a project so the quotas revert to default values. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -190,8 +208,12 @@ Get default quotas for a project Gets default quotas for a project. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -236,9 +258,16 @@ Validate setup for nested quota Validate setup for nested quota, administrator should ensure that Keystone v3 or greater is being used. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request diff --git a/api-ref/source/v3/resource-filters.inc b/api-ref/source/v3/resource-filters.inc index f3e117d39c3..e8e1774dc3b 100644 --- a/api-ref/source/v3/resource-filters.inc +++ b/api-ref/source/v3/resource-filters.inc @@ -14,7 +14,12 @@ List resource filters List filters. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/snapshot-manage.inc b/api-ref/source/v3/snapshot-manage.inc index 64f568a8f39..14e16a2174c 100644 --- a/api-ref/source/v3/snapshot-manage.inc +++ b/api-ref/source/v3/snapshot-manage.inc @@ -25,7 +25,12 @@ The API chooses the size of the snapshot by rounding up the size of the existing snapshot to the next gibibyte (GiB). -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -57,7 +62,12 @@ List summary of snapshots available to manage Search a volume backend and list summary of snapshots which are available to manage. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -102,7 +112,13 @@ List detail of snapshots available to manage Search a volume backend and list detail of snapshots which are available to manage. -Normal response codes: 200 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/volume-manage.inc b/api-ref/source/v3/volume-manage.inc index 7ce8253d0a6..76d9ab364d1 100644 --- a/api-ref/source/v3/volume-manage.inc +++ b/api-ref/source/v3/volume-manage.inc @@ -28,7 +28,12 @@ Prior to microversion 3.16 host field was required, with the possibility of defining the cluster it is no longer required, but we must have either a host or a cluster field but we cannot have them both with values. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -66,7 +71,12 @@ List summary of volumes available to manage Search a volume backend and list summary of volumes which are available to manage. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -110,7 +120,12 @@ List detail of volumes available to manage Search a volume backend and list detail of volumes which are available to manage. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/volume-type-access.inc b/api-ref/source/v3/volume-type-access.inc index ed890048a2e..1a24a9ceda6 100644 --- a/api-ref/source/v3/volume-type-access.inc +++ b/api-ref/source/v3/volume-type-access.inc @@ -20,7 +20,12 @@ Add private volume type access to project Adds private volume type access to a project. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -46,7 +51,12 @@ Remove private volume type access from project Removes private volume type access from a project. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -72,8 +82,12 @@ List private volume type access detail Lists project IDs that have access to private volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/volumes-v3-extensions.inc b/api-ref/source/v3/volumes-v3-extensions.inc index 7b4b4283180..b8569893cd7 100644 --- a/api-ref/source/v3/volumes-v3-extensions.inc +++ b/api-ref/source/v3/volumes-v3-extensions.inc @@ -13,10 +13,16 @@ List Known API extensions Lists Block Storage API extensions. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: 300 + - 200 + +.. rest_status_code:: error ../status.yaml + + - 300 Request diff --git a/api-ref/source/v3/volumes-v3-snapshots-actions.inc b/api-ref/source/v3/volumes-v3-snapshots-actions.inc index 819c454db23..ad40de016ed 100644 --- a/api-ref/source/v3/volumes-v3-snapshots-actions.inc +++ b/api-ref/source/v3/volumes-v3-snapshots-actions.inc @@ -13,7 +13,12 @@ Reset a snapshot's status Resets the status. Specify the ``os-reset_status`` action in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index 8a50e513432..a0d4489f573 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -43,10 +43,16 @@ Lists all Block Storage snapshots, with details, that the project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -96,7 +102,12 @@ Create a 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 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -151,10 +162,16 @@ Lists all Block Storage snapshots, with summary information, that the project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -201,8 +218,12 @@ Show a snapshot's metadata Shows metadata for a snapshot. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -248,8 +269,12 @@ Updates metadata for a snapshot. Creates or replaces metadata items that match keys. Does not modify items that are not in the request. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -287,8 +312,12 @@ Update a snapshot's metadata Replaces all the snapshot's metadata with the key-value pairs in the request. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -328,8 +357,12 @@ Show a snapshot's details Shows details for a snapshot. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -373,8 +406,12 @@ Update a snapshot Updates a snapshot. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -426,7 +463,12 @@ Delete a snapshot Deletes a snapshot. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -445,7 +487,12 @@ Show a snapshot's metadata for a specific key Shows metadata for a snapshot for a specific key. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -480,7 +527,12 @@ Delete a snapshot's metadata Deletes metadata for a snapshot. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -500,7 +552,12 @@ Update a snapshot's metadata for a specific key Update metadata for a snapshot for a specific key. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc index 06738a2eff1..e6ed183973c 100644 --- a/api-ref/source/v3/volumes-v3-types.inc +++ b/api-ref/source/v3/volumes-v3-types.inc @@ -24,8 +24,12 @@ Update a volume type Updates a volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -73,8 +77,12 @@ Create or update extra specs for volume type Adds new extra specifications to a volume type, or updates the extra specifications that are assigned to a volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -115,8 +123,12 @@ Show all extra specifications for volume type Shows all extra specifications assigned to a volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -149,8 +161,12 @@ Show extra specification for volume type Shows the specific extra specification assigned to a volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -176,8 +192,12 @@ Update extra specification for volume type Update the specific extra specification assigned to a volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -210,8 +230,12 @@ Delete extra specification for volume type Deletes the specific extra specification assigned to a volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 202 +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -231,8 +255,12 @@ Show volume type detail Shows details for a volume type. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -269,8 +297,12 @@ Show default volume type Shows details for the default volume type if configured. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request ------- @@ -306,7 +338,12 @@ Delete a volume type Deletes a volume type. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -325,8 +362,12 @@ List all volume types Lists volume types. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -364,7 +405,12 @@ Create a volume type Creates a volume type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -413,7 +459,12 @@ Show an encryption type To show an encryption type for an existing volume type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -456,7 +507,12 @@ Show encryption specs item To show encryption specs item for an existing volume type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -482,7 +538,12 @@ Delete an encryption type To delete an encryption type for an existing volume type. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -502,7 +563,12 @@ Create an encryption type To create an encryption type for an existing volume type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -552,7 +618,12 @@ Update an encryption type To update an encryption type for an existing volume type. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/volumes-v3-versions.inc b/api-ref/source/v3/volumes-v3-versions.inc index 29a160c65cb..c1524e9adc2 100644 --- a/api-ref/source/v3/volumes-v3-versions.inc +++ b/api-ref/source/v3/volumes-v3-versions.inc @@ -11,10 +11,16 @@ Show API v3 details Shows details for Block Storage API v3. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: 403 + - 200 + +.. rest_status_code:: error ../status.yaml + + - 403 Request diff --git a/api-ref/source/v3/volumes-v3-volumes-actions.inc b/api-ref/source/v3/volumes-v3-volumes-actions.inc index 2d4bbfc0135..7c07633ce88 100644 --- a/api-ref/source/v3/volumes-v3-volumes-actions.inc +++ b/api-ref/source/v3/volumes-v3-volumes-actions.inc @@ -52,7 +52,12 @@ Troubleshooting request. If the request fails again, investigate the storage back end. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -80,7 +85,12 @@ Reset a volume's statuses Administrator only. Resets the status, attach status, revert to snapshot, and migration status for a volume. Specify the ``os-reset_status`` action in the request body. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -112,9 +122,19 @@ and the volume status must be ``available``. Available since API microversion ``3.40``. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ -Error response codes: 400(HTTPBadRequest), 403(HTTPForbidden), 404(HTTPNotFound), 409(HTTPConflict) +.. rest_status_code:: success ../status.yaml + + - 202 + +.. rest_status_code:: error ../status.yaml + + - 400 + - 403 + - 404 + - 409 Request ------- @@ -140,7 +160,12 @@ Set image metadata for a volume Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -167,7 +192,12 @@ Remove image metadata from a volume Removes image metadata, by key, from a volume. Specify the ``os-unset_image_metadata`` action in the request body and the ``key`` for the metadata key and value pair that you want to remove. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -196,7 +226,12 @@ Show image metadata for a volume Shows image metadata for a volume. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -242,7 +277,12 @@ Preconditions - You should set ``instance_uuid`` or ``host_name``. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -276,7 +316,12 @@ Preconditions - Volume status must be ``in-use``. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -309,7 +354,12 @@ Preconditions - Volume status must be ``available``. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -343,7 +393,12 @@ perform this operation. Cloud providers can change these permissions through the ``volume_extension:volume_admin_actions:force_detach`` rule in the ``policy.json`` file. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -383,7 +438,12 @@ Policy defaults enable only users with the administrative role or the owner of the volume to perform this operation. Cloud providers can change these permissions through the policy.json file. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -412,8 +472,12 @@ Force delete a volume Attempts force-delete of volume, regardless of state. Specify the ``os-force_delete`` action in the request body. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 202 +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -440,7 +504,12 @@ Update a volume's bootable status Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -467,7 +536,12 @@ Upload volume to image Uploads the specified volume to image service. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 2a96bca1196..2807e3f29b9 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -70,10 +70,16 @@ Lists all Block Storage volumes, with details, that the project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml -Error response codes: badRequest(400) + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -173,7 +179,12 @@ Troubleshooting - The storage node needs enough free storage space to match the size of the volume creation request. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -250,9 +261,16 @@ project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ -Error response codes: badRequest(400) +.. rest_status_code:: success ../status.yaml + + - 200 + +.. rest_status_code:: error ../status.yaml + + - 400 Request @@ -302,8 +320,12 @@ Preconditions - The volume must exist. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -369,8 +391,12 @@ Update a volume Updates a volume. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 200 +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -422,7 +448,6 @@ Response Parameters - volume_type: volume_type_6 - Response Example ---------------- @@ -430,8 +455,6 @@ Response Example :language: javascript - - Delete a volume ~~~~~~~~~~~~~~~ @@ -464,7 +487,12 @@ Troubleshooting - The volume managed by OpenStack Block Storage is not deleted from the storage system. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -486,7 +514,12 @@ Create metadata for volume Creates or replaces metadata for a volume. Does not modify items that are not in the request. -Normal response codes: 202 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 202 Request @@ -521,8 +554,6 @@ Response Example :language: javascript - - Show a volume's metadata ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -531,7 +562,12 @@ Show a volume's metadata Shows metadata for a volume. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -559,8 +595,6 @@ Response Example :language: javascript - - Update a volume's metadata ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -569,7 +603,12 @@ Update a volume's metadata Replaces all the volume's metadata with the key-value pairs in the request. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -612,7 +651,12 @@ Show a volume's metadata for a specific key Shows metadata for a volume for a specific key. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -649,7 +693,12 @@ Delete a volume's metadata Deletes metadata for a volume. -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -669,7 +718,13 @@ Update a volume's metadata for a specific key Update metadata for a volume for a specific key. -Normal response codes: 200 + +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request @@ -710,7 +765,12 @@ Get volumes summary Display volumes summary with total number of volumes and total size in GB -Normal response codes: 200 +Response codes +~~~~~~~~~~~~~~ + +.. rest_status_code:: success ../status.yaml + + - 200 Request diff --git a/api-ref/source/v3/worker-cleanup.inc b/api-ref/source/v3/worker-cleanup.inc index 1d1a0a776af..d7402990867 100644 --- a/api-ref/source/v3/worker-cleanup.inc +++ b/api-ref/source/v3/worker-cleanup.inc @@ -13,8 +13,12 @@ Request cleanup of services with optional filtering. This API is only available with microversion 3.24 or later. +Response codes +~~~~~~~~~~~~~~ -Normal response codes: 202 +.. rest_status_code:: success ../status.yaml + + - 202 Request