openstack/manila
Code Issues Proposed changes

Fix headings in the API ref

Browse Source 
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 <gouthampravi@gmail.com>
This commit is contained in:
Goutham Pacha Ravi 2022-03-25 01:56:30 +05:30
parent 785016eb74
commit 88cec4f2c5
33 changed files with 160 additions and 192 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/source/availability-zones.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==================
Availability zones Availability zones
================== ==================
@ -14,7 +13,7 @@ configured with.
List availability zones List availability zones
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/availability-zones .. rest_method:: GET /v2/availability-zones

3
api-ref/source/extensions.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==============
API extensions API extensions
============== ==============
@ -8,7 +7,7 @@ Lists available Shared File Systems API extensions.
List extensions List extensions
=============== ~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/extensions .. rest_method:: GET /v2/extensions

2
api-ref/source/index.rst
View File

@ -1,4 +1,4 @@
:tocdepth: 2 :tocdepth: 3
======================= =======================
Shared File Systems API Shared File Systems API

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

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
======
Limits Limits
====== ======
@ -35,7 +34,7 @@ GET requests that can be processed during a one-minute period.
List share limits List share limits
================= ~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/limits .. rest_method:: GET /v2/limits

5
api-ref/source/os-share-manage.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
=======================================
Manage and unmanage shares (DEPRECATED) Manage and unmanage shares (DEPRECATED)
======================================= =======================================
@ -8,7 +7,7 @@ Allows bringing shared file systems under service management.
Manage share (DEPRECATED) Manage share (DEPRECATED)
========================= ~~~~~~~~~~~~~~~~~~~~~~~~~
.. warning:: .. warning::
@ -100,7 +99,7 @@ Response example
Unmanage share (DEPRECATED) Unmanage share (DEPRECATED)
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. warning:: .. warning::

5
api-ref/source/quota-classes.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
===============
Quota class set Quota class set
=============== ===============
@ -14,7 +13,7 @@ Quota classes can be shown and updated for a project.
Show quota classes for a project Show quota classes for a project
================================ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/quota-class-sets/{quota_class_name} .. rest_method:: GET /v2/quota-class-sets/{quota_class_name}
@ -68,7 +67,7 @@ Response Example
Update quota classes for a project Update quota classes for a project
================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/quota-class-sets/{quota_class_name} .. rest_method:: PUT /v2/quota-class-sets/{quota_class_name}

11
api-ref/source/quota-sets.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==========
Quota sets Quota sets
========== ==========
@ -35,7 +34,7 @@ Provides quotas management support.
Show default quota set Show default quota set
====================== ~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}/defaults .. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}/defaults
@ -89,7 +88,7 @@ Response example
Show quota set Show quota set
============== ~~~~~~~~~~~~~~
.. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id} .. 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) 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} .. 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 Update quota set
================ ~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id} .. rest_method:: PUT /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id}
@ -286,7 +285,7 @@ Response example
Delete quota set Delete quota set
================ ~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id} .. rest_method:: DELETE /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id}

5
api-ref/source/scheduler-stats.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
===============================
Scheduler Stats - Storage Pools Scheduler Stats - Storage Pools
=============================== ===============================
@ -9,7 +8,7 @@ to the scheduler service.
List back-end storage pools 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} .. 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 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} .. rest_method:: GET /v2/scheduler-stats/pools/detail?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type}

13
api-ref/source/security-services.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
=================
Security services Security services
================= =================
@ -37,7 +36,7 @@ A security service resource can also be given a user defined name and
description. description.
List security services List security services
====================== ~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/security-services .. rest_method:: GET /v2/security-services
@ -82,7 +81,7 @@ Response example
List security services with details List security services with details
=================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/security-services/detail .. rest_method:: GET /v2/security-services/detail
@ -137,7 +136,7 @@ Response example
Show security service details Show security service details
============================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/security-services/{security_service_id} .. rest_method:: GET /v2/security-services/{security_service_id}
@ -193,7 +192,7 @@ Response example
Create security service Create security service
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/security-services .. rest_method:: POST /v2/security-services
@ -263,7 +262,7 @@ Response example
Update security service Update security service
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/security-services/{security_service_id} .. rest_method:: PUT /v2/security-services/{security_service_id}
@ -340,7 +339,7 @@ Response example
Delete security service Delete security service
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/security-services/{security_service_id} .. rest_method:: DELETE /v2/security-services/{security_service_id}

7
api-ref/source/services.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
========
Services Services
======== ========
@ -14,7 +13,7 @@ These APIs help in interacting with the Shared File Systems services,
List services List services
============= ~~~~~~~~~~~~~
.. rest_method:: GET /v2/services?host={host}&binary={binary}&zone={zone}&state={state}&status={status} .. rest_method:: GET /v2/services?host={host}&binary={binary}&zone={zone}&state={state}&status={status}
@ -67,7 +66,7 @@ Response example
Enable service Enable service
============== ~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/services/enable .. rest_method:: PUT /v2/services/enable
@ -119,7 +118,7 @@ Response example
Disable service Disable service
=============== ~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/services/disable .. rest_method:: PUT /v2/services/disable

5
api-ref/source/share-access-rule-metadata.inc
View File

@ -1,13 +1,12 @@
.. -*- rst -*- .. -*- rst -*-
============================================
Share access rule metadata (since API v2.45) Share access rule metadata (since API v2.45)
============================================ ============================================
Updates, and unsets share access rule metadata. Updates, and unsets share access rule metadata.
Update share access rule metadata Update share access rule metadata
================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/share-access-rules/{access_id}/metadata .. rest_method:: PUT /v2/share-access-rules/{access_id}/metadata
@ -59,7 +58,7 @@ Response example
Unset share access rule metadata Unset share access rule metadata
================================ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-access-rules/{access_id}/metadata/{key} .. rest_method:: DELETE /v2/share-access-rules/{access_id}/metadata/{key}

5
api-ref/source/share-access-rules.inc
View File

@ -2,14 +2,13 @@
.. _get-access-rules-after-2-45: .. _get-access-rules-after-2-45:
====================================
Share access rules (since API v2.45) Share access rules (since API v2.45)
==================================== ====================================
Retrieve details about access rules Retrieve details about access rules
Describe share access rule Describe share access rule
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-access-rules/{access_id} .. rest_method:: GET /v2/share-access-rules/{access_id}
@ -63,7 +62,7 @@ Response example
List share access rules List share access rules
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-access-rules?share_id={share-id} .. rest_method:: GET /v2/share-access-rules?share_id={share-id}

23
api-ref/source/share-actions.inc
View File

@ -2,7 +2,6 @@
.. _get-access-rules-before-2-45: .. _get-access-rules-before-2-45:
=============
Share actions Share actions
============= =============
@ -35,7 +34,7 @@ access_list": null} is valid for v1.0-2.6
Grant access Grant access
============ ~~~~~~~~~~~~
All manila shares begin with no access. Clients must be provided with All manila shares begin with no access. Clients must be provided with
explicit access via this API. explicit access via this API.
@ -131,7 +130,7 @@ Response example
Revoke access Revoke access
============= ~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -172,7 +171,7 @@ Request example
List access rules (DEPRECATED) List access rules (DEPRECATED)
============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. warning:: .. warning::
@ -240,7 +239,7 @@ Response example
Reset share state Reset share state
================= ~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -282,7 +281,7 @@ Request example
Force-delete share Force-delete share
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -322,7 +321,7 @@ Request example
Extend share Extend share
============ ~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -362,7 +361,7 @@ Request example
Shrink share Shrink share
============ ~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -400,7 +399,7 @@ Request example
Unmanage share (since API v2.7) Unmanage share (since API v2.7)
=============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. 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) Revert share to snapshot (since API v2.27)
========================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -503,7 +502,7 @@ Request example
Soft delete share (since API v2.69) Soft delete share (since API v2.69)
=================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -559,7 +558,7 @@ Request example
Restore share (since API v2.69) Restore share (since API v2.69)
=============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action

5
api-ref/source/share-export-locations.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
=======================================
Share export locations (since API v2.9) 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 List export locations
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/shares/{share_id}/export_locations .. rest_method:: GET /v2/shares/{share_id}/export_locations
@ -62,7 +61,7 @@ Response example
Show single export location Show single export location
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/shares/{share_id}/export_locations/​{export_location_id}​ .. rest_method:: GET /v2/shares/{share_id}/export_locations/​{export_location_id}​

17
api-ref/source/share-group-snapshots.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
=======================================
Share group snapshots (since API v2.31) Share group snapshots (since API v2.31)
======================================= =======================================
@ -23,7 +22,7 @@ roles.
version 2.55. version 2.55.
List share group snapshots List share group snapshots
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-snapshots .. rest_method:: GET /v2/share-group-snapshots
@ -76,7 +75,7 @@ Response example
List share group snapshots with details List share group snapshots with details
======================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-snapshots/detail .. rest_method:: GET /v2/share-group-snapshots/detail
@ -135,7 +134,7 @@ Response example
List share group snapshots members List share group snapshots members
================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id}/members .. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id}/members
@ -186,7 +185,7 @@ Response example
Show share group snapshot details Show share group snapshot details
================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id} .. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id}
@ -238,7 +237,7 @@ Response example
Create share group snapshot Create share group snapshot
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-group-snapshots .. rest_method:: POST /v2/share-group-snapshots
@ -300,7 +299,7 @@ Response example
Reset share group snapshot state Reset share group snapshot state
================================ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-group-snapshots/{group_snapshot_id}/action .. rest_method:: POST /v2/share-group-snapshots/{group_snapshot_id}/action
@ -342,7 +341,7 @@ Request example
Update share group snapshot Update share group snapshot
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/share-group-snapshots/{group_snapshot_id} .. rest_method:: PUT /v2/share-group-snapshots/{group_snapshot_id}
@ -404,7 +403,7 @@ Response example
Delete share group snapshot Delete share group snapshot
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-group-snapshots/{group_snapshot_id} .. rest_method:: DELETE /v2/share-group-snapshots/{group_snapshot_id}

21
api-ref/source/share-group-types.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
===================================
Share group types (since API v2.31) Share group types (since API v2.31)
=================================== ===================================
@ -37,7 +36,7 @@ share group type for the following purposes:
version 2.55. version 2.55.
List share group types List share group types
====================== ~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-types .. rest_method:: GET /v2/share-group-types
@ -81,7 +80,7 @@ Response example
List default share group types List default share group types
============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-types/default .. rest_method:: GET /v2/share-group-types/default
@ -130,7 +129,7 @@ Response example
List share group types extra specs List share group types extra specs
================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-types/{share_group_type_id}/group_specs .. rest_method:: GET /v2/share-group-types/{share_group_type_id}/group_specs
@ -175,7 +174,7 @@ Response example
Create share group type Create share group type
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-group-types .. rest_method:: POST /v2/share-group-types
@ -235,7 +234,7 @@ Response example
Show share group type access details Show share group type access details
==================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-group-types/{share_group_type_id}/share_type_access .. 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 Set extra spec for share group type
=================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-group-types/{share_group_type_id}/group_specs .. rest_method:: POST /v2/share-group-types/{share_group_type_id}/group_specs
@ -336,7 +335,7 @@ Response example
Unset an group spec Unset an group spec
=================== ~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-group-types/{share_group_type_id}/group-specs/{group_spec_key} .. 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 Add share group type access
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action .. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action
@ -412,7 +411,7 @@ Request example
Remove share group type access Remove share group type access
============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action .. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action
@ -455,7 +454,7 @@ Request example
Delete share group type Delete share group type
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-group-types/{share_group_type_id} .. rest_method:: DELETE /v2/share-group-types/{share_group_type_id}

13
api-ref/source/share-groups.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==============================
Share groups (since API v2.31) 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. fields were added to ``share_group`` object since version 2.34.
List share groups List share groups
================= ~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share_groups .. rest_method:: GET /v2/share_groups
@ -87,7 +86,7 @@ Response example
Show share group details Show share group details
======================== ~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share_groups/{share_group_id} .. rest_method:: GET /v2/share_groups/{share_group_id}
@ -146,7 +145,7 @@ Response example
Create share group Create share group
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share_groups .. rest_method:: POST /v2/share_groups
@ -218,7 +217,7 @@ Response example
Reset share group state Reset share group state
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-groups/{share_group_id}/action .. rest_method:: POST /v2/share-groups/{share_group_id}/action
@ -262,7 +261,7 @@ Request example
Update share group Update share group
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/share-groups/{share_group_id} .. rest_method:: PUT /v2/share-groups/{share_group_id}
@ -330,7 +329,7 @@ Response example
Delete share group Delete share group
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-groups/{share_group_id} .. rest_method:: DELETE /v2/share-groups/{share_group_id}

5
api-ref/source/share-instance-export-locations.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
================================================
Share instance export locations (since API v2.9) 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 List export locations
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations .. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations
@ -62,7 +61,7 @@ Response example
Show single export location Show single export location
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations/{export_location_id} .. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations/{export_location_id}

9
api-ref/source/share-instances.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
================================
Share instances (since API v2.3) Share instances (since API v2.3)
================================ ================================
@ -15,7 +14,7 @@ roles.
List share instances List share instances
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share_instances .. rest_method:: GET /v2/share_instances
@ -75,7 +74,7 @@ Response example
Show share instance details Show share instance details
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share_instances/{share_instance_id} .. rest_method:: GET /v2/share_instances/{share_instance_id}
@ -133,7 +132,7 @@ Response example
Reset share instance state Reset share instance state
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share_instances/{share_instance_id}/action .. rest_method:: POST /v2/share_instances/{share_instance_id}/action
@ -175,7 +174,7 @@ Request example
Force-delete share instance Force-delete share instance
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share_instances/{share_instance_id}/action .. rest_method:: POST /v2/share_instances/{share_instance_id}/action

11
api-ref/source/share-metadata.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==============
Share metadata Share metadata
============== ==============
@ -8,7 +7,7 @@ Shows, sets, updates, and unsets share metadata.
Show all share metadata Show all share metadata
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/shares/{share_id}/metadata .. rest_method:: GET /v2/shares/{share_id}/metadata
@ -51,7 +50,7 @@ Response example
Show share metadata item Show share metadata item
========================= ~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/shares/{share_id}/metadata/{key} .. rest_method:: GET /v2/shares/{share_id}/metadata/{key}
@ -97,7 +96,7 @@ Response example
Set share metadata Set share metadata
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/metadata .. rest_method:: POST /v2/shares/{share_id}/metadata
@ -152,7 +151,7 @@ Response example
Update share metadata Update share metadata
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/shares/{share_id}/metadata .. rest_method:: PUT /v2/shares/{share_id}/metadata
@ -221,7 +220,7 @@ Response example
Delete share metadata item Delete share metadata item
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/shares/{share_id}/metadata/{key} .. rest_method:: DELETE /v2/shares/{share_id}/metadata/{key}

9
api-ref/source/share-migration.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
=================================
Share Migration (since API v2.22) Share Migration (since API v2.22)
================================= =================================
@ -67,7 +66,7 @@ Possible use cases for data migration include:
Start Migration Start Migration
=============== ~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -115,7 +114,7 @@ Request example
Complete Migration Complete Migration
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -155,7 +154,7 @@ Request example
Migration Get Process Migration Get Process
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action
@ -207,7 +206,7 @@ Response_parameters
Cancel Migration Cancel Migration
================ ~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/{share_id}/action .. rest_method:: POST /v2/shares/{share_id}/action

9
api-ref/source/share-network-subnets.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
=======================================
Share network subnets (since API v2.51) Share network subnets (since API v2.51)
======================================= =======================================
@ -44,7 +43,7 @@ A share network subnet resource has these attributes:
List share network subnets List share network subnets
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-networks/{share_network_id}/subnets .. rest_method:: GET /v2/share-networks/{share_network_id}/subnets
@ -100,7 +99,7 @@ Response example
Show share network subnet details Show share network subnet details
================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id} .. rest_method:: GET /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id}
@ -157,7 +156,7 @@ Response example
Create share network subnet Create share network subnet
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks/{share_network_id}/subnets .. rest_method:: POST /v2/share-networks/{share_network_id}/subnets
@ -225,7 +224,7 @@ Response example
Delete share network subnet Delete share network subnet
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id} .. rest_method:: DELETE /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id}

25
api-ref/source/share-networks.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==============
Share networks Share networks
============== ==============
@ -41,7 +40,7 @@ A share network resource can also have a user defined name and description.
List share networks List share networks
=================== ~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-networks .. rest_method:: GET /v2/share-networks
@ -87,7 +86,7 @@ Response example
List share networks with details List share networks with details
================================ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-networks/detail .. rest_method:: GET /v2/share-networks/detail
@ -153,7 +152,7 @@ Response example
Show share network details Show share network details
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-networks/{share_network_id} .. rest_method:: GET /v2/share-networks/{share_network_id}
@ -217,7 +216,7 @@ Response example
Create share network Create share network
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks .. rest_method:: POST /v2/share-networks
@ -306,7 +305,7 @@ Response example
Add security service to share network Add security service to share network
===================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks/{share_network_id}/action .. rest_method:: POST /v2/share-networks/{share_network_id}/action
@ -386,7 +385,7 @@ Response example
Remove security service from share network Remove security service from share network
========================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks/{share_network_id}/action .. rest_method:: POST /v2/share-networks/{share_network_id}/action
@ -458,7 +457,7 @@ Response example
Update share network Update share network
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/share-networks/{share_network_id} .. rest_method:: PUT /v2/share-networks/{share_network_id}
@ -539,7 +538,7 @@ Response example
Delete share network Delete share network
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-networks/{share_network_id} .. rest_method:: DELETE /v2/share-networks/{share_network_id}
@ -579,7 +578,7 @@ Request
Update share network security service (since API v2.63) Update share network security service (since API v2.63)
======================================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks/{share_network_id}/action .. rest_method:: POST /v2/share-networks/{share_network_id}/action
@ -660,7 +659,7 @@ Response example
.. _share-net-sec-service-update-check: .. _share-net-sec-service-update-check:
Check share network security service update (since API v2.63) Check share network security service update (since API v2.63)
============================================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks/{share_network_id}/action .. 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) Check share network security service add (since API v2.63)
========================================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks/{share_network_id}/action .. rest_method:: POST /v2/share-networks/{share_network_id}/action
@ -785,7 +784,7 @@ Response example
Reset status (since API v2.63) Reset status (since API v2.63)
============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-networks/{share_network_id}/action .. rest_method:: POST /v2/share-networks/{share_network_id}/action

5
api-ref/source/share-replica-export-locations.inc
View File

@ -2,14 +2,13 @@
.. _share_replica_export_locations: .. _share_replica_export_locations:
================================================
Share replica export locations (since API v2.47) Share replica export locations (since API v2.47)
================================================ ================================================
Set of APIs used to view export locations of share replicas. Set of APIs used to view export locations of share replicas.
List export locations List export locations
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations .. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations
@ -58,7 +57,7 @@ Response example
Show single export location Show single export location
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations/{export-location-id} .. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations/{export-location-id}

21
api-ref/source/share-replicas.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
================================
Share replicas (since API v2.11) Share replicas (since API v2.11)
================================ ================================
@ -53,7 +52,7 @@ one of these supported replication types:
Create share replica Create share replica
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-replicas .. rest_method:: POST /v2/share-replicas
@ -125,7 +124,7 @@ Response example
Promote share replica Promote share replica
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
@ -163,7 +162,7 @@ Request example
Resync share replica Resync share replica
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
@ -202,7 +201,7 @@ Request example
List share replicas List share replicas
=================== ~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-replicas?share_id={share_id} .. rest_method:: GET /v2/share-replicas?share_id={share_id}
@ -250,7 +249,7 @@ Response example
List share replicas with details List share replicas with details
================================ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-replicas/detail?share_id={share_id} .. rest_method:: GET /v2/share-replicas/detail?share_id={share_id}
@ -304,7 +303,7 @@ Response example
Show share replica Show share replica
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-replicas/{share_replica_id} .. rest_method:: GET /v2/share-replicas/{share_replica_id}
@ -359,7 +358,7 @@ Response example
Reset status of the share replica Reset status of the share replica
================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
@ -402,7 +401,7 @@ Request example
Reset replica_state of the share replica Reset replica_state of the share replica
======================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
@ -445,7 +444,7 @@ Request example
Delete share replica Delete share replica
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-replicas/{share_replica_id} .. rest_method:: DELETE /v2/share-replicas/{share_replica_id}
@ -482,7 +481,7 @@ Request
Force-delete share replica Force-delete share replica
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action .. rest_method:: POST /v2/share-replicas/{share_replica_id}/action

11
api-ref/source/share-server-migration.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
========================================
Share Server Migration (since API v2.57) Share Server Migration (since API v2.57)
======================================== ========================================
@ -40,7 +39,7 @@ Possible uses for share server migration include:
Share Server Migration Check Compatibility Share Server Migration Check Compatibility
========================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action
@ -101,7 +100,7 @@ Response example
Start a Share Server Migration Start a Share Server Migration
============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action
@ -146,7 +145,7 @@ Request example
Complete Share Server Migration Complete Share Server Migration
=============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action
@ -200,7 +199,7 @@ Response example
Share Server Migration Get Progress Share Server Migration Get Progress
=================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action
@ -254,7 +253,7 @@ Response example
Cancel Share Server Migration Cancel Share Server Migration
============================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action .. rest_method:: POST /v2/{project_id}/share_servers/{share_server_id}/action

15
api-ref/source/share-servers.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
=============
Share servers Share servers
============= =============
@ -41,7 +40,7 @@ The possible share servers statuses are:
List share servers List share servers
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-servers .. rest_method:: GET /v2/share-servers
@ -90,7 +89,7 @@ Response example
Show share server Show share server
================= ~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-servers/{share_server_id} .. rest_method:: GET /v2/share-servers/{share_server_id}
@ -145,7 +144,7 @@ Response example
Show share server back end details Show share server back end details
================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/share-servers/{share_server_id}/details .. rest_method:: GET /v2/share-servers/{share_server_id}/details
@ -188,7 +187,7 @@ Response example
Delete share server Delete share server
=================== ~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/share-servers/{share_server_id} .. rest_method:: DELETE /v2/share-servers/{share_server_id}
@ -222,7 +221,7 @@ Request
Manage share server (since API v2.49) Manage share server (since API v2.49)
===================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-servers/manage .. rest_method:: POST /v2/share-servers/manage
@ -292,7 +291,7 @@ Response examples
Unmanage share server (since API v2.49) Unmanage share server (since API v2.49)
======================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-servers/{share_server_id}/action .. 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) Reset status (since API v2.49)
============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/share-servers/{share_server_id}/action .. rest_method:: POST /v2/share-servers/{share_server_id}/action

25
api-ref/source/share-types.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
===========
Share types Share types
=========== ===========
@ -91,7 +90,7 @@ other roles.
List share types List share types
================ ~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/types?is_public={is_public}&extra-specs={extra-specs-as-dict} .. 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 List default share types
======================== ~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/types/default .. rest_method:: GET /v2/types/default
@ -182,7 +181,7 @@ Response example
Show share type detail Show share type detail
====================== ~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/types/{share_type_id} .. rest_method:: GET /v2/types/{share_type_id}
@ -231,7 +230,7 @@ Response Example
List extra specs List extra specs
================ ~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/types/{share_type_id}/extra_specs .. rest_method:: GET /v2/types/{share_type_id}/extra_specs
@ -274,7 +273,7 @@ Response example
Create share type Create share type
================= ~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/types .. rest_method:: POST /v2/types
@ -335,7 +334,7 @@ Response example
Show share type access details Show share type access details
============================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/types/{share_type_id}/share_type_access .. rest_method:: GET /v2/types/{share_type_id}/share_type_access
@ -381,7 +380,7 @@ Response example
Set extra spec for share type Set extra spec for share type
============================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/types/{share_type_id}/extra_specs .. rest_method:: POST /v2/types/{share_type_id}/extra_specs
@ -437,7 +436,7 @@ Response example
Unset an extra spec Unset an extra spec
=================== ~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/types/{share_type_id}/extra_specs/{extra-spec-key} .. rest_method:: DELETE /v2/types/{share_type_id}/extra_specs/{extra-spec-key}
@ -468,7 +467,7 @@ Request
Add share type access Add share type access
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/types/{share_type_id}/action .. rest_method:: POST /v2/types/{share_type_id}/action
@ -509,7 +508,7 @@ Request example
Remove share type access Remove share type access
======================== ~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/types/{share_type_id}/action .. rest_method:: POST /v2/types/{share_type_id}/action
@ -549,7 +548,7 @@ Request example
Delete share type Delete share type
================= ~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/types/{share_type_id} .. rest_method:: DELETE /v2/types/{share_type_id}
@ -579,7 +578,7 @@ Request
Update share type (since API v2.50) Update share type (since API v2.50)
=================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/types/{share_type_id} .. rest_method:: PUT /v2/types/{share_type_id}

17
api-ref/source/shares.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
======
Shares Shares
====== ======
@ -87,7 +86,7 @@ A share has one of these status values:
List shares List shares
=========== ~~~~~~~~~~~
.. rest_method:: GET /v2/shares .. rest_method:: GET /v2/shares
@ -154,7 +153,7 @@ Response example
List shares with details List shares with details
======================== ~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/shares/detail .. rest_method:: GET /v2/shares/detail
@ -256,7 +255,7 @@ Response example
Show share details Show share details
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/shares/{share_id} .. rest_method:: GET /v2/shares/{share_id}
@ -333,7 +332,7 @@ Response example
List share instances List share instances
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/shares/{share_id}/instances .. rest_method:: GET /v2/shares/{share_id}/instances
@ -400,7 +399,7 @@ Response example
:language: javascript :language: javascript
Create share Create share
============ ~~~~~~~~~~~~
.. rest_method:: POST /v2/shares .. rest_method:: POST /v2/shares
@ -497,7 +496,7 @@ Response example
Manage share (since API v2.7) Manage share (since API v2.7)
============================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/shares/manage .. rest_method:: POST /v2/shares/manage
@ -602,7 +601,7 @@ Response example
Update share Update share
============ ~~~~~~~~~~~~
.. rest_method:: PUT /v2/shares/{share_id} .. rest_method:: PUT /v2/shares/{share_id}
@ -700,7 +699,7 @@ Response example
Delete share Delete share
============ ~~~~~~~~~~~~
.. rest_method:: DELETE /v2/shares/{share_id} .. rest_method:: DELETE /v2/shares/{share_id}

9
api-ref/source/snapshot-instances.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==========================================
Share snapshot instances (since API v2.19) Share snapshot instances (since API v2.19)
========================================== ==========================================
@ -17,7 +16,7 @@ to grant permissions for these actions to other roles.
List share snapshot instances List share snapshot instances
============================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/snapshot-instances .. rest_method:: GET /v2/snapshot-instances
@ -63,7 +62,7 @@ Response example
List share snapshot instances with details List share snapshot instances with details
========================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/snapshot-instances/detail .. rest_method:: GET /v2/snapshot-instances/detail
@ -115,7 +114,7 @@ Response example
Show share snapshot instance details Show share snapshot instance details
==================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/snapshot-instances/{snapshot_instance_id} .. rest_method:: GET /v2/snapshot-instances/{snapshot_instance_id}
@ -168,7 +167,7 @@ Response example
Reset share snapshot instance state Reset share snapshot instance state
=================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/snapshot-instances/{snapshot_instance_id}/action .. rest_method:: POST /v2/snapshot-instances/{snapshot_instance_id}/action

21
api-ref/source/snapshots.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
===============
Share snapshots Share snapshots
=============== ===============
@ -44,7 +43,7 @@ file to grant permissions for these actions to other roles.
List share snapshots List share snapshots
==================== ~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/snapshots .. rest_method:: GET /v2/snapshots
@ -88,7 +87,7 @@ Response example
List share snapshots with details List share snapshots with details
================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/snapshots/detail .. rest_method:: GET /v2/snapshots/detail
@ -141,7 +140,7 @@ Response example
Show share snapshot details Show share snapshot details
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/snapshots/{snapshot_id} .. rest_method:: GET /v2/snapshots/{snapshot_id}
@ -193,7 +192,7 @@ Response example
Create share snapshot Create share snapshot
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/snapshots .. rest_method:: POST /v2/snapshots
@ -260,7 +259,7 @@ Response example
Manage share snapshot (since API v2.12) Manage share snapshot (since API v2.12)
======================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/snapshots/manage .. rest_method:: POST /v2/snapshots/manage
@ -335,7 +334,7 @@ Response example
Unmanage share snapshot (since API v2.12) Unmanage share snapshot (since API v2.12)
========================================= ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/snapshots/{snapshot_id}/action .. rest_method:: POST /v2/snapshots/{snapshot_id}/action
@ -385,7 +384,7 @@ Response parameters
There is no body content for the response. There is no body content for the response.
Reset share snapshot state Reset share snapshot state
========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/snapshots/{snapshot_id}/action .. rest_method:: POST /v2/snapshots/{snapshot_id}/action
@ -425,7 +424,7 @@ Request example
Force-delete share snapshot Force-delete share snapshot
=========================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: POST /v2/snapshots/{snapshot_id}/action .. rest_method:: POST /v2/snapshots/{snapshot_id}/action
@ -465,7 +464,7 @@ Request example
Update share snapshot Update share snapshot
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: PUT /v2/snapshots/{snapshot_id} .. rest_method:: PUT /v2/snapshots/{snapshot_id}
@ -538,7 +537,7 @@ Response example
Delete share snapshot Delete share snapshot
===================== ~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/snapshots/{snapshot_id} .. rest_method:: DELETE /v2/snapshots/{snapshot_id}

7
api-ref/source/user-messages.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
==============================
User messages (since API 2.37) User messages (since API 2.37)
============================== ==============================
@ -18,7 +17,7 @@ creation request with different parameters.
List user messages List user messages
================== ~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/messages .. rest_method:: GET /v2/messages
@ -86,7 +85,7 @@ Response example
Show user message details Show user message details
========================= ~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/messages/{message_id} .. rest_method:: GET /v2/messages/{message_id}
@ -142,7 +141,7 @@ Response example
Delete message Delete message
============== ~~~~~~~~~~~~~~
.. rest_method:: DELETE /v2/messages/{message_id} .. rest_method:: DELETE /v2/messages/{message_id}

7
api-ref/source/versions.inc
View File

@ -1,6 +1,5 @@
.. -*- rst -*- .. -*- rst -*-
============
API versions API versions
============ ============
@ -8,7 +7,7 @@ Lists information for all Shared File Systems API versions.
Concepts Concepts
======== ~~~~~~~~
In order to bring new features to users over time, the Shared File Systems API 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 supports versioning. There are two kinds of versions in the Shared File
@ -28,7 +27,7 @@ requests.
List All Major Versions List All Major Versions
======================= ~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET / .. rest_method:: GET /
@ -77,7 +76,7 @@ v2.1 API is lower than listed below.
Show Details of Specific API Version Show Details of Specific API Version
==================================== ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /{api_version}/ .. rest_method:: GET /{api_version}/