From 88cec4f2c5bcf99c7c0c90f7f94488b8926f29a7 Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Fri, 25 Mar 2022 01:56:30 +0530 Subject: [PATCH] Fix headings in the API ref openstackdocstheme's custom styling doesn't display (h1) headings in the body of the API ref. To work-around this problem, demote the section headers and increase the display level of the toctree. Change-Id: I18b6ab44b62c4f17d854e5d32b4aef546992c79a Signed-off-by: Goutham Pacha Ravi --- api-ref/source/availability-zones.inc | 3 +-- api-ref/source/extensions.inc | 3 +-- api-ref/source/index.rst | 2 +- api-ref/source/limits.inc | 3 +-- api-ref/source/os-share-manage.inc | 5 ++-- api-ref/source/quota-classes.inc | 5 ++-- api-ref/source/quota-sets.inc | 11 ++++---- api-ref/source/scheduler-stats.inc | 5 ++-- api-ref/source/security-services.inc | 13 +++++----- api-ref/source/services.inc | 7 +++--- api-ref/source/share-access-rule-metadata.inc | 5 ++-- api-ref/source/share-access-rules.inc | 5 ++-- api-ref/source/share-actions.inc | 23 ++++++++--------- api-ref/source/share-export-locations.inc | 5 ++-- api-ref/source/share-group-snapshots.inc | 17 ++++++------- api-ref/source/share-group-types.inc | 21 ++++++++-------- api-ref/source/share-groups.inc | 13 +++++----- .../share-instance-export-locations.inc | 5 ++-- api-ref/source/share-instances.inc | 9 +++---- api-ref/source/share-metadata.inc | 11 ++++---- api-ref/source/share-migration.inc | 9 +++---- api-ref/source/share-network-subnets.inc | 9 +++---- api-ref/source/share-networks.inc | 25 +++++++++---------- .../source/share-replica-export-locations.inc | 5 ++-- api-ref/source/share-replicas.inc | 21 ++++++++-------- api-ref/source/share-server-migration.inc | 11 ++++---- api-ref/source/share-servers.inc | 15 ++++++----- api-ref/source/share-types.inc | 25 +++++++++---------- api-ref/source/shares.inc | 17 ++++++------- api-ref/source/snapshot-instances.inc | 9 +++---- api-ref/source/snapshots.inc | 21 ++++++++-------- api-ref/source/user-messages.inc | 7 +++--- api-ref/source/versions.inc | 7 +++--- 33 files changed, 160 insertions(+), 192 deletions(-) diff --git a/api-ref/source/availability-zones.inc b/api-ref/source/availability-zones.inc index d6883a24a6..32659e70ef 100644 --- a/api-ref/source/availability-zones.inc +++ b/api-ref/source/availability-zones.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================== Availability zones ================== @@ -14,7 +13,7 @@ configured with. List availability zones -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/availability-zones diff --git a/api-ref/source/extensions.inc b/api-ref/source/extensions.inc index 06694bb14d..f344034e47 100644 --- a/api-ref/source/extensions.inc +++ b/api-ref/source/extensions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============== API extensions ============== @@ -8,7 +7,7 @@ Lists available Shared File Systems API extensions. List extensions -=============== +~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/extensions diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 1ed059c8e5..e63ce92404 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,4 +1,4 @@ -:tocdepth: 2 +:tocdepth: 3 ======================= Shared File Systems API diff --git a/api-ref/source/limits.inc b/api-ref/source/limits.inc index 8d3cb8cafd..764240dc60 100644 --- a/api-ref/source/limits.inc +++ b/api-ref/source/limits.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -====== Limits ====== @@ -35,7 +34,7 @@ GET requests that can be processed during a one-minute period. List share limits -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/limits diff --git a/api-ref/source/os-share-manage.inc b/api-ref/source/os-share-manage.inc index 76c91f3137..db35ed3e4b 100644 --- a/api-ref/source/os-share-manage.inc +++ b/api-ref/source/os-share-manage.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -======================================= Manage and unmanage shares (DEPRECATED) ======================================= @@ -8,7 +7,7 @@ Allows bringing shared file systems under service management. Manage share (DEPRECATED) -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. warning:: @@ -100,7 +99,7 @@ Response example Unmanage share (DEPRECATED) -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. warning:: diff --git a/api-ref/source/quota-classes.inc b/api-ref/source/quota-classes.inc index f7e3a4f460..3703d8e3b3 100644 --- a/api-ref/source/quota-classes.inc +++ b/api-ref/source/quota-classes.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============== Quota class set =============== @@ -14,7 +13,7 @@ Quota classes can be shown and updated for a project. Show quota classes for a project -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/quota-class-sets/{quota_class_name} @@ -68,7 +67,7 @@ Response Example Update quota classes for a project -================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/quota-class-sets/{quota_class_name} diff --git a/api-ref/source/quota-sets.inc b/api-ref/source/quota-sets.inc index 837c95fa75..c32c28f4a9 100644 --- a/api-ref/source/quota-sets.inc +++ b/api-ref/source/quota-sets.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -========== Quota sets ========== @@ -35,7 +34,7 @@ Provides quotas management support. Show default quota set -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}/defaults @@ -89,7 +88,7 @@ Response example Show quota set -============== +~~~~~~~~~~~~~~ .. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id} @@ -148,7 +147,7 @@ Response example Show quota set in detail (since API v2.25) -========================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}/detail?user_id={user_id} @@ -209,7 +208,7 @@ Response example Update quota set -================ +~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id} @@ -286,7 +285,7 @@ Response example Delete quota set -================ +~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id} diff --git a/api-ref/source/scheduler-stats.inc b/api-ref/source/scheduler-stats.inc index 8588d53428..f005297290 100644 --- a/api-ref/source/scheduler-stats.inc +++ b/api-ref/source/scheduler-stats.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============================== Scheduler Stats - Storage Pools =============================== @@ -9,7 +8,7 @@ to the scheduler service. List back-end storage pools -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/scheduler-stats/pools?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type} @@ -59,7 +58,7 @@ Response example List back-end storage pools with details -======================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/scheduler-stats/pools/detail?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type} diff --git a/api-ref/source/security-services.inc b/api-ref/source/security-services.inc index 659482b305..60af10ae8c 100644 --- a/api-ref/source/security-services.inc +++ b/api-ref/source/security-services.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================= Security services ================= @@ -37,7 +36,7 @@ A security service resource can also be given a user defined name and description. List security services -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/security-services @@ -82,7 +81,7 @@ Response example List security services with details -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/security-services/detail @@ -137,7 +136,7 @@ Response example Show security service details -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/security-services/{security_service_id} @@ -193,7 +192,7 @@ Response example Create security service -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/security-services @@ -263,7 +262,7 @@ Response example Update security service -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/security-services/{security_service_id} @@ -340,7 +339,7 @@ Response example Delete security service -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/security-services/{security_service_id} diff --git a/api-ref/source/services.inc b/api-ref/source/services.inc index 4ecaf15c09..879d3e229d 100644 --- a/api-ref/source/services.inc +++ b/api-ref/source/services.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -======== Services ======== @@ -14,7 +13,7 @@ These APIs help in interacting with the Shared File Systems services, List services -============= +~~~~~~~~~~~~~ .. rest_method:: GET /v2/services?host={host}&binary={binary}&zone={zone}&state={state}&status={status} @@ -67,7 +66,7 @@ Response example Enable service -============== +~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/services/enable @@ -119,7 +118,7 @@ Response example Disable service -=============== +~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/services/disable diff --git a/api-ref/source/share-access-rule-metadata.inc b/api-ref/source/share-access-rule-metadata.inc index 5fd13cf8fb..e0de3cc2a4 100644 --- a/api-ref/source/share-access-rule-metadata.inc +++ b/api-ref/source/share-access-rule-metadata.inc @@ -1,13 +1,12 @@ .. -*- rst -*- -============================================ Share access rule metadata (since API v2.45) ============================================ Updates, and unsets share access rule metadata. Update share access rule metadata -================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/share-access-rules/{access_id}/metadata @@ -59,7 +58,7 @@ Response example Unset share access rule metadata -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-access-rules/{access_id}/metadata/{key} diff --git a/api-ref/source/share-access-rules.inc b/api-ref/source/share-access-rules.inc index e5f64c02ca..fad429064c 100644 --- a/api-ref/source/share-access-rules.inc +++ b/api-ref/source/share-access-rules.inc @@ -2,14 +2,13 @@ .. _get-access-rules-after-2-45: -==================================== Share access rules (since API v2.45) ==================================== Retrieve details about access rules Describe share access rule -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-access-rules/{access_id} @@ -63,7 +62,7 @@ Response example List share access rules -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-access-rules?share_id={share-id} diff --git a/api-ref/source/share-actions.inc b/api-ref/source/share-actions.inc index a370263073..51e35162d1 100644 --- a/api-ref/source/share-actions.inc +++ b/api-ref/source/share-actions.inc @@ -2,7 +2,6 @@ .. _get-access-rules-before-2-45: -============= Share actions ============= @@ -35,7 +34,7 @@ access_list": null} is valid for v1.0-2.6 Grant access -============ +~~~~~~~~~~~~ All manila shares begin with no access. Clients must be provided with explicit access via this API. @@ -131,7 +130,7 @@ Response example Revoke access -============= +~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -172,7 +171,7 @@ Request example List access rules (DEPRECATED) -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. warning:: @@ -240,7 +239,7 @@ Response example Reset share state -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -282,7 +281,7 @@ Request example Force-delete share -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -322,7 +321,7 @@ Request example Extend share -============ +~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -362,7 +361,7 @@ Request example Shrink share -============ +~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -400,7 +399,7 @@ Request example Unmanage share (since API v2.7) -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -461,7 +460,7 @@ There is no body content for the response. Revert share to snapshot (since API v2.27) -========================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -503,7 +502,7 @@ Request example Soft delete share (since API v2.69) -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -559,7 +558,7 @@ Request example Restore share (since API v2.69) -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action diff --git a/api-ref/source/share-export-locations.inc b/api-ref/source/share-export-locations.inc index 24fbb19b48..c8aa3e2877 100644 --- a/api-ref/source/share-export-locations.inc +++ b/api-ref/source/share-export-locations.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -======================================= Share export locations (since API v2.9) ======================================= @@ -13,7 +12,7 @@ locations of non-active share replicas can only be retrieved using the List export locations -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/shares/{share_id}/export_locations @@ -62,7 +61,7 @@ Response example Show single export location -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/shares/{share_id}/export_locations/​{export_location_id}​ diff --git a/api-ref/source/share-group-snapshots.inc b/api-ref/source/share-group-snapshots.inc index 18433e2968..1af3a2394a 100644 --- a/api-ref/source/share-group-snapshots.inc +++ b/api-ref/source/share-group-snapshots.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -======================================= Share group snapshots (since API v2.31) ======================================= @@ -23,7 +22,7 @@ roles. version 2.55. List share group snapshots -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-snapshots @@ -76,7 +75,7 @@ Response example List share group snapshots with details -======================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-snapshots/detail @@ -135,7 +134,7 @@ Response example List share group snapshots members -================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id}/members @@ -186,7 +185,7 @@ Response example Show share group snapshot details -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id} @@ -238,7 +237,7 @@ Response example Create share group snapshot -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-group-snapshots @@ -300,7 +299,7 @@ Response example Reset share group snapshot state -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-group-snapshots/{group_snapshot_id}/action @@ -342,7 +341,7 @@ Request example Update share group snapshot -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/share-group-snapshots/{group_snapshot_id} @@ -404,7 +403,7 @@ Response example Delete share group snapshot -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-group-snapshots/{group_snapshot_id} diff --git a/api-ref/source/share-group-types.inc b/api-ref/source/share-group-types.inc index 1f38e4a3f3..76984dd6b4 100644 --- a/api-ref/source/share-group-types.inc +++ b/api-ref/source/share-group-types.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=================================== Share group types (since API v2.31) =================================== @@ -37,7 +36,7 @@ share group type for the following purposes: version 2.55. List share group types -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-types @@ -81,7 +80,7 @@ Response example List default share group types -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-types/default @@ -130,7 +129,7 @@ Response example List share group types extra specs -================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-types/{share_group_type_id}/group_specs @@ -175,7 +174,7 @@ Response example Create share group type -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-group-types @@ -235,7 +234,7 @@ Response example Show share group type access details -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-group-types/{share_group_type_id}/share_type_access @@ -283,7 +282,7 @@ Response example Set extra spec for share group type -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-group-types/{share_group_type_id}/group_specs @@ -336,7 +335,7 @@ Response example Unset an group spec -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-group-types/{share_group_type_id}/group-specs/{group_spec_key} @@ -369,7 +368,7 @@ Request Add share group type access -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action @@ -412,7 +411,7 @@ Request example Remove share group type access -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action @@ -455,7 +454,7 @@ Request example Delete share group type -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-group-types/{share_group_type_id} diff --git a/api-ref/source/share-groups.inc b/api-ref/source/share-groups.inc index cc621a8e54..9ed964ac7d 100644 --- a/api-ref/source/share-groups.inc +++ b/api-ref/source/share-groups.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============================== Share groups (since API v2.31) ============================== @@ -23,7 +22,7 @@ share groups, and show information for delete a share group. fields were added to ``share_group`` object since version 2.34. List share groups -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share_groups @@ -87,7 +86,7 @@ Response example Show share group details -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share_groups/{share_group_id} @@ -146,7 +145,7 @@ Response example Create share group -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share_groups @@ -218,7 +217,7 @@ Response example Reset share group state -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-groups/{share_group_id}/action @@ -262,7 +261,7 @@ Request example Update share group -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/share-groups/{share_group_id} @@ -330,7 +329,7 @@ Response example Delete share group -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-groups/{share_group_id} diff --git a/api-ref/source/share-instance-export-locations.inc b/api-ref/source/share-instance-export-locations.inc index c7639b2ab9..05b52acd57 100644 --- a/api-ref/source/share-instance-export-locations.inc +++ b/api-ref/source/share-instance-export-locations.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================================ Share instance export locations (since API v2.9) ================================================ @@ -15,7 +14,7 @@ Show details of an export location belonging to a share instance. List export locations -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations @@ -62,7 +61,7 @@ Response example Show single export location -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations/{export_location_id} diff --git a/api-ref/source/share-instances.inc b/api-ref/source/share-instances.inc index b9103661a7..25f7ba702b 100644 --- a/api-ref/source/share-instances.inc +++ b/api-ref/source/share-instances.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================ Share instances (since API v2.3) ================================ @@ -15,7 +14,7 @@ roles. List share instances -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share_instances @@ -75,7 +74,7 @@ Response example Show share instance details -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share_instances/{share_instance_id} @@ -133,7 +132,7 @@ Response example Reset share instance state -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share_instances/{share_instance_id}/action @@ -175,7 +174,7 @@ Request example Force-delete share instance -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share_instances/{share_instance_id}/action diff --git a/api-ref/source/share-metadata.inc b/api-ref/source/share-metadata.inc index 306ee7d926..c695ea9951 100644 --- a/api-ref/source/share-metadata.inc +++ b/api-ref/source/share-metadata.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============== Share metadata ============== @@ -8,7 +7,7 @@ Shows, sets, updates, and unsets share metadata. Show all share metadata -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/shares/{share_id}/metadata @@ -51,7 +50,7 @@ Response example Show share metadata item -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/shares/{share_id}/metadata/{key} @@ -97,7 +96,7 @@ Response example Set share metadata -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/metadata @@ -152,7 +151,7 @@ Response example Update share metadata -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/shares/{share_id}/metadata @@ -221,7 +220,7 @@ Response example Delete share metadata item -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/shares/{share_id}/metadata/{key} diff --git a/api-ref/source/share-migration.inc b/api-ref/source/share-migration.inc index 9c4e324ea8..7447b8d249 100644 --- a/api-ref/source/share-migration.inc +++ b/api-ref/source/share-migration.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================= Share Migration (since API v2.22) ================================= @@ -67,7 +66,7 @@ Possible use cases for data migration include: Start Migration -=============== +~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -115,7 +114,7 @@ Request example Complete Migration -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -155,7 +154,7 @@ Request example Migration Get Process -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action @@ -207,7 +206,7 @@ Response_parameters Cancel Migration -================ +~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/{share_id}/action diff --git a/api-ref/source/share-network-subnets.inc b/api-ref/source/share-network-subnets.inc index 33e863b9de..d4ca0f69a5 100644 --- a/api-ref/source/share-network-subnets.inc +++ b/api-ref/source/share-network-subnets.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -======================================= Share network subnets (since API v2.51) ======================================= @@ -44,7 +43,7 @@ A share network subnet resource has these attributes: List share network subnets -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-networks/{share_network_id}/subnets @@ -100,7 +99,7 @@ Response example Show share network subnet details -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id} @@ -157,7 +156,7 @@ Response example Create share network subnet -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks/{share_network_id}/subnets @@ -225,7 +224,7 @@ Response example Delete share network subnet -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id} diff --git a/api-ref/source/share-networks.inc b/api-ref/source/share-networks.inc index 08f3886afa..55d159bfa2 100644 --- a/api-ref/source/share-networks.inc +++ b/api-ref/source/share-networks.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============== Share networks ============== @@ -41,7 +40,7 @@ A share network resource can also have a user defined name and description. List share networks -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-networks @@ -87,7 +86,7 @@ Response example List share networks with details -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-networks/detail @@ -153,7 +152,7 @@ Response example Show share network details -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-networks/{share_network_id} @@ -217,7 +216,7 @@ Response example Create share network -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks @@ -306,7 +305,7 @@ Response example Add security service to share network -===================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks/{share_network_id}/action @@ -386,7 +385,7 @@ Response example Remove security service from share network -========================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks/{share_network_id}/action @@ -458,7 +457,7 @@ Response example Update share network -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/share-networks/{share_network_id} @@ -539,7 +538,7 @@ Response example Delete share network -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-networks/{share_network_id} @@ -579,7 +578,7 @@ Request Update share network security service (since API v2.63) -======================================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks/{share_network_id}/action @@ -660,7 +659,7 @@ Response example .. _share-net-sec-service-update-check: Check share network security service update (since API v2.63) -============================================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks/{share_network_id}/action @@ -723,7 +722,7 @@ Response example Check share network security service add (since API v2.63) -========================================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks/{share_network_id}/action @@ -785,7 +784,7 @@ Response example Reset status (since API v2.63) -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-networks/{share_network_id}/action diff --git a/api-ref/source/share-replica-export-locations.inc b/api-ref/source/share-replica-export-locations.inc index e747565fc4..4b3d3e4909 100644 --- a/api-ref/source/share-replica-export-locations.inc +++ b/api-ref/source/share-replica-export-locations.inc @@ -2,14 +2,13 @@ .. _share_replica_export_locations: -================================================ Share replica export locations (since API v2.47) ================================================ Set of APIs used to view export locations of share replicas. List export locations -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations @@ -58,7 +57,7 @@ Response example Show single export location -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations/{export-location-id} diff --git a/api-ref/source/share-replicas.inc b/api-ref/source/share-replicas.inc index 6737fe2e02..f55dc2ec05 100644 --- a/api-ref/source/share-replicas.inc +++ b/api-ref/source/share-replicas.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -================================ Share replicas (since API v2.11) ================================ @@ -53,7 +52,7 @@ one of these supported replication types: Create share replica -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-replicas @@ -125,7 +124,7 @@ Response example Promote share replica -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action @@ -163,7 +162,7 @@ Request example Resync share replica -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action @@ -202,7 +201,7 @@ Request example List share replicas -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-replicas?share_id={share_id} @@ -250,7 +249,7 @@ Response example List share replicas with details -================================ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-replicas/detail?share_id={share_id} @@ -304,7 +303,7 @@ Response example Show share replica -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-replicas/{share_replica_id} @@ -359,7 +358,7 @@ Response example Reset status of the share replica -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action @@ -402,7 +401,7 @@ Request example Reset replica_state of the share replica -======================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action @@ -445,7 +444,7 @@ Request example Delete share replica -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-replicas/{share_replica_id} @@ -482,7 +481,7 @@ Request Force-delete share replica -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action diff --git a/api-ref/source/share-server-migration.inc b/api-ref/source/share-server-migration.inc index 11a761451b..36b66d8d00 100644 --- a/api-ref/source/share-server-migration.inc +++ b/api-ref/source/share-server-migration.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -======================================== Share Server Migration (since API v2.57) ======================================== @@ -40,7 +39,7 @@ Possible uses for share server migration include: Share Server Migration Check Compatibility -========================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action @@ -101,7 +100,7 @@ Response example Start a Share Server Migration -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action @@ -146,7 +145,7 @@ Request example Complete Share Server Migration -=============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action @@ -200,7 +199,7 @@ Response example Share Server Migration Get Progress -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action @@ -254,7 +253,7 @@ Response example Cancel Share Server Migration -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action diff --git a/api-ref/source/share-servers.inc b/api-ref/source/share-servers.inc index 2ab7117710..450bd2d4e0 100644 --- a/api-ref/source/share-servers.inc +++ b/api-ref/source/share-servers.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============= Share servers ============= @@ -41,7 +40,7 @@ The possible share servers statuses are: List share servers -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-servers @@ -90,7 +89,7 @@ Response example Show share server -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-servers/{share_server_id} @@ -145,7 +144,7 @@ Response example Show share server back end details -================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/share-servers/{share_server_id}/details @@ -188,7 +187,7 @@ Response example Delete share server -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/share-servers/{share_server_id} @@ -222,7 +221,7 @@ Request Manage share server (since API v2.49) -===================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-servers/manage @@ -292,7 +291,7 @@ Response examples Unmanage share server (since API v2.49) -======================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-servers/{share_server_id}/action @@ -344,7 +343,7 @@ There is no body content for the response. Reset status (since API v2.49) -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/share-servers/{share_server_id}/action diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index e4a4501358..39d32296fa 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=========== Share types =========== @@ -91,7 +90,7 @@ other roles. List share types -================ +~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/types?is_public={is_public}&extra-specs={extra-specs-as-dict} @@ -134,7 +133,7 @@ Response example List default share types -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/types/default @@ -182,7 +181,7 @@ Response example Show share type detail -====================== +~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/types/{share_type_id} @@ -231,7 +230,7 @@ Response Example List extra specs -================ +~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/types/{share_type_id}/extra_specs @@ -274,7 +273,7 @@ Response example Create share type -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/types @@ -335,7 +334,7 @@ Response example Show share type access details -============================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/types/{share_type_id}/share_type_access @@ -381,7 +380,7 @@ Response example Set extra spec for share type -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/types/{share_type_id}/extra_specs @@ -437,7 +436,7 @@ Response example Unset an extra spec -=================== +~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/types/{share_type_id}/extra_specs/{extra-spec-key} @@ -468,7 +467,7 @@ Request Add share type access -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/types/{share_type_id}/action @@ -509,7 +508,7 @@ Request example Remove share type access -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/types/{share_type_id}/action @@ -549,7 +548,7 @@ Request example Delete share type -================= +~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/types/{share_type_id} @@ -579,7 +578,7 @@ Request Update share type (since API v2.50) -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/types/{share_type_id} diff --git a/api-ref/source/shares.inc b/api-ref/source/shares.inc index 9439debb28..a5fd3018f2 100644 --- a/api-ref/source/shares.inc +++ b/api-ref/source/shares.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -====== Shares ====== @@ -87,7 +86,7 @@ A share has one of these status values: List shares -=========== +~~~~~~~~~~~ .. rest_method:: GET /v2/shares @@ -154,7 +153,7 @@ Response example List shares with details -======================== +~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/shares/detail @@ -256,7 +255,7 @@ Response example Show share details -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/shares/{share_id} @@ -333,7 +332,7 @@ Response example List share instances -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/shares/{share_id}/instances @@ -400,7 +399,7 @@ Response example :language: javascript Create share -============ +~~~~~~~~~~~~ .. rest_method:: POST /v2/shares @@ -497,7 +496,7 @@ Response example Manage share (since API v2.7) -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/shares/manage @@ -602,7 +601,7 @@ Response example Update share -============ +~~~~~~~~~~~~ .. rest_method:: PUT /v2/shares/{share_id} @@ -700,7 +699,7 @@ Response example Delete share -============ +~~~~~~~~~~~~ .. rest_method:: DELETE /v2/shares/{share_id} diff --git a/api-ref/source/snapshot-instances.inc b/api-ref/source/snapshot-instances.inc index 88f7ba1dd4..4779e815f9 100644 --- a/api-ref/source/snapshot-instances.inc +++ b/api-ref/source/snapshot-instances.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -========================================== Share snapshot instances (since API v2.19) ========================================== @@ -17,7 +16,7 @@ to grant permissions for these actions to other roles. List share snapshot instances -============================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/snapshot-instances @@ -63,7 +62,7 @@ Response example List share snapshot instances with details -========================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/snapshot-instances/detail @@ -115,7 +114,7 @@ Response example Show share snapshot instance details -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/snapshot-instances/{snapshot_instance_id} @@ -168,7 +167,7 @@ Response example Reset share snapshot instance state -=================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/snapshot-instances/{snapshot_instance_id}/action diff --git a/api-ref/source/snapshots.inc b/api-ref/source/snapshots.inc index 9dd3b9bbb9..e620da84e6 100644 --- a/api-ref/source/snapshots.inc +++ b/api-ref/source/snapshots.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -=============== Share snapshots =============== @@ -44,7 +43,7 @@ file to grant permissions for these actions to other roles. List share snapshots -==================== +~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/snapshots @@ -88,7 +87,7 @@ Response example List share snapshots with details -================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/snapshots/detail @@ -141,7 +140,7 @@ Response example Show share snapshot details -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/snapshots/{snapshot_id} @@ -193,7 +192,7 @@ Response example Create share snapshot -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/snapshots @@ -260,7 +259,7 @@ Response example Manage share snapshot (since API v2.12) -======================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/snapshots/manage @@ -335,7 +334,7 @@ Response example Unmanage share snapshot (since API v2.12) -========================================= +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/snapshots/{snapshot_id}/action @@ -385,7 +384,7 @@ Response parameters There is no body content for the response. Reset share snapshot state -========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/snapshots/{snapshot_id}/action @@ -425,7 +424,7 @@ Request example Force-delete share snapshot -=========================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: POST /v2/snapshots/{snapshot_id}/action @@ -465,7 +464,7 @@ Request example Update share snapshot -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: PUT /v2/snapshots/{snapshot_id} @@ -538,7 +537,7 @@ Response example Delete share snapshot -===================== +~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/snapshots/{snapshot_id} diff --git a/api-ref/source/user-messages.inc b/api-ref/source/user-messages.inc index db5d4bfbad..8fe6007bc0 100644 --- a/api-ref/source/user-messages.inc +++ b/api-ref/source/user-messages.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============================== User messages (since API 2.37) ============================== @@ -18,7 +17,7 @@ creation request with different parameters. List user messages -================== +~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/messages @@ -86,7 +85,7 @@ Response example Show user message details -========================= +~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /v2/messages/{message_id} @@ -142,7 +141,7 @@ Response example Delete message -============== +~~~~~~~~~~~~~~ .. rest_method:: DELETE /v2/messages/{message_id} diff --git a/api-ref/source/versions.inc b/api-ref/source/versions.inc index 5980410b49..8fd61e1e46 100644 --- a/api-ref/source/versions.inc +++ b/api-ref/source/versions.inc @@ -1,6 +1,5 @@ .. -*- rst -*- -============ API versions ============ @@ -8,7 +7,7 @@ Lists information for all Shared File Systems API versions. Concepts -======== +~~~~~~~~ In order to bring new features to users over time, the Shared File Systems API supports versioning. There are two kinds of versions in the Shared File @@ -28,7 +27,7 @@ requests. List All Major Versions -======================= +~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET / @@ -77,7 +76,7 @@ v2.1 API is lower than listed below. Show Details of Specific API Version -==================================== +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. rest_method:: GET /{api_version}/