From a96fad9f3bf01d8482edec6d1a5e3bfa3389df03 Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Tue, 13 Mar 2018 15:57:54 -0500 Subject: [PATCH] Fix api-ref response code title levels Using the wrong character resulted in the wrong title level being used for the response codes, which in turn caused the "detail" show/hide toggle to not be able to hide all of the per-endpoint details. This corrects these to be at the correct level. Also ran into issues after changing them where sphinx was not happy with the random title levels. This appears to be due to the order processed and whether not earlier included files had all subsequent levels. Adding an additional title in our first included file resolved that problem. Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03 Closes-bug: #1755566 --- api-ref/source/v2/api-versions.inc | 9 ++++-- api-ref/source/v2/capabilities-v2.inc | 2 +- api-ref/source/v2/consistencygroups-v2.inc | 14 ++++---- api-ref/source/v2/ext-backups-actions-v2.inc | 4 +-- api-ref/source/v2/ext-backups.inc | 18 +++++------ api-ref/source/v2/hosts.inc | 4 +-- api-ref/source/v2/limits.inc | 2 +- api-ref/source/v2/os-cgsnapshots-v2.inc | 10 +++--- api-ref/source/v2/os-vol-pool-v2.inc | 2 +- api-ref/source/v2/os-vol-transfer-v2.inc | 12 +++---- api-ref/source/v2/qos-specs-v2-qos-specs.inc | 22 ++++++------- api-ref/source/v2/quota-classes.inc | 4 +-- api-ref/source/v2/quota-sets.inc | 8 ++--- api-ref/source/v2/volume-manage.inc | 2 +- api-ref/source/v2/volume-type-access.inc | 6 ++-- api-ref/source/v2/volumes-v2-extensions.inc | 2 +- .../v2/volumes-v2-snapshots-actions.inc | 2 +- api-ref/source/v2/volumes-v2-snapshots.inc | 20 ++++++------ api-ref/source/v2/volumes-v2-types.inc | 20 ++++++------ api-ref/source/v2/volumes-v2-versions.inc | 9 ++---- .../source/v2/volumes-v2-volumes-actions.inc | 24 +++++++------- api-ref/source/v2/volumes-v2-volumes.inc | 24 +++++++------- api-ref/source/v3/api-versions.inc | 11 ++++--- api-ref/source/v3/attachments.inc | 14 ++++---- api-ref/source/v3/capabilities-v3.inc | 2 +- api-ref/source/v3/consistencygroups-v3.inc | 14 ++++---- api-ref/source/v3/ext-backups-actions-v3.inc | 4 +-- api-ref/source/v3/ext-backups.inc | 18 +++++------ api-ref/source/v3/group-replication.inc | 8 ++--- api-ref/source/v3/group-snapshots.inc | 12 +++---- api-ref/source/v3/group-type-specs.inc | 10 +++--- api-ref/source/v3/group-types.inc | 12 +++---- api-ref/source/v3/groups.inc | 16 +++++----- api-ref/source/v3/hosts.inc | 4 +-- api-ref/source/v3/limits.inc | 2 +- api-ref/source/v3/messages.inc | 6 ++-- api-ref/source/v3/os-cgsnapshots-v3.inc | 10 +++--- api-ref/source/v3/os-services.inc | 18 +++++------ api-ref/source/v3/os-vol-pool-v3.inc | 2 +- api-ref/source/v3/os-vol-transfer-v3.inc | 12 +++---- api-ref/source/v3/qos-specs-v3-qos-specs.inc | 20 ++++++------ api-ref/source/v3/quota-classes.inc | 4 +-- api-ref/source/v3/quota-sets.inc | 12 +++---- api-ref/source/v3/resource-filters.inc | 2 +- api-ref/source/v3/snapshot-manage.inc | 6 ++-- api-ref/source/v3/volume-manage.inc | 6 ++-- api-ref/source/v3/volume-type-access.inc | 6 ++-- api-ref/source/v3/volumes-v3-extensions.inc | 2 +- .../v3/volumes-v3-snapshots-actions.inc | 2 +- api-ref/source/v3/volumes-v3-snapshots.inc | 24 +++++++------- api-ref/source/v3/volumes-v3-types.inc | 32 +++++++++---------- api-ref/source/v3/volumes-v3-versions.inc | 6 ++-- .../source/v3/volumes-v3-volumes-actions.inc | 28 ++++++++-------- api-ref/source/v3/volumes-v3-volumes.inc | 26 +++++++-------- api-ref/source/v3/worker-cleanup.inc | 2 +- 55 files changed, 288 insertions(+), 285 deletions(-) diff --git a/api-ref/source/v2/api-versions.inc b/api-ref/source/v2/api-versions.inc index e032dbf1919..841b36475fb 100644 --- a/api-ref/source/v2/api-versions.inc +++ b/api-ref/source/v2/api-versions.inc @@ -1,14 +1,17 @@ .. -*- rst -*- +API versions +============ + List Api Versions -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: GET / Lists information for all Block Storage API versions. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -26,7 +29,7 @@ Response codes - 503 Response -~~~~~~~~ +-------- **Example List Api Versions: JSON request** diff --git a/api-ref/source/v2/capabilities-v2.inc b/api-ref/source/v2/capabilities-v2.inc index e33c766e7f3..31d181ba80d 100644 --- a/api-ref/source/v2/capabilities-v2.inc +++ b/api-ref/source/v2/capabilities-v2.inc @@ -15,7 +15,7 @@ Shows capabilities for a storage back end on the host. The ``hostname`` takes the form of ``hostname@volume_backend_name``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/consistencygroups-v2.inc b/api-ref/source/v2/consistencygroups-v2.inc index 246ca128335..3a59dccedd4 100644 --- a/api-ref/source/v2/consistencygroups-v2.inc +++ b/api-ref/source/v2/consistencygroups-v2.inc @@ -22,7 +22,7 @@ List consistency groups Lists consistency groups. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -64,7 +64,7 @@ Create consistency group Creates a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -114,7 +114,7 @@ Show consistency group details Shows details for a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -156,7 +156,7 @@ Create consistency group from source Creates a consistency group from source. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -191,7 +191,7 @@ Delete consistency group Deletes a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -222,7 +222,7 @@ List consistency groups with details Lists consistency groups with details. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -269,7 +269,7 @@ Update consistency group Updates a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/ext-backups-actions-v2.inc b/api-ref/source/v2/ext-backups-actions-v2.inc index 76a9bbf703c..a91faf78c16 100644 --- a/api-ref/source/v2/ext-backups-actions-v2.inc +++ b/api-ref/source/v2/ext-backups-actions-v2.inc @@ -19,7 +19,7 @@ The backup driver returns the ``405`` status code if it does not support this operation. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -55,7 +55,7 @@ Reset backup's status Reset a backup's status. Specify the ``os-reset_status`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/ext-backups.inc b/api-ref/source/v2/ext-backups.inc index 4bb17b4e95a..1a31b9592bf 100644 --- a/api-ref/source/v2/ext-backups.inc +++ b/api-ref/source/v2/ext-backups.inc @@ -45,7 +45,7 @@ List backups with details Lists Block Storage backups, with details, to which the project has access. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -103,7 +103,7 @@ Show backup details Shows details for a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -157,7 +157,7 @@ Delete backup Deletes a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -177,7 +177,7 @@ Request Restore backup -~~~~~~~~~~~~~~ +-------------- .. rest_method:: POST /v2/{project_id}/backups/{backup_id}/restore @@ -187,7 +187,7 @@ You must specify either the UUID or name of the volume. If you specify both the UUID and name, the UUID takes priority. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -239,7 +239,7 @@ Create backup Creates a Block Storage backup from a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -289,7 +289,7 @@ List backups Lists Block Storage backups to which the project has access. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -332,7 +332,7 @@ Export backup Export information about a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -375,7 +375,7 @@ Import backup Import information about a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/hosts.inc b/api-ref/source/v2/hosts.inc index 12c86288acd..665ce27504e 100644 --- a/api-ref/source/v2/hosts.inc +++ b/api-ref/source/v2/hosts.inc @@ -16,7 +16,7 @@ List all hosts Lists all hosts summary info that is not disabled. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -66,7 +66,7 @@ It is not valid against other Cinder service hosts or hosts where the cinder-volume service has been disabled. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/limits.inc b/api-ref/source/v2/limits.inc index a143e473891..e18de3c35cd 100644 --- a/api-ref/source/v2/limits.inc +++ b/api-ref/source/v2/limits.inc @@ -20,7 +20,7 @@ An absolute limit value of ``-1`` indicates that the absolute limit for the item is infinite. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/os-cgsnapshots-v2.inc b/api-ref/source/v2/os-cgsnapshots-v2.inc index 06ee6d60cdc..529e97007b8 100644 --- a/api-ref/source/v2/os-cgsnapshots-v2.inc +++ b/api-ref/source/v2/os-cgsnapshots-v2.inc @@ -15,7 +15,7 @@ Delete consistency group snapshot Deletes a consistency group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -38,7 +38,7 @@ Show consistency group snapshot details Shows details for a consistency group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -80,7 +80,7 @@ List consistency group snapshots with details Lists all consistency group snapshots with details. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -121,7 +121,7 @@ List consistency group snapshots Lists all consistency group snapshots. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -161,7 +161,7 @@ Create consistency group snapshot Creates a consistency group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/os-vol-pool-v2.inc b/api-ref/source/v2/os-vol-pool-v2.inc index 21f7da1564e..4213579cd27 100644 --- a/api-ref/source/v2/os-vol-pool-v2.inc +++ b/api-ref/source/v2/os-vol-pool-v2.inc @@ -15,7 +15,7 @@ List back-end storage pools Lists all back-end storage pools. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/os-vol-transfer-v2.inc b/api-ref/source/v2/os-vol-transfer-v2.inc index ba6930b802a..bbfffaf8077 100644 --- a/api-ref/source/v2/os-vol-transfer-v2.inc +++ b/api-ref/source/v2/os-vol-transfer-v2.inc @@ -14,7 +14,7 @@ Accept volume transfer Accepts a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -61,7 +61,7 @@ Create volume transfer Creates a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -110,7 +110,7 @@ List volume transfers Lists volume transfers. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -151,7 +151,7 @@ Show volume transfer details Shows details for a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -193,7 +193,7 @@ Delete volume transfer Deletes a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -216,7 +216,7 @@ List volume transfers, with details Lists volume transfers, with details. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml 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 2bf1dd6d400..57fe53bffa8 100644 --- a/api-ref/source/v2/qos-specs-v2-qos-specs.inc +++ b/api-ref/source/v2/qos-specs-v2-qos-specs.inc @@ -18,7 +18,7 @@ Disassociate QoS specification from all associations Disassociates a QoS specification from all associations. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -42,7 +42,7 @@ Unset keys in QoS specification Unsets keys in a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -82,7 +82,7 @@ Lists all associations for a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -113,7 +113,7 @@ Associate QoS specification with volume type Associates a QoS specification with a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -138,7 +138,7 @@ Disassociate QoS specification from volume type Disassociates a QoS specification from a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -163,7 +163,7 @@ Show QoS specification details Shows details for a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -216,7 +216,7 @@ Set keys in QoS specification Sets keys in a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -254,7 +254,7 @@ Delete QoS specification Deletes a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -281,7 +281,7 @@ Creates a QoS specification. Specify one or more key and value pairs in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -320,7 +320,7 @@ Response Parameters List QoS specs -~~~~~~~~~~~~~~ +-------------- .. rest_method:: GET /v2/{project_id}/qos-specs @@ -328,7 +328,7 @@ Lists quality of service (QoS) specifications. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/quota-classes.inc b/api-ref/source/v2/quota-classes.inc index 584a0b8886a..e7536866926 100644 --- a/api-ref/source/v2/quota-classes.inc +++ b/api-ref/source/v2/quota-classes.inc @@ -16,7 +16,7 @@ Shows quota class set for a project. If no specific value for the quota class resource exists, then the default value will be reported. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -66,7 +66,7 @@ Updates quota class set for a project. If the ``quota_class_name`` key does not exist, then the API will create one. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/quota-sets.inc b/api-ref/source/v2/quota-sets.inc index 5fa55ea7ddb..1e65480ac37 100644 --- a/api-ref/source/v2/quota-sets.inc +++ b/api-ref/source/v2/quota-sets.inc @@ -15,7 +15,7 @@ Show quotas Shows quotas for a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -69,7 +69,7 @@ Update quotas Updates quotas for a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -142,7 +142,7 @@ Delete quotas Deletes quotas for a project so the quotas revert to default values. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -172,7 +172,7 @@ Gets default quotas for a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volume-manage.inc b/api-ref/source/v2/volume-manage.inc index 3d06ffcaa1a..852611a09b6 100644 --- a/api-ref/source/v2/volume-manage.inc +++ b/api-ref/source/v2/volume-manage.inc @@ -24,7 +24,7 @@ The API chooses the size of the volume by rounding up the size of the existing storage volume to the next gibibyte (GiB). Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volume-type-access.inc b/api-ref/source/v2/volume-type-access.inc index 488c2733fb8..de08bad09c3 100644 --- a/api-ref/source/v2/volume-type-access.inc +++ b/api-ref/source/v2/volume-type-access.inc @@ -21,7 +21,7 @@ Add private volume type access Adds private volume type access to a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -52,7 +52,7 @@ Remove private volume type access Removes private volume type access from a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -83,7 +83,7 @@ List private volume type access details Lists project IDs that have access to private volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volumes-v2-extensions.inc b/api-ref/source/v2/volumes-v2-extensions.inc index f220deb8257..5e94752b865 100644 --- a/api-ref/source/v2/volumes-v2-extensions.inc +++ b/api-ref/source/v2/volumes-v2-extensions.inc @@ -14,7 +14,7 @@ List API extensions Lists Block Storage API extensions. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volumes-v2-snapshots-actions.inc b/api-ref/source/v2/volumes-v2-snapshots-actions.inc index bb5157dbad0..effc92173af 100644 --- a/api-ref/source/v2/volumes-v2-snapshots-actions.inc +++ b/api-ref/source/v2/volumes-v2-snapshots-actions.inc @@ -15,7 +15,7 @@ Reset a snapshot's status Resets the status. Specify the ``os-reset_status`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volumes-v2-snapshots.inc b/api-ref/source/v2/volumes-v2-snapshots.inc index 45672af3ad6..c3c74970483 100644 --- a/api-ref/source/v2/volumes-v2-snapshots.inc +++ b/api-ref/source/v2/volumes-v2-snapshots.inc @@ -43,7 +43,7 @@ Lists all Block Storage snapshots, with details, that the project can access. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -90,7 +90,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. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -132,14 +132,14 @@ Response Parameters List snapshots -~~~~~~~~~~~~~~ +-------------- .. rest_method:: GET /v2/{project_id}/snapshots Lists all Block Storage snapshots, with summary information, that the project can access. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -189,7 +189,7 @@ Show snapshot metadata Shows metadata for a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -241,7 +241,7 @@ are not in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -280,7 +280,7 @@ Replaces all the snapshot's metadata with the key-value pairs in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -319,7 +319,7 @@ Shows details for a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -368,7 +368,7 @@ Updates a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -424,7 +424,7 @@ Delete snapshot Deletes a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volumes-v2-types.inc b/api-ref/source/v2/volumes-v2-types.inc index aa22ba957ef..97beee0d5ee 100644 --- a/api-ref/source/v2/volumes-v2-types.inc +++ b/api-ref/source/v2/volumes-v2-types.inc @@ -26,7 +26,7 @@ blockstorage-multi-backend.html>`_. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -77,7 +77,7 @@ Updates the extra specifications that are assigned to a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -130,7 +130,7 @@ Shows details for a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -172,7 +172,7 @@ Delete volume type Deletes a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -197,7 +197,7 @@ Lists volume types. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -256,7 +256,7 @@ blockstorage-multi-backend.html>`_. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -307,7 +307,7 @@ To show an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -357,7 +357,7 @@ Delete an encryption type. To delete an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -384,7 +384,7 @@ To create an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -442,7 +442,7 @@ To update an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volumes-v2-versions.inc b/api-ref/source/v2/volumes-v2-versions.inc index 4b53774a9bb..1bef6e1d728 100644 --- a/api-ref/source/v2/volumes-v2-versions.inc +++ b/api-ref/source/v2/volumes-v2-versions.inc @@ -1,10 +1,7 @@ .. -*- rst -*- -API versions -============ - - - +API version details +=================== Show API v2 details ~~~~~~~~~~~~~~~~~~~ @@ -15,7 +12,7 @@ Shows details for Block Storage API v2. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volumes-v2-volumes-actions.inc b/api-ref/source/v2/volumes-v2-volumes-actions.inc index d10a13f03a3..24b57938431 100644 --- a/api-ref/source/v2/volumes-v2-volumes-actions.inc +++ b/api-ref/source/v2/volumes-v2-volumes-actions.inc @@ -34,7 +34,7 @@ Troubleshooting Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -67,7 +67,7 @@ Administrator only. Resets the status, attach status, and migration status for a Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -101,7 +101,7 @@ Set image metadata for volume Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -134,7 +134,7 @@ Removes image metadata, by key, from a volume. Specify the ``os-unset_image_meta Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -166,7 +166,7 @@ Show image metadata for volume Shows image metadata for a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -218,7 +218,7 @@ Preconditions - You should set ``instance_uuid`` or ``host_name``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -256,7 +256,7 @@ Preconditions - Volume status must be ``in-use``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -293,7 +293,7 @@ Preconditions - Volume status must be ``available``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -334,7 +334,7 @@ the ``policy.json`` file. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -380,7 +380,7 @@ the volume to perform this operation. Cloud providers can change these permissions through the policy.json file. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -414,7 +414,7 @@ Attempts force-delete of volume, regardless of state. Specify the ``os-force_del in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -446,7 +446,7 @@ Update the bootable status for a volume, mark it as a bootable volume. Specify t Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v2/volumes-v2-volumes.inc b/api-ref/source/v2/volumes-v2-volumes.inc index fb0af63a151..654b7119474 100644 --- a/api-ref/source/v2/volumes-v2-volumes.inc +++ b/api-ref/source/v2/volumes-v2-volumes.inc @@ -67,7 +67,7 @@ List volumes with details Lists all Block Storage volumes, with details, that the project can access. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -169,7 +169,7 @@ Troubleshooting of the volume creation request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -248,7 +248,7 @@ Lists summary information for all Block Storage volumes that the project can acc Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -301,7 +301,7 @@ Preconditions - The volume must exist. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -372,7 +372,7 @@ Updates a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -469,7 +469,7 @@ Troubleshooting Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -496,7 +496,7 @@ Creates or replaces metadata for a volume. Does not modify items that are not in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -545,7 +545,7 @@ Shows metadata for a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -587,7 +587,7 @@ Update volume metadata Replaces all the volume's metadata with the key-value pairs in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -636,7 +636,7 @@ Show volume metadata for a specific key Shows metadata for a volume for a specific key. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -676,7 +676,7 @@ Delete volume metadata Deletes metadata for a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -701,7 +701,7 @@ Update volume metadata for a specific key Update metadata for a volume for a specific key. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/api-versions.inc b/api-ref/source/v3/api-versions.inc index 1f7034a8bdd..07dea00f90e 100644 --- a/api-ref/source/v3/api-versions.inc +++ b/api-ref/source/v3/api-versions.inc @@ -1,14 +1,17 @@ .. -*- rst -*- +API versions +============ + List All Api Versions -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET / Lists information for all Block Storage API versions. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -26,10 +29,10 @@ Response codes - 503 Request -~~~~~~~ +------- Response -~~~~~~~~ +-------- **Example List Api Versions: JSON request** diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index 2401d096426..29dc10b14e2 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -21,7 +21,7 @@ Deletes an attachment. Available starting in the 3.27 microversion. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -52,7 +52,7 @@ Shows details for an attachment. Available starting in the 3.27 microversion. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -105,7 +105,7 @@ users specify invalid filters in the url, API will return bad request. Available starting in the 3.27 microversion. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -159,7 +159,7 @@ specify invalid filters in the url, API will return bad request. Available starting in the 3.27 microversion. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -211,7 +211,7 @@ Creates an attachment. Available starting in the 3.27 microversion. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -273,7 +273,7 @@ and set up the appropriate connection_info from the driver. Available starting in the 3.27 microversion. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -332,7 +332,7 @@ Complete an attachment for a cinder volume. Available starting in the 3.44 microversion. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/capabilities-v3.inc b/api-ref/source/v3/capabilities-v3.inc index b51f47adf15..dee5dcfa54b 100644 --- a/api-ref/source/v3/capabilities-v3.inc +++ b/api-ref/source/v3/capabilities-v3.inc @@ -15,7 +15,7 @@ Shows capabilities for a storage back end on the host. The ``hostname`` takes the form of ``hostname@volume_backend_name``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/consistencygroups-v3.inc b/api-ref/source/v3/consistencygroups-v3.inc index 4b77622e040..f9482d919ed 100644 --- a/api-ref/source/v3/consistencygroups-v3.inc +++ b/api-ref/source/v3/consistencygroups-v3.inc @@ -23,7 +23,7 @@ Lists consistency groups. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -66,7 +66,7 @@ Create a consistency group Creates a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -119,7 +119,7 @@ Show a consistency group's details Shows details for a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -162,7 +162,7 @@ Creates a consistency group from source. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -199,7 +199,7 @@ Delete a consistency group Deletes a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -232,7 +232,7 @@ Lists consistency groups with details. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -281,7 +281,7 @@ Updates a consistency group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/ext-backups-actions-v3.inc b/api-ref/source/v3/ext-backups-actions-v3.inc index 0a5ce8f95bf..c6632286307 100644 --- a/api-ref/source/v3/ext-backups-actions-v3.inc +++ b/api-ref/source/v3/ext-backups-actions-v3.inc @@ -20,7 +20,7 @@ The backup driver returns the ``405`` status code if it does not support this operation. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -57,7 +57,7 @@ Reset a backup's status. Specify the ``os-reset_status`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index af790b4d676..a688c75cfa2 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -48,7 +48,7 @@ API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -115,7 +115,7 @@ Show backup detail Shows details for a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -173,7 +173,7 @@ Delete a backup Deletes a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -213,7 +213,7 @@ In this case, if the name parameter is provided, it will be used as the name of the new volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -266,7 +266,7 @@ Create a backup Creates a Block Storage backup from a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -318,7 +318,7 @@ Update a backup Update a Block Storage backup. This API is available since v3.9. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -373,7 +373,7 @@ since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -422,7 +422,7 @@ Export information about a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -467,7 +467,7 @@ Import information about a backup. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/group-replication.inc b/api-ref/source/v3/group-replication.inc index 1aaa064d288..dd4c5a1e68e 100644 --- a/api-ref/source/v3/group-replication.inc +++ b/api-ref/source/v3/group-replication.inc @@ -16,7 +16,7 @@ List replication targets Lists replication targets for a group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -66,7 +66,7 @@ Enable group replication Enable replication for a group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -99,7 +99,7 @@ Disable group replication Disable replication for a group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -132,7 +132,7 @@ Failover replication Failover a replicated group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index 51193ce0f85..1abcec93b3a 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -16,7 +16,7 @@ Deletes a group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -46,7 +46,7 @@ Shows details for a group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -98,7 +98,7 @@ users specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -152,7 +152,7 @@ specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -202,7 +202,7 @@ Create group snapshot Creates a group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -256,7 +256,7 @@ Reset group snapshot status Resets the status for a group snapshot. Specifies the ``reset_status`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/group-type-specs.inc b/api-ref/source/v3/group-type-specs.inc index b151ec58106..6cb241c1dc3 100644 --- a/api-ref/source/v3/group-type-specs.inc +++ b/api-ref/source/v3/group-type-specs.inc @@ -12,7 +12,7 @@ Create group specs for a group type, if the specification key already exists in this API will update the specification as well. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -66,7 +66,7 @@ List all the group specs for a group type, Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -111,7 +111,7 @@ Show a group spec for a group type, Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -156,7 +156,7 @@ Update a group spec for a group type, Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -207,7 +207,7 @@ Delete a group spec for a group type, Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/group-types.inc b/api-ref/source/v3/group-types.inc index 5a380fd66f6..303ac048d1e 100644 --- a/api-ref/source/v3/group-types.inc +++ b/api-ref/source/v3/group-types.inc @@ -14,7 +14,7 @@ Update group type Updates a group type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -75,7 +75,7 @@ Show group type details Shows details for a group type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -123,7 +123,7 @@ Shows details for the default group type if configured. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -169,7 +169,7 @@ Delete group type Deletes a group type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -199,7 +199,7 @@ List group types Lists group types. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -243,7 +243,7 @@ Create group type Creates a group type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index d8e1c7dec14..30bd02128ff 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -26,7 +26,7 @@ Lists groups. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -74,7 +74,7 @@ Create group Creates a group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -114,7 +114,7 @@ Show group details Shows details for a group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -166,7 +166,7 @@ Creates a group from source. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -205,7 +205,7 @@ Delete group Deletes a group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -244,7 +244,7 @@ users specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -300,7 +300,7 @@ Update group Updates a group. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -340,7 +340,7 @@ Reset group status Resets the status for a group. Specify the ``reset_status`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/hosts.inc b/api-ref/source/v3/hosts.inc index 0a8d26fc236..352d818ee71 100644 --- a/api-ref/source/v3/hosts.inc +++ b/api-ref/source/v3/hosts.inc @@ -16,7 +16,7 @@ List all hosts for a project Lists all hosts summary info that is not disabled. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -67,7 +67,7 @@ It is not valid against other Cinder service hosts or hosts where the cinder-volume service has been disabled. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/limits.inc b/api-ref/source/v3/limits.inc index 8aa0813b3f9..c7a59a42afc 100644 --- a/api-ref/source/v3/limits.inc +++ b/api-ref/source/v3/limits.inc @@ -20,7 +20,7 @@ An absolute limit value of ``-1`` indicates that the absolute limit for the item is infinite. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/messages.inc b/api-ref/source/v3/messages.inc index 5424f327a1b..8fdea164acf 100644 --- a/api-ref/source/v3/messages.inc +++ b/api-ref/source/v3/messages.inc @@ -14,7 +14,7 @@ Delete message Deletes a message. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -44,7 +44,7 @@ Shows details for a message. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -99,7 +99,7 @@ specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/os-cgsnapshots-v3.inc b/api-ref/source/v3/os-cgsnapshots-v3.inc index 029eb8a2ad3..ffe5bd366fb 100644 --- a/api-ref/source/v3/os-cgsnapshots-v3.inc +++ b/api-ref/source/v3/os-cgsnapshots-v3.inc @@ -15,7 +15,7 @@ Delete a consistency group snapshot Deletes a consistency group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -39,7 +39,7 @@ Show consistency group snapshot detail Shows details for a consistency group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -83,7 +83,7 @@ List all consistency group snapshots with details Lists all consistency group snapshots with details. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -126,7 +126,7 @@ Lists all consistency group snapshots. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -170,7 +170,7 @@ Create a consistency group snapshot Creates a consistency group snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/os-services.inc b/api-ref/source/v3/os-services.inc index 7fdf9c2bbd6..c2bdad75312 100644 --- a/api-ref/source/v3/os-services.inc +++ b/api-ref/source/v3/os-services.inc @@ -17,7 +17,7 @@ Lists all Cinder services. Provides details why any services were disabled. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -72,7 +72,7 @@ Disables a Cinder service. Specify the service by its host name and binary name. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -128,7 +128,7 @@ Logs information to the Cinder service table about why a Cinder service was disa Specify the service by its host name and binary name. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -185,7 +185,7 @@ Enables a Cinder service. Specify the service by its host name and binary name. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -241,7 +241,7 @@ Get current log levels for services, supported since v3.32. Filter the services by binary, server name and prefix for the log path. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -295,7 +295,7 @@ Set log levels of services dynamically, supported since v3.32. Filter the services by binary, server name and prefix for the log path. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -334,7 +334,7 @@ Freeze and disable the specified cinder-volume host, and set ``Disabled Reason`` of Cinder service table to ``frozen``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -370,7 +370,7 @@ Thaw and enable the specified cinder-volume host, and clean ``Disabled Reason`` of Cinder service table. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -407,7 +407,7 @@ Failover a replicating cinder-volume host. Since Cinder Volume API Version and the cluster name in request body is supported. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/os-vol-pool-v3.inc b/api-ref/source/v3/os-vol-pool-v3.inc index c526266aa60..85ec95523a9 100644 --- a/api-ref/source/v3/os-vol-pool-v3.inc +++ b/api-ref/source/v3/os-vol-pool-v3.inc @@ -17,7 +17,7 @@ specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/os-vol-transfer-v3.inc b/api-ref/source/v3/os-vol-transfer-v3.inc index 2f0edddfa61..dc4eda5cf94 100644 --- a/api-ref/source/v3/os-vol-transfer-v3.inc +++ b/api-ref/source/v3/os-vol-transfer-v3.inc @@ -14,7 +14,7 @@ Accept a volume transfer Accepts a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -61,7 +61,7 @@ Create a volume transfer Creates a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -112,7 +112,7 @@ List volume transfers for a project Lists volume transfers. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -154,7 +154,7 @@ Show volume transfer detail Shows details for a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -197,7 +197,7 @@ Delete a volume transfer Deletes a volume transfer. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -221,7 +221,7 @@ List volume transfers and details Lists volume transfers, with details. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml 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 265d924414e..9e99765020a 100644 --- a/api-ref/source/v3/qos-specs-v3-qos-specs.inc +++ b/api-ref/source/v3/qos-specs-v3-qos-specs.inc @@ -18,7 +18,7 @@ Disassociate a QoS specification from all associations Disassociates a QoS specification from all associations. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -42,7 +42,7 @@ Unset keys in a QoS specification Unsets keys in a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -74,7 +74,7 @@ Lists all associations for a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -119,7 +119,7 @@ Associates a QoS specification with a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -145,7 +145,7 @@ Disassociates a QoS specification from a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -170,7 +170,7 @@ Show a QoS specification details Shows details for a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -224,7 +224,7 @@ Set keys in a QoS specification Sets keys in a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -269,7 +269,7 @@ Delete a QoS specification Deletes a QoS specification. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -297,7 +297,7 @@ Specify one or more key and value pairs in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -342,7 +342,7 @@ Lists quality of service (QoS) specifications. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/quota-classes.inc b/api-ref/source/v3/quota-classes.inc index 37da6cd4242..c595f758241 100644 --- a/api-ref/source/v3/quota-classes.inc +++ b/api-ref/source/v3/quota-classes.inc @@ -16,7 +16,7 @@ Shows quota class set for a project. If no specific value for the quota class resource exists, then the default value will be reported. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -68,7 +68,7 @@ Updates quota class set for a project. If the ``quota_class_name`` key does not exist, then the API will create one. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/quota-sets.inc b/api-ref/source/v3/quota-sets.inc index feebee67901..2549365ce1f 100644 --- a/api-ref/source/v3/quota-sets.inc +++ b/api-ref/source/v3/quota-sets.inc @@ -17,7 +17,7 @@ Shows quotas for a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -67,7 +67,7 @@ Show quota usage for a project Shows quota usage for a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -119,7 +119,7 @@ Updates quotas for a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -183,7 +183,7 @@ Delete quotas for a project Deletes quotas for a project so the quotas revert to default values. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -209,7 +209,7 @@ Get default quotas for a project Gets default quotas for a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -259,7 +259,7 @@ Validate setup for nested quota, administrator should ensure that Keystone v3 or being used. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/resource-filters.inc b/api-ref/source/v3/resource-filters.inc index e8e1774dc3b..dd842b16e1c 100644 --- a/api-ref/source/v3/resource-filters.inc +++ b/api-ref/source/v3/resource-filters.inc @@ -15,7 +15,7 @@ List resource filters List filters. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/snapshot-manage.inc b/api-ref/source/v3/snapshot-manage.inc index 14e16a2174c..8b92db21913 100644 --- a/api-ref/source/v3/snapshot-manage.inc +++ b/api-ref/source/v3/snapshot-manage.inc @@ -26,7 +26,7 @@ the existing snapshot to the next gibibyte (GiB). Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -63,7 +63,7 @@ Search a volume backend and list summary of snapshots which are available to manage. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -114,7 +114,7 @@ manage. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volume-manage.inc b/api-ref/source/v3/volume-manage.inc index 76d9ab364d1..469941d0c93 100644 --- a/api-ref/source/v3/volume-manage.inc +++ b/api-ref/source/v3/volume-manage.inc @@ -29,7 +29,7 @@ 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. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -72,7 +72,7 @@ Search a volume backend and list summary of volumes which are available to manage. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -121,7 +121,7 @@ Search a volume backend and list detail of volumes which are available to manage. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volume-type-access.inc b/api-ref/source/v3/volume-type-access.inc index 1a24a9ceda6..9cd4378618d 100644 --- a/api-ref/source/v3/volume-type-access.inc +++ b/api-ref/source/v3/volume-type-access.inc @@ -21,7 +21,7 @@ Add private volume type access to project Adds private volume type access to a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -52,7 +52,7 @@ Remove private volume type access from project Removes private volume type access from a project. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -83,7 +83,7 @@ List private volume type access detail Lists project IDs that have access to private volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volumes-v3-extensions.inc b/api-ref/source/v3/volumes-v3-extensions.inc index b8569893cd7..fd6d0cb2f5e 100644 --- a/api-ref/source/v3/volumes-v3-extensions.inc +++ b/api-ref/source/v3/volumes-v3-extensions.inc @@ -14,7 +14,7 @@ List Known API extensions Lists Block Storage API extensions. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volumes-v3-snapshots-actions.inc b/api-ref/source/v3/volumes-v3-snapshots-actions.inc index ad40de016ed..3657fa30b8a 100644 --- a/api-ref/source/v3/volumes-v3-snapshots-actions.inc +++ b/api-ref/source/v3/volumes-v3-snapshots-actions.inc @@ -14,7 +14,7 @@ Reset a snapshot's status Resets the status. Specify the ``os-reset_status`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index a0d4489f573..557075c2ac1 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -44,7 +44,7 @@ since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -103,7 +103,7 @@ Creates a volume snapshot, which is a point-in-time, complete copy of a volume. You can create a volume from a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -163,7 +163,7 @@ 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 -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -219,7 +219,7 @@ Show a snapshot's metadata Shows metadata for a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -270,7 +270,7 @@ Creates or replaces metadata items that match keys. Does not modify items that are not in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -313,7 +313,7 @@ Update a snapshot's metadata Replaces all the snapshot's metadata with the key-value pairs in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -358,7 +358,7 @@ Show a snapshot's details Shows details for a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -407,7 +407,7 @@ Update a snapshot Updates a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -464,7 +464,7 @@ Delete a snapshot Deletes a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -488,7 +488,7 @@ Show a snapshot's metadata for a specific key Shows metadata for a snapshot for a specific key. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -528,7 +528,7 @@ Delete a snapshot's metadata Deletes metadata for a snapshot. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -553,7 +553,7 @@ Update a snapshot's metadata for a specific key Update metadata for a snapshot for a specific key. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc index e6ed183973c..943308fddb8 100644 --- a/api-ref/source/v3/volumes-v3-types.inc +++ b/api-ref/source/v3/volumes-v3-types.inc @@ -25,7 +25,7 @@ Update a volume type Updates a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -78,7 +78,7 @@ Adds new extra specifications to a volume type, or updates the extra specifications that are assigned to a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -124,7 +124,7 @@ Show all extra specifications for volume type Shows all extra specifications assigned to a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -162,7 +162,7 @@ Show extra specification for volume type Shows the specific extra specification assigned to a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -193,7 +193,7 @@ Update extra specification for volume type Update the specific extra specification assigned to a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -231,7 +231,7 @@ Delete extra specification for volume type Deletes the specific extra specification assigned to a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -256,7 +256,7 @@ Show volume type detail Shows details for a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -298,7 +298,7 @@ Show default volume type Shows details for the default volume type if configured. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -339,7 +339,7 @@ Delete a volume type Deletes a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -363,7 +363,7 @@ List all volume types Lists volume types. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -406,7 +406,7 @@ Create a volume type Creates a volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -460,7 +460,7 @@ Show an encryption type To show an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -508,7 +508,7 @@ Show encryption specs item To show encryption specs item for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -539,7 +539,7 @@ Delete an encryption type To delete an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -564,7 +564,7 @@ Create an encryption type To create an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -619,7 +619,7 @@ Update an encryption type To update an encryption type for an existing volume type. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volumes-v3-versions.inc b/api-ref/source/v3/volumes-v3-versions.inc index c1524e9adc2..2134e31dd1f 100644 --- a/api-ref/source/v3/volumes-v3-versions.inc +++ b/api-ref/source/v3/volumes-v3-versions.inc @@ -1,7 +1,7 @@ .. -*- rst -*- -API versions -============ +API version details +=================== Show API v3 details @@ -12,7 +12,7 @@ Show API v3 details Shows details for Block Storage API v3. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volumes-v3-volumes-actions.inc b/api-ref/source/v3/volumes-v3-volumes-actions.inc index 7c07633ce88..6a95b573aed 100644 --- a/api-ref/source/v3/volumes-v3-volumes-actions.inc +++ b/api-ref/source/v3/volumes-v3-volumes-actions.inc @@ -53,7 +53,7 @@ Troubleshooting end. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -86,7 +86,7 @@ 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. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -123,7 +123,7 @@ and the volume status must be ``available``. Available since API microversion ``3.40``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -161,7 +161,7 @@ Set image metadata for a volume Sets the image metadata for a volume. Specify the ``os-set_image_metadata`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -193,7 +193,7 @@ 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. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -227,7 +227,7 @@ Show image metadata for a volume Shows image metadata for a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -278,7 +278,7 @@ Preconditions - You should set ``instance_uuid`` or ``host_name``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -317,7 +317,7 @@ Preconditions - Volume status must be ``in-use``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -355,7 +355,7 @@ Preconditions - Volume status must be ``available``. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -394,7 +394,7 @@ through the ``volume_extension:volume_admin_actions:force_detach`` rule in the ``policy.json`` file. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -439,7 +439,7 @@ the volume to perform this operation. Cloud providers can change these permissions through the policy.json file. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -473,7 +473,7 @@ Attempts force-delete of volume, regardless of state. Specify the ``os-force_del in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -505,7 +505,7 @@ Update the bootable status for a volume, mark it as a bootable volume. Specify the ``os-set_bootable`` action in the request body. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -537,7 +537,7 @@ Upload volume to image Uploads the specified volume to image service. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 2807e3f29b9..156e85f345e 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -71,7 +71,7 @@ since v3.31 if non-admin users specify invalid filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -180,7 +180,7 @@ Troubleshooting of the volume creation request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -262,7 +262,7 @@ filters in the url, API will return bad request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -321,7 +321,7 @@ Preconditions - The volume must exist. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -392,7 +392,7 @@ Update a volume Updates a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -488,7 +488,7 @@ Troubleshooting the storage system. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -515,7 +515,7 @@ Creates or replaces metadata for a volume. Does not modify items that are not in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -563,7 +563,7 @@ Shows metadata for a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -604,7 +604,7 @@ Replaces all the volume's metadata with the key-value pairs in the request. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -652,7 +652,7 @@ Show a volume's metadata for a specific key Shows metadata for a volume for a specific key. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -694,7 +694,7 @@ Delete a volume's metadata Deletes metadata for a volume. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -720,7 +720,7 @@ Update metadata for a volume for a specific key. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml @@ -766,7 +766,7 @@ Display volumes summary with total number of volumes and total size in GB Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml diff --git a/api-ref/source/v3/worker-cleanup.inc b/api-ref/source/v3/worker-cleanup.inc index d7402990867..d753ed0b45b 100644 --- a/api-ref/source/v3/worker-cleanup.inc +++ b/api-ref/source/v3/worker-cleanup.inc @@ -14,7 +14,7 @@ available with microversion 3.24 or later. Response codes -~~~~~~~~~~~~~~ +-------------- .. rest_status_code:: success ../status.yaml