diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 196265a25fa..ea7dfe39cc6 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -5,7 +5,7 @@ Block Storage API Contents: .. toctree:: - :maxdepth: 1 + :maxdepth: 2 v1/index v2/index diff --git a/api-ref/source/v1/os-quota-sets-v1.inc b/api-ref/source/v1/os-quota-sets-v1.inc index 2885d4fa735..c4a9dc556cc 100644 --- a/api-ref/source/v1/os-quota-sets-v1.inc +++ b/api-ref/source/v1/os-quota-sets-v1.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -==================================== Quota sets extension (os-quota-sets) ==================================== @@ -10,7 +9,7 @@ Shows, updates, and deletes quotas for a tenant. Show quota details for user (v1) -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{admin_tenant_id}/os-quota-sets/{tenant_id}/detail/{user_id} @@ -59,7 +58,7 @@ Response Example :language: javascript Show default quotas -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/os-quota-sets/defaults @@ -108,7 +107,7 @@ Response Example Show quotas (v1) -================ +~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{admin_tenant_id}/os-quota-sets/{tenant_id} @@ -160,7 +159,7 @@ Response Example Update quotas (v1) -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v1/{admin_tenant_id}/os-quota-sets/{tenant_id} @@ -231,7 +230,7 @@ Response Example Delete quotas (v1) -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v1/{admin_tenant_id}/os-quota-sets/{tenant_id} @@ -255,7 +254,7 @@ Response Example :language: javascript Show quotas for user (v1) -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} @@ -310,7 +309,7 @@ Response Example Update quotas for user (v1) -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v1/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} @@ -382,7 +381,7 @@ Response Example Delete quotas for user (v1) -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v1/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} diff --git a/api-ref/source/v1/volumes-v1-snapshots.inc b/api-ref/source/v1/volumes-v1-snapshots.inc index 65dd065bb9f..e246aa98bd7 100644 --- a/api-ref/source/v1/volumes-v1-snapshots.inc +++ b/api-ref/source/v1/volumes-v1-snapshots.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -========= Snapshots ========= @@ -9,7 +8,7 @@ and updates snapshot metadata. Show snapshot details (v1) -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/snapshots/{snapshot_id} @@ -35,7 +34,7 @@ Response Example Delete snapshot (v1) -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v1/{tenant_id}/snapshots/{snapshot_id} @@ -54,7 +53,7 @@ Request List snapshots with details (v1) -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/snapshots/detail @@ -79,7 +78,7 @@ Response Example Create snapshot (v1) -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v1/{tenant_id}/snapshots @@ -102,7 +101,7 @@ Request Example :language: javascript List snapshots (v1) -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/snapshots @@ -129,7 +128,7 @@ Response Example Show snapshot metadata (v1) -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/snapshots/{snapshot_id}/metadata @@ -157,7 +156,7 @@ Response Example Update snapshot metadata (v1) -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v1/{tenant_id}/snapshots/{snapshot_id}/metadata diff --git a/api-ref/source/v1/volumes-v1-types.inc b/api-ref/source/v1/volumes-v1-types.inc index 2b060ed894c..2f0cb9ffcf4 100644 --- a/api-ref/source/v1/volumes-v1-types.inc +++ b/api-ref/source/v1/volumes-v1-types.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============ Volume types ============ @@ -9,7 +8,7 @@ types. List volume types (v1) -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/types @@ -35,7 +34,7 @@ Response Example Create volume type (v1) -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v1/{tenant_id}/types @@ -79,7 +78,7 @@ Response Example Update volume type (v1) -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v1/{tenant_id}/types/{volume_type_id} @@ -126,7 +125,7 @@ Response Example Update extra specs for a volume type (v1) -========================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v1/{tenant_id}/types/{volume_type_id} @@ -172,7 +171,7 @@ Response Example Show volume type details (v1) -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/types/{volume_type_id} @@ -200,7 +199,7 @@ Response Example Delete volume type (v1) -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v1/{tenant_id}/types/{volume_type_id} diff --git a/api-ref/source/v1/volumes-v1-versions.inc b/api-ref/source/v1/volumes-v1-versions.inc index a9ca0513e2f..f260a36210c 100644 --- a/api-ref/source/v1/volumes-v1-versions.inc +++ b/api-ref/source/v1/volumes-v1-versions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============ API versions ============ @@ -8,7 +7,7 @@ Lists information about API versions. Show API v1 details -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1 @@ -31,7 +30,7 @@ Response Example List API versions (v1) -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET / diff --git a/api-ref/source/v1/volumes-v1-volumes.inc b/api-ref/source/v1/volumes-v1-volumes.inc index 8c4ee975e4a..520d54f28d7 100644 --- a/api-ref/source/v1/volumes-v1-volumes.inc +++ b/api-ref/source/v1/volumes-v1-volumes.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -======= Volumes ======= @@ -11,7 +10,7 @@ values are null. List volumes, with details (v1) -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/volumes/detail @@ -66,7 +65,7 @@ Response Example Create volume (v1) -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v1/{tenant_id}/volumes @@ -123,7 +122,7 @@ Response Parameters List volumes (v1) -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/volumes @@ -161,7 +160,7 @@ Response Example Show volume details (v1) -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v1/{tenant_id}/volumes/{volume_id} @@ -216,7 +215,7 @@ Response Example :language: javascript Delete volume (v1) -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v1/{tenant_id}/volumes/{volume_id} diff --git a/api-ref/source/v2/api-versions.inc b/api-ref/source/v2/api-versions.inc index 367a98a93f8..7dbc4761a9b 100644 --- a/api-ref/source/v2/api-versions.inc +++ b/api-ref/source/v2/api-versions.inc @@ -14,10 +14,10 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) Request -------- +~~~~~~~ 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 59e32fb03ad..c8f872068d1 100644 --- a/api-ref/source/v2/capabilities-v2.inc +++ b/api-ref/source/v2/capabilities-v2.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================================= Capabilities for storage back ends (capabilities) ================================================= @@ -8,7 +7,7 @@ Shows capabilities for a storage back end. Show back-end capabilities -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/capabilities/{hostname} diff --git a/api-ref/source/v2/consistencygroups-v2.inc b/api-ref/source/v2/consistencygroups-v2.inc index afbec42b5bb..da8458fb7d3 100644 --- a/api-ref/source/v2/consistencygroups-v2.inc +++ b/api-ref/source/v2/consistencygroups-v2.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================== Consistency groups ================== @@ -16,7 +15,7 @@ to limit roles. List consistency groups -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/consistencygroups @@ -55,7 +54,7 @@ Response Example Create consistency group -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/consistencygroups @@ -101,7 +100,7 @@ Response Example :language: javascript Show consistency group details -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/consistencygroups/{consistencygroup_id} @@ -139,7 +138,7 @@ Response Example Create consistency group from source -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/consistencygroups/create_from_src @@ -170,7 +169,7 @@ Request Example Delete consistency group -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/consistencygroups/{consistencygroup_id}/delete @@ -196,7 +195,7 @@ Request Example List consistency groups with details -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/consistencygroups/detail @@ -240,7 +239,7 @@ Response Example Update consistency group -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/consistencygroups/{consistencygroup_id}/update diff --git a/api-ref/source/v2/ext-backups-actions-v2.inc b/api-ref/source/v2/ext-backups-actions-v2.inc index b1a17ca91d7..5a2f4c4791b 100644 --- a/api-ref/source/v2/ext-backups-actions-v2.inc +++ b/api-ref/source/v2/ext-backups-actions-v2.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================ Backup actions (backups, action) ================================ @@ -8,7 +7,7 @@ Force-deletes a backup. Force-delete backup -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/backups/{backup_id}/action diff --git a/api-ref/source/v2/ext-backups.inc b/api-ref/source/v2/ext-backups.inc index ae92f0ab1eb..708fdb1b7e3 100644 --- a/api-ref/source/v2/ext-backups.inc +++ b/api-ref/source/v2/ext-backups.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================= Backups (backups) ================= @@ -39,7 +38,7 @@ in the ``fail_reason`` field for the backup. List backups with details -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/backups/detail @@ -92,7 +91,7 @@ Response Example Show backup details -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/backups/{backup_id} @@ -142,7 +141,7 @@ Response Example Delete backup -============= +~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{tenant_id}/backups/{backup_id} @@ -161,7 +160,7 @@ Request Restore backup -============== +~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/backups/{backup_id}/restore @@ -200,7 +199,7 @@ Response Parameters - volume_id: volume_id Create backup -============= +~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/backups @@ -239,7 +238,7 @@ Response Parameters - name: name List backups -============ +~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/backups diff --git a/api-ref/source/v2/limits.inc b/api-ref/source/v2/limits.inc index 0abdc8cffee..a2ac731e7e7 100644 --- a/api-ref/source/v2/limits.inc +++ b/api-ref/source/v2/limits.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============== Limits (limits) =============== @@ -11,7 +10,7 @@ for the item is infinite. Show absolute limits -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/limits diff --git a/api-ref/source/v2/os-cgsnapshots-v2.inc b/api-ref/source/v2/os-cgsnapshots-v2.inc index de6060102af..08339f67856 100644 --- a/api-ref/source/v2/os-cgsnapshots-v2.inc +++ b/api-ref/source/v2/os-cgsnapshots-v2.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=========================== Consistency group snapshots =========================== @@ -9,7 +8,7 @@ deletes consistency group snapshots. Delete consistency group snapshot -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{tenant_id}/cgsnapshots/{cgsnapshot_id} @@ -28,7 +27,7 @@ Request Show consistency group snapshot details -======================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/cgsnapshots/{cgsnapshot_id} @@ -68,7 +67,7 @@ Response Example List consistency group snapshots with details -============================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/cgsnapshots/detail @@ -105,7 +104,7 @@ Response Example :language: javascript List consistency group snapshots -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/cgsnapshots @@ -144,7 +143,7 @@ Response Example Create consistency group snapshot -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/cgsnapshots diff --git a/api-ref/source/v2/os-vol-image-meta-v2.inc b/api-ref/source/v2/os-vol-image-meta-v2.inc index 908a521bb78..f6def86b150 100644 --- a/api-ref/source/v2/os-vol-image-meta-v2.inc +++ b/api-ref/source/v2/os-vol-image-meta-v2.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=================================================== Volume image metadata extension (os-vol-image-meta) =================================================== @@ -8,7 +7,7 @@ Shows image metadata that is associated with a volume. Show image metadata for volume -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/os-vol-image-meta diff --git a/api-ref/source/v2/os-vol-pool-v2.inc b/api-ref/source/v2/os-vol-pool-v2.inc index f7afde10b8d..67361ecd142 100644 --- a/api-ref/source/v2/os-vol-pool-v2.inc +++ b/api-ref/source/v2/os-vol-pool-v2.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -====================== Back-end storage pools ====================== @@ -9,7 +8,7 @@ to the scheduler service. List back-end storage pools -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/scheduler-stats/get_pools diff --git a/api-ref/source/v2/os-vol-transfer-v2.inc b/api-ref/source/v2/os-vol-transfer-v2.inc index 5026f11b8e8..b25bb5daba8 100644 --- a/api-ref/source/v2/os-vol-transfer-v2.inc +++ b/api-ref/source/v2/os-vol-transfer-v2.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============== Volume transfer =============== @@ -8,7 +7,7 @@ Transfers a volume from one user to another user. Accept volume transfer -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/os-volume-transfer/{transfer_id}/accept @@ -46,7 +45,7 @@ Response Parameters Create volume transfer -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/os-volume-transfer @@ -85,7 +84,7 @@ Response Parameters List volume transfers -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/os-volume-transfer @@ -123,7 +122,7 @@ Response Example Show volume transfer details -============================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/os-volume-transfer/{transfer_id} @@ -163,7 +162,7 @@ Response Example Delete volume transfer -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{tenant_id}/os-volume-transfer/{transfer_id} @@ -182,7 +181,7 @@ Request List volume transfers, with details -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/os-volume-transfer/detail 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 7867712b178..e05ecb2215e 100644 --- a/api-ref/source/v2/qos-specs-v2-qos-specs.inc +++ b/api-ref/source/v2/qos-specs-v2-qos-specs.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=================================================== Quality of service (QoS) specifications (qos-specs) =================================================== @@ -12,7 +11,7 @@ specifications. Disassociate QoS specification from all associations -==================================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/disassociate_all @@ -31,7 +30,7 @@ Request Unset keys in QoS specification -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/qos-specs/{qos_id}/delete_keys @@ -67,7 +66,7 @@ Response Example Get all associations for QoS specification -========================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/associations @@ -95,7 +94,7 @@ Response Example Associate QoS specification with volume type -============================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/associate @@ -114,7 +113,7 @@ Request Disassociate QoS specification from volume type -=============================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id}/disassociate @@ -133,7 +132,7 @@ Request Show QoS specification details -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/qos-specs/{qos_id} @@ -174,7 +173,7 @@ Response Example Set keys in QoS specification -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/qos-specs/{qos_id} @@ -210,7 +209,7 @@ Response Example Delete QoS specification -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{tenant_id}/qos-specs/{qos_id} @@ -230,7 +229,7 @@ Request Create QoS specification -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/qos-specs @@ -273,7 +272,7 @@ Response Parameters List QoS specs -============== +~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/qos-specs diff --git a/api-ref/source/v2/quota-sets.inc b/api-ref/source/v2/quota-sets.inc index 49df485cffd..24bf1551e91 100644 --- a/api-ref/source/v2/quota-sets.inc +++ b/api-ref/source/v2/quota-sets.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -==================================== Quota sets extension (os-quota-sets) ==================================== @@ -10,7 +9,7 @@ Shows, updates, and deletes quotas for a tenant. Show quotas for user -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} @@ -60,7 +59,7 @@ Response Example Update quotas for user -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} @@ -131,7 +130,7 @@ Response Example :language: javascript Delete quotas for user -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/{user_id} @@ -159,7 +158,7 @@ Response Example Show quotas -=========== +~~~~~~~~~~~ .. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id} @@ -210,7 +209,7 @@ Response Example :language: javascript Update quotas -============= +~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{admin_tenant_id}/os-quota-sets/{tenant_id} @@ -281,7 +280,7 @@ Response Example :language: javascript Delete quotas -============= +~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{admin_tenant_id}/os-quota-sets/{tenant_id} @@ -307,7 +306,7 @@ Response Example :language: javascript Show quota details for user -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{admin_tenant_id}/os-quota-sets/{tenant_id}/detail/{user_id} @@ -358,7 +357,7 @@ Response Example Get default quotas -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/os-quota-sets/defaults diff --git a/api-ref/source/v2/volume-manage.inc b/api-ref/source/v2/volume-manage.inc index 756db65a1b1..ca25ceac82b 100644 --- a/api-ref/source/v2/volume-manage.inc +++ b/api-ref/source/v2/volume-manage.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -========================================== Volume manage extension (os-volume-manage) ========================================== @@ -9,7 +8,7 @@ storage. Manage existing volume -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/os-volume-manage diff --git a/api-ref/source/v2/volume-type-access.inc b/api-ref/source/v2/volume-type-access.inc index 1880d8df805..d69d524d6b8 100644 --- a/api-ref/source/v2/volume-type-access.inc +++ b/api-ref/source/v2/volume-type-access.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============================ Volume type access (volumes) ============================ @@ -15,7 +14,7 @@ users with the administrative role and context. Add private volume type access -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/types/{volume_type}/action @@ -41,7 +40,7 @@ Request Example Remove private volume type access -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/types/{volume_type}/action @@ -67,7 +66,7 @@ Request Example List private volume type access details -======================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/types/{volume_type}/os-volume-type-access diff --git a/api-ref/source/v2/volumes-v2-extensions.inc b/api-ref/source/v2/volumes-v2-extensions.inc index 64fd3734c2e..aa236689b50 100644 --- a/api-ref/source/v2/volumes-v2-extensions.inc +++ b/api-ref/source/v2/volumes-v2-extensions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=========================== API extensions (extensions) =========================== @@ -8,7 +7,7 @@ API extensions (extensions) List API extensions -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/extensions diff --git a/api-ref/source/v2/volumes-v2-snapshots.inc b/api-ref/source/v2/volumes-v2-snapshots.inc index a4618d01bfd..9080e25eb16 100644 --- a/api-ref/source/v2/volumes-v2-snapshots.inc +++ b/api-ref/source/v2/volumes-v2-snapshots.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============================ Volume snapshots (snapshots) ============================ @@ -28,7 +27,7 @@ possible: List snapshots with details -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/snapshots/detail @@ -71,7 +70,7 @@ Response Example Create snapshot -=============== +~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/snapshots @@ -115,7 +114,7 @@ Response Parameters List snapshots -============== +~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/snapshots @@ -160,7 +159,7 @@ Response Example Show snapshot metadata -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/snapshots/{snapshot_id}/metadata @@ -205,7 +204,7 @@ Response Example Update snapshot metadata -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/snapshots/{snapshot_id}/metadata @@ -243,7 +242,7 @@ Response Example Show snapshot details -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/snapshots/{snapshot_id} @@ -288,7 +287,7 @@ Response Example Update snapshot -=============== +~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/snapshots/{snapshot_id} @@ -341,7 +340,7 @@ Response Example Delete snapshot -=============== +~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{tenant_id}/snapshots/{snapshot_id} diff --git a/api-ref/source/v2/volumes-v2-types.inc b/api-ref/source/v2/volumes-v2-types.inc index 97509d137e3..0f8b54c9cad 100644 --- a/api-ref/source/v2/volumes-v2-types.inc +++ b/api-ref/source/v2/volumes-v2-types.inc @@ -1,12 +1,11 @@ .. -*- rst -*- -==================== Volume types (types) ==================== Update volume type -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/types/{volume_type_id} @@ -66,7 +65,7 @@ Response Example Update extra specs for a volume type -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/types/{volume_type_id} @@ -115,7 +114,7 @@ Response Example Show volume type details -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/types/{volume_type_id} @@ -154,7 +153,7 @@ Response Example Delete volume type -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{tenant_id}/types/{volume_type_id} @@ -173,7 +172,7 @@ Request List volume types -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/types @@ -214,7 +213,7 @@ Response Example Create volume type -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/types diff --git a/api-ref/source/v2/volumes-v2-versions.inc b/api-ref/source/v2/volumes-v2-versions.inc index c765b1427b3..6a010952461 100644 --- a/api-ref/source/v2/volumes-v2-versions.inc +++ b/api-ref/source/v2/volumes-v2-versions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============ API versions ============ @@ -8,7 +7,7 @@ API versions List API versions -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: GET / @@ -32,7 +31,7 @@ Response Example Show API v2 details -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2 diff --git a/api-ref/source/v2/volumes-v2-volumes-actions.inc b/api-ref/source/v2/volumes-v2-volumes-actions.inc index 347a86a8e97..dc5d8d4be6e 100644 --- a/api-ref/source/v2/volumes-v2-volumes-actions.inc +++ b/api-ref/source/v2/volumes-v2-volumes-actions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================ Volume actions (volumes, action) ================================ @@ -12,7 +11,7 @@ storage object associated with it. Extend volume size -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action @@ -59,7 +58,7 @@ Request Example Reset volume statuses -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action @@ -93,7 +92,7 @@ Request Example Set image metadata for volume -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action @@ -125,7 +124,7 @@ Request Example Remove image metadata from volume -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action @@ -157,7 +156,7 @@ Request Example Attach volume to server -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action @@ -197,7 +196,7 @@ Request Example Detach volume from a server -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action @@ -236,7 +235,7 @@ Request Example Unmanage volume -=============== +~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action @@ -271,7 +270,7 @@ Request Example Force detach volume -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/action diff --git a/api-ref/source/v2/volumes-v2-volumes.inc b/api-ref/source/v2/volumes-v2-volumes.inc index 26a48bbd7a3..ed29967e285 100644 --- a/api-ref/source/v2/volumes-v2-volumes.inc +++ b/api-ref/source/v2/volumes-v2-volumes.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================= Volumes (volumes) ================= @@ -45,7 +44,7 @@ status values are: List volumes with details -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/volumes/detail @@ -113,7 +112,7 @@ Response Example Create volume -============= +~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes @@ -213,7 +212,7 @@ Response Parameters List volumes -============ +~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/volumes @@ -257,7 +256,7 @@ Response Example Show volume details -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/volumes/{volume_id} @@ -327,7 +326,7 @@ Response Example Update volume -============= +~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/volumes/{volume_id} @@ -398,7 +397,7 @@ Response Example Delete volume -============= +~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/{tenant_id}/volumes/{volume_id} @@ -446,7 +445,7 @@ Request Create volume metadata -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{tenant_id}/volumes/{volume_id}/metadata @@ -489,7 +488,7 @@ Response Example Show volume metadata -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/{tenant_id}/volumes/{volume_id}/metadata @@ -528,7 +527,7 @@ Response Example Update volume metadata -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/{tenant_id}/volumes/{volume_id}/metadata diff --git a/api-ref/source/v3/api-versions.inc b/api-ref/source/v3/api-versions.inc index 99e768dabdd..a112640ef11 100644 --- a/api-ref/source/v3/api-versions.inc +++ b/api-ref/source/v3/api-versions.inc @@ -14,10 +14,10 @@ Error response codes: computeFault(400, 500), serviceUnavailable(503), badReques unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), conflict(409) Request -------- +~~~~~~~ Response --------- +~~~~~~~~ **Example List Api Versions: JSON request** diff --git a/api-ref/source/v3/capabilities-v3.inc b/api-ref/source/v3/capabilities-v3.inc index ee7991a7edc..3f4af560bf5 100644 --- a/api-ref/source/v3/capabilities-v3.inc +++ b/api-ref/source/v3/capabilities-v3.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================================= Capabilities for storage back ends (capabilities) ================================================= @@ -8,7 +7,7 @@ Shows capabilities for a storage back end. Show all back-end capabilities -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/capabilities/{hostname} diff --git a/api-ref/source/v3/consistencygroups-v3.inc b/api-ref/source/v3/consistencygroups-v3.inc index ee6610afb06..20f7004dc76 100644 --- a/api-ref/source/v3/consistencygroups-v3.inc +++ b/api-ref/source/v3/consistencygroups-v3.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================== Consistency groups ================== @@ -16,7 +15,7 @@ to limit roles. List project's consistency groups -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/consistencygroups @@ -55,7 +54,7 @@ Response Example Create a consistency group -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/consistencygroups @@ -101,7 +100,7 @@ Response Example :language: javascript Show a consistency group's details -================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/consistencygroups/{consistencygroup_id} @@ -139,7 +138,7 @@ Response Example Create a consistency group from source -====================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/consistencygroups/create_from_src @@ -170,7 +169,7 @@ Request Example Delete a consistency group -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/consistencygroups/{consistencygroup_id}/delete @@ -196,7 +195,7 @@ Request Example List consistency groups and details -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/consistencygroups/detail @@ -240,7 +239,7 @@ Response Example Update a consistency group -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/consistencygroups/{consistencygroup_id}/update diff --git a/api-ref/source/v3/ext-backups-actions-v3.inc b/api-ref/source/v3/ext-backups-actions-v3.inc index 52164a8fefb..cbd0e50cbdc 100644 --- a/api-ref/source/v3/ext-backups-actions-v3.inc +++ b/api-ref/source/v3/ext-backups-actions-v3.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================ Backup actions (backups, action) ================================ @@ -8,7 +7,7 @@ Force-deletes a backup. Force-delete a backup -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/backups/{backup_id}/action diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index efe94f70ab0..fb9b0910d53 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================= Backups (backups) ================= @@ -39,7 +38,7 @@ in the ``fail_reason`` field for the backup. List backups with detail -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/backups/detail @@ -92,7 +91,7 @@ Response Example Show backup detail -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/backups/{backup_id} @@ -142,7 +141,7 @@ Response Example Delete a backup -=============== +~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/backups/{backup_id} @@ -160,7 +159,7 @@ Request Restore a backup -================ +~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/backups/{backup_id}/restore @@ -199,7 +198,7 @@ Response Parameters - volume_id: volume_id Create a backup -=============== +~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/backups @@ -238,7 +237,7 @@ Response Parameters - name: name List backups for project -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/backups diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index ccecedb2841..ed47cfe3e11 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============== Group snapshots =============== @@ -9,7 +8,7 @@ deletes group snapshots. Delete group snapshot -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/group_snapshots/{group_snapshot_id} @@ -29,7 +28,7 @@ Request Show group snapshot details -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/group_snapshots/{group_snapshot_id} @@ -69,7 +68,7 @@ Response Example List group snapshots with details -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/group_snapshots/detail @@ -106,7 +105,7 @@ Response Example :language: javascript List group snapshots -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/group_snapshots @@ -142,7 +141,7 @@ Response Example Create group snapshot -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/group_snapshots diff --git a/api-ref/source/v3/group-types.inc b/api-ref/source/v3/group-types.inc index 9c0b2ba6a31..d3b79ba8c30 100644 --- a/api-ref/source/v3/group-types.inc +++ b/api-ref/source/v3/group-types.inc @@ -1,12 +1,11 @@ .. -*- rst -*- -=========== Group types =========== Update group type -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/group_types/{group_type_id} @@ -54,7 +53,7 @@ Response Example Create group specs for a group type -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/group_types/{group_type_id}/group_specs @@ -103,7 +102,7 @@ Response Example Show group type details -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/group_types/{group_type_id} @@ -142,7 +141,7 @@ Response Example Delete group type -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/group_types/{group_type_id} @@ -162,7 +161,7 @@ Request List group types -================ +~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/group_types @@ -203,7 +202,7 @@ Response Example Create group type -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/group_types diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index 6feda82d03e..05b3bcd070c 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -===================== Generic volume groups ===================== @@ -19,7 +18,7 @@ groups can be extended to support other features in the future. List groups -=========== +~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/groups @@ -58,7 +57,7 @@ Response Example Create group -============ +~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/groups @@ -88,7 +87,7 @@ Request Example Show group details -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/groups/{group_id} @@ -127,7 +126,7 @@ Response Example Create group from source -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/groups/action @@ -156,7 +155,7 @@ Request Example Delete group -============ +~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/groups/{group_id}/action @@ -183,7 +182,7 @@ Request Example List groups with details -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/groups/detail @@ -228,7 +227,7 @@ Response Example Update group -============ +~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/groups/{group_id} diff --git a/api-ref/source/v3/limits.inc b/api-ref/source/v3/limits.inc index 325b4eaa502..05851b0ba7f 100644 --- a/api-ref/source/v3/limits.inc +++ b/api-ref/source/v3/limits.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============== Limits (limits) =============== @@ -11,7 +10,7 @@ for the item is infinite. Show absolute limits for project -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/limits diff --git a/api-ref/source/v3/os-cgsnapshots-v3.inc b/api-ref/source/v3/os-cgsnapshots-v3.inc index 6b86ec7ae6c..494a1674d81 100644 --- a/api-ref/source/v3/os-cgsnapshots-v3.inc +++ b/api-ref/source/v3/os-cgsnapshots-v3.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=========================== Consistency group snapshots =========================== @@ -9,7 +8,7 @@ deletes consistency group snapshots. Delete a consistency group snapshot -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/cgsnapshots/{cgsnapshot_id} @@ -28,7 +27,7 @@ Request Show consistency group snapshot detail -====================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/cgsnapshots/{cgsnapshot_id} @@ -68,7 +67,7 @@ Response Example List all consistency group snapshots with details -================================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/cgsnapshots/detail @@ -105,7 +104,7 @@ Response Example :language: javascript List all consistency group snapshots -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/cgsnapshots @@ -144,7 +143,7 @@ Response Example Create a consistency group snapshot -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/cgsnapshots diff --git a/api-ref/source/v3/os-vol-image-meta-v3.inc b/api-ref/source/v3/os-vol-image-meta-v3.inc index c9a3dd63403..ee95e11cc99 100644 --- a/api-ref/source/v3/os-vol-image-meta-v3.inc +++ b/api-ref/source/v3/os-vol-image-meta-v3.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=================================================== Volume image metadata extension (os-vol-image-meta) =================================================== @@ -8,7 +7,7 @@ Shows image metadata that is associated with a volume. Show image metadata for a volume -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/os-vol-image-meta diff --git a/api-ref/source/v3/os-vol-pool-v3.inc b/api-ref/source/v3/os-vol-pool-v3.inc index e1c02a8a0c6..1345ea3473b 100644 --- a/api-ref/source/v3/os-vol-pool-v3.inc +++ b/api-ref/source/v3/os-vol-pool-v3.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -====================== Back-end storage pools ====================== @@ -9,7 +8,7 @@ to the scheduler service. List all back-end storage pools -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/scheduler-stats/get_pools diff --git a/api-ref/source/v3/os-vol-transfer-v3.inc b/api-ref/source/v3/os-vol-transfer-v3.inc index 84ffd05519a..d57c902e93b 100644 --- a/api-ref/source/v3/os-vol-transfer-v3.inc +++ b/api-ref/source/v3/os-vol-transfer-v3.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============== Volume transfer =============== @@ -8,7 +7,7 @@ Transfers a volume from one user to another user. Accept a volume transfer -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/os-volume-transfer/{transfer_id}/accept @@ -46,7 +45,7 @@ Response Parameters Create a volume transfer -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/os-volume-transfer @@ -85,7 +84,7 @@ Response Parameters List volume transfers for a project -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/os-volume-transfer @@ -123,7 +122,7 @@ Response Example Show volume transfer detail -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/os-volume-transfer/{transfer_id} @@ -163,7 +162,7 @@ Response Example Delete a volume transfer -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/os-volume-transfer/{transfer_id} @@ -182,7 +181,7 @@ Request List volume transfers and details -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/os-volume-transfer/detail 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 7250461bdae..bba67967714 100644 --- a/api-ref/source/v3/qos-specs-v3-qos-specs.inc +++ b/api-ref/source/v3/qos-specs-v3-qos-specs.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=================================================== Quality of service (QoS) specifications (qos-specs) =================================================== @@ -12,7 +11,7 @@ specifications. Disassociate a QoS specification from all associations -====================================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/disassociate_all @@ -31,7 +30,7 @@ Request Unset keys in a QoS specification -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/qos-specs/{qos_id}/delete_keys @@ -67,7 +66,7 @@ Response Example Get all associations for a QoS specification -============================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/associations @@ -95,7 +94,7 @@ Response Example Associate QoS specification with a volume type -============================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/associate @@ -114,7 +113,7 @@ Request Disassociate QoS specification from a volume type -================================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id}/disassociate @@ -133,7 +132,7 @@ Request Show a QoS specification details -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/qos-specs/{qos_id} @@ -174,7 +173,7 @@ Response Example Set keys in a QoS specification -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/qos-specs/{qos_id} @@ -210,7 +209,7 @@ Response Example Delete a QoS specification -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/qos-specs/{qos_id} @@ -230,7 +229,7 @@ Request Create a QoS specification -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/qos-specs @@ -273,7 +272,7 @@ Response Parameters List QoS Specifications -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/qos-specs diff --git a/api-ref/source/v3/quota-sets.inc b/api-ref/source/v3/quota-sets.inc index 2dc87f9a6ec..1e51ed1446a 100644 --- a/api-ref/source/v3/quota-sets.inc +++ b/api-ref/source/v3/quota-sets.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -==================================== Quota sets extension (os-quota-sets) ==================================== @@ -10,7 +9,7 @@ Shows, updates, and deletes quotas for a project. Show quotas for a user -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} @@ -60,7 +59,7 @@ Response Example Update quotas for a user -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} @@ -131,7 +130,7 @@ Response Example :language: javascript Delete quotas for a user -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{admin_project_id}/os-quota-sets/{project_id}/{user_id} @@ -159,7 +158,7 @@ Response Example Show quotas for a project -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id} @@ -210,7 +209,7 @@ Response Example :language: javascript Update quotas for a project -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{admin_project_id}/os-quota-sets/{project_id} @@ -281,7 +280,7 @@ Response Example :language: javascript Delete quotas for a project -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{admin_project_id}/os-quota-sets/{project_id} @@ -307,7 +306,7 @@ Response Example :language: javascript Show quota details for a user -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{admin_project_id}/os-quota-sets/{project_id}/detail/{user_id} @@ -358,7 +357,7 @@ Response Example Get default quotas for a project -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/os-quota-sets/defaults diff --git a/api-ref/source/v3/volume-manage.inc b/api-ref/source/v3/volume-manage.inc index f91a161a734..0b17df9efb6 100644 --- a/api-ref/source/v3/volume-manage.inc +++ b/api-ref/source/v3/volume-manage.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -========================================== Volume manage extension (os-volume-manage) ========================================== @@ -9,7 +8,7 @@ storage. Manage an existing volume -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/os-volume-manage diff --git a/api-ref/source/v3/volume-type-access.inc b/api-ref/source/v3/volume-type-access.inc index 737459c4fb7..f4d80310ca5 100644 --- a/api-ref/source/v3/volume-type-access.inc +++ b/api-ref/source/v3/volume-type-access.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============================ Volume type access (volumes) ============================ @@ -15,7 +14,7 @@ users with the administrative role and context. Add private volume type access to project -========================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/types/{volume_type}/action @@ -41,7 +40,7 @@ Request Example Remove private volume type access from project -============================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/types/{volume_type}/action @@ -67,7 +66,7 @@ Request Example List private volume type access detail -====================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/types/{volume_type}/os-volume-type-access diff --git a/api-ref/source/v3/volumes-v3-extensions.inc b/api-ref/source/v3/volumes-v3-extensions.inc index a17fff0254e..77122fee6bb 100644 --- a/api-ref/source/v3/volumes-v3-extensions.inc +++ b/api-ref/source/v3/volumes-v3-extensions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=========================== API extensions (extensions) =========================== @@ -8,7 +7,7 @@ API extensions (extensions) List Known API extensions -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/extensions diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index ddecfcd25bd..e3304f85283 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============================ Volume snapshots (snapshots) ============================ @@ -28,7 +27,7 @@ possible: List snapshots and details -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/snapshots/detail @@ -71,7 +70,7 @@ Response Example Create a snapshot -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/snapshots @@ -115,7 +114,7 @@ Response Parameters List accessible snapshots -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/snapshots @@ -160,7 +159,7 @@ Response Example Show a snapshot's metadata -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/snapshots/{snapshot_id}/metadata @@ -205,7 +204,7 @@ Response Example Update a snapshot's metadata -============================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/snapshots/{snapshot_id}/metadata @@ -243,7 +242,7 @@ Response Example Show a snapshot's details -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/snapshots/{snapshot_id} @@ -288,7 +287,7 @@ Response Example Update a snapshot -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/snapshots/{snapshot_id} @@ -341,7 +340,7 @@ Response Example Delete a snapshot -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/snapshots/{snapshot_id} diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc index d0bca284cb3..95e40275f40 100644 --- a/api-ref/source/v3/volumes-v3-types.inc +++ b/api-ref/source/v3/volumes-v3-types.inc @@ -1,12 +1,11 @@ .. -*- rst -*- -==================== Volume types (types) ==================== Update a volume type -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/types/{volume_type_id} @@ -66,7 +65,7 @@ Response Example Update extra specs for volume type -================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/types/{volume_type_id} @@ -115,7 +114,7 @@ Response Example Show volume type detail -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/types/{volume_type_id} @@ -154,7 +153,7 @@ Response Example Delete a volume type -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/types/{volume_type_id} @@ -173,7 +172,7 @@ Request List all volume types -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/types @@ -214,7 +213,7 @@ Response Example Create a volume type -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/types @@ -272,7 +271,7 @@ Response Example :language: javascript Show an encryption type -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/types/{volume_type_id}/encryption @@ -318,7 +317,7 @@ Response Example Delete an encryption type -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/types/{volume_type_id}/encryption/{encryption_id} @@ -341,7 +340,7 @@ Request Create an encryption type -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/types/{volume_type_id}/encryption @@ -394,7 +393,7 @@ Response Example Update an encryption type -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/types/{volume_type_id}/encryption/{encryption_id} diff --git a/api-ref/source/v3/volumes-v3-versions.inc b/api-ref/source/v3/volumes-v3-versions.inc index b190bc9cf5d..c8895595331 100644 --- a/api-ref/source/v3/volumes-v3-versions.inc +++ b/api-ref/source/v3/volumes-v3-versions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============ API versions ============ @@ -8,7 +7,7 @@ API versions List Known API versions -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET / @@ -33,7 +32,7 @@ Response Example Show API v3 details -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3 diff --git a/api-ref/source/v3/volumes-v3-volumes-actions.inc b/api-ref/source/v3/volumes-v3-volumes-actions.inc index f20a48fd01a..8b090abcc6a 100644 --- a/api-ref/source/v3/volumes-v3-volumes-actions.inc +++ b/api-ref/source/v3/volumes-v3-volumes-actions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================ Volume actions (volumes, action) ================================ @@ -12,7 +11,7 @@ storage object associated with it. Extend a volume size -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action @@ -59,7 +58,7 @@ Request Example Reset a volume's statuses -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action @@ -93,7 +92,7 @@ Request Example Set image metadata for a volume -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action @@ -125,7 +124,7 @@ Request Example Remove image metadata from a volume -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action @@ -157,7 +156,7 @@ Request Example Attach volume to a server -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action @@ -197,7 +196,7 @@ Request Example Unmanage a volume -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action @@ -232,7 +231,7 @@ Request Example Force detach a volume -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/action diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 592f65e0dee..14897a9fa8f 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================= Volumes (volumes) ================= @@ -45,7 +44,7 @@ status values are: List accessbile volumes with details -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/volumes/detail @@ -113,7 +112,7 @@ Response Example Create a volume -=============== +~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes @@ -213,7 +212,7 @@ Response Parameters List accessible volumes -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/volumes @@ -257,7 +256,7 @@ Response Example Show a volume's details -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/volumes/{volume_id} @@ -327,7 +326,7 @@ Response Example Update a volume -=============== +~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/volumes/{volume_id} @@ -398,7 +397,7 @@ Response Example Delete a volume -=============== +~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v3/{project_id}/volumes/{volume_id} @@ -446,7 +445,7 @@ Request Create metadata for volume -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v3/{project_id}/volumes/{volume_id}/metadata @@ -490,7 +489,7 @@ Response Example Show a volume's metadata -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/volumes/{volume_id}/metadata @@ -529,7 +528,7 @@ Response Example Update a volume's metadata -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v3/{project_id}/volumes/{volume_id}/metadata @@ -578,7 +577,7 @@ Response Example Get volumes summary -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v3/{project_id}/volumes/summary