[doc] remove project_id from api endpoints

As of API version 2.60, a project_id is no
longer needed in the API URLs.

Fix the docs to indicate that.

Also fix up a few quota parameters that use
project_id in a different place in the API path.

Change-Id: I24b32c8521805a7d67d512d36d644c0f07c532ea
Implements: bp remove-project-id-from-urls
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
This commit is contained in:
Goutham Pacha Ravi 2021-02-03 11:16:51 -08:00
parent 9efcb475cf
commit de29398128
33 changed files with 239 additions and 207 deletions

View File

@ -16,7 +16,7 @@ configured with.
List availability zones
=======================
.. rest_method:: GET /v2/{project_id}/availability-zones
.. rest_method:: GET /v2/availability-zones
Lists all availability zones.

View File

@ -10,7 +10,7 @@ Lists available Shared File Systems API extensions.
List extensions
===============
.. rest_method:: GET /v2/{project_id}/extensions
.. rest_method:: GET /v2/extensions
Lists all extensions.

View File

@ -4,6 +4,22 @@
Shared File Systems API
=======================
This is a reference for version 2 of the OpenStack Shared File Systems API
which is provided by the Manila project. Manila provides a RESTful HTTP service
through which it offers on-demand, scalable, self-service access to
shared file system storage resources.
.. important::
Prior to the Wallaby release, Shared File System service required the
caller to specify their "project_id" in the API URLs. This requirement has
been dropped. The API service now behaves the same way whether or not
"project_id" is included in the URLs. If your cloud does not yet support
version 2.60, all the resource URLs below will require a project ID. For
example:
GET /v2/{project_id}/shares
.. rest_expand_all::
.. include:: versions.inc

View File

@ -37,7 +37,7 @@ GET requests that can be processed during a one-minute period.
List share limits
=================
.. rest_method:: GET /v2/{project_id}/limits
.. rest_method:: GET /v2/limits
Lists share limits.

View File

@ -17,7 +17,7 @@ Manage share (DEPRECATED)
`Share Manage API <#manage-share-since-api-v2-7>`_ instead of this API
from version 2.7.
.. rest_method:: POST /v2/{project_id}/os-share-manage
.. rest_method:: POST /v2/os-share-manage
Use this API to bring a share under the management of the Shared File
Systems service. In the service, the share will be represented as a resource
@ -113,7 +113,7 @@ Unmanage share (DEPRECATED)
`Share Unmanage API <#unmanage-share-since-api-v2-7>`_ instead of this
API from version 2.7.
.. rest_method:: POST /v2/{project_id}/os-share-unmanage/{share_id}/unmanage
.. rest_method:: POST /v2/os-share-unmanage/{share_id}/unmanage
Use this API to remove a share from the management of the Shared File
Systems service without deleting the share.

View File

@ -48,20 +48,34 @@ metadata_key_path:
type: string
project_id_path:
description: |
The project ID of the user or service making the API request.
The project ID of the user or service making the API request. This
parameter is optional if the service supports API version 2.60. If the
service doesn't yet support API version 2.60, ensure that the service
catalog endpoint obtained for the service has the user's project_id
after the "/v2/" component, for example, the API to retrieve shares is
*GET /v2/{project_id}/shares*. If the service doesn't yet support API
version 2.60, and the project_id is ommitted from the API URL, a
Malformed Request error is returned (HTTP 400).
in: path
required: true
required: false
type: string
project_id_quota_request_path:
description: |
The ID of the project whose quotas must be acted upon by the API.
This ID can be different from the first project ID in the URI.
For example, in a multi-tenant cloud, the first ID in the URI is
typically the project ID of a privileged user (such as a cloud
administrator) that can create, query or delete quotas of other projects
in the cloud.
The ID of the project whose quotas must be acted upon by the API. This
is optional, and if it is not specified, the project ID is derived from
the caller's API token. System/Domain scoped users interacting with this
API *must* specify the project ID for the project whose quotas they need
to query or manipulate.
Note that this ID can be different from the project ID that precedes the
resource name "quota-sets". For example, in a multi-tenant cloud, the
first ID in the URL is typically the project ID of a privileged user
(such as a cloud administrator) that can create, query or delete quotas
of other projects in the cloud. If a server supports API version 2.60,
URLs no longer need the privileged user's project ID prior to the resource
name.
in: path
required: true
required: false
type: string
quota_class_name:
description:
@ -121,7 +135,8 @@ share_type_for_quota:
description: |
The name or UUID of the share type. If you specify this
parameter in the URI, you show, update, or delete quotas
for this share type.
for this share type. This parameter is mutually exclusive with the
"user_id" query parameter.
in: path
required: false
type: string
@ -487,9 +502,10 @@ status_query:
type: string
user_id_query:
description: |
The ID of the user. If you specify this query parameter, you update the
quotas for this user in the project. If you omit this parameter, you
update the quotas for the whole project.
The ID of the user. If you specify this query parameter, you retrieve or
update the quotas for this user in the project. If you omit this
parameter, you query or update the quotas for the whole project. This
parameter is mutually exclusive with the "share_type" parameter.
in: query
required: false
type: string

View File

@ -14,7 +14,7 @@ Quota classes can be shown and updated for a project.
Show quota classes for a project
================================
.. rest_method:: GET /v2/{project_id}/quota-class-sets/{quota_class_name}
.. rest_method:: GET /v2/quota-class-sets/{quota_class_name}
Shows quota class set for a project. If no specific value for the quota class
resource exists, then the default value will be reported.
@ -67,7 +67,7 @@ Response Example
Update quota classes for a project
==================================
.. rest_method:: PUT /v2/{project_id}/quota-class-sets/{quota_class_name}
.. rest_method:: PUT /v2/quota-class-sets/{quota_class_name}
Updates quota class set for a project. If the ``quota_class_name`` key does not
exist, then the API will create one.

View File

@ -33,7 +33,7 @@ Provides quotas management support.
Show default quota set
======================
.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}/defaults
.. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}/defaults
Shows default quotas for a given project.
@ -56,7 +56,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- project_id: project_id_quota_request_path
- project_id_quota_request_path: project_id_quota_request_path
Response parameters
-------------------
@ -86,7 +86,7 @@ Response example
Show quota set
==============
.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
.. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id}
Shows quotas for a given project..
@ -113,7 +113,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- project_id: project_id_quota_request_path
- project_id_quota_request_path: project_id_quota_request_path
- user_id: user_id_query
- share_type: share_type_for_quota
@ -144,7 +144,7 @@ Response example
Show quota set in detail (since API v2.25)
==========================================
.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}/detail?user_id={user_id}
.. rest_method:: GET /v2/quota-sets/{project_id_quota_request_path}/detail?user_id={user_id}
.. versionadded:: 2.25
@ -173,7 +173,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- project_id: project_id_quota_request_path
- project_id_quota_request_path: project_id_quota_request_path
- user_id: user_id_query
- share_type: share_type_for_quota
@ -204,7 +204,7 @@ Response example
Update quota set
================
.. rest_method:: PUT /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
.. rest_method:: PUT /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id}
Updates quotas for a project.
@ -231,7 +231,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- project_id: project_id_quota_request_path
- project_id_quota_request_path: project_id_quota_request_path
- user_id: user_id_query
- quota_set: quota_set
- force: force
@ -279,7 +279,7 @@ Response example
Delete quota set
================
.. rest_method:: DELETE /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
.. rest_method:: DELETE /v2/quota-sets/{project_id_quota_request_path}?user_id={user_id}
Deletes quotas for a project. The quota reverts to the default quota.
@ -306,6 +306,6 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- project_id: project_id_quota_request_path
- project_id_quota_request_path: project_id_quota_request_path
- user_id: user_id_query
- share_type: share_type_for_quota

View File

@ -11,7 +11,7 @@ to the scheduler service.
List back-end storage pools
===========================
.. rest_method:: GET /v2/{project_id}/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}
Lists all back-end storage pools. If search options are provided, the pool
list that is returned is filtered with these options.
@ -61,7 +61,7 @@ Response example
List back-end storage pools with details
========================================
.. rest_method:: GET /v2/{project_id}/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}
Lists all back-end storage pools with details. If search options are provided,
the pool list that is returned is filtered with these options.

View File

@ -39,7 +39,7 @@ description.
List security services
======================
.. rest_method:: GET /v2/{project_id}/security-services
.. rest_method:: GET /v2/security-services
Lists all security services.
@ -84,7 +84,7 @@ Response example
List security services with details
===================================
.. rest_method:: GET /v2/{project_id}/security-services/detail
.. rest_method:: GET /v2/security-services/detail
Lists all security services with details.
@ -139,7 +139,7 @@ Response example
Show security service details
=============================
.. rest_method:: GET /v2/{project_id}/security-services/{security_service_id}
.. rest_method:: GET /v2/security-services/{security_service_id}
Shows details for a security service.
@ -195,7 +195,7 @@ Response example
Create security service
=======================
.. rest_method:: POST /v2/{project_id}/security-services
.. rest_method:: POST /v2/security-services
Creates a security service.
@ -265,7 +265,7 @@ Response example
Update security service
=======================
.. rest_method:: PUT /v2/{project_id}/security-services/{security_service_id}
.. rest_method:: PUT /v2/security-services/{security_service_id}
Updates a security service.
@ -342,7 +342,7 @@ Response example
Delete security service
=======================
.. rest_method:: DELETE /v2/{project_id}/security-services/{security_service_id}
.. rest_method:: DELETE /v2/security-services/{security_service_id}
Deletes a security service.

View File

@ -16,7 +16,7 @@ These APIs help in interacting with the Shared File Systems services,
List services
=============
.. rest_method:: GET /v2/{project_id}/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}
Lists all services optionally filtered with the specified search options.
@ -69,7 +69,7 @@ Response example
Enable service
==============
.. rest_method:: PUT /v2/{project_id}/services/enable
.. rest_method:: PUT /v2/services/enable
Enables a service.
@ -121,7 +121,7 @@ Response example
Disable service
===============
.. rest_method:: PUT /v2/{project_id}/services/disable
.. rest_method:: PUT /v2/services/disable
Disables a service.

View File

@ -9,7 +9,7 @@ Updates, and unsets share access rule metadata.
Update share access rule metadata
==================================
.. rest_method:: PUT /v2/{project_id}/share-access-rules/{access_id}/metadata
.. rest_method:: PUT /v2/share-access-rules/{access_id}/metadata
.. versionadded:: 2.45
@ -61,7 +61,7 @@ Response example
Unset share access rule metadata
================================
.. rest_method:: DELETE /v2/{project_id}/share-access-rules/{access_id}/metadata/{key}
.. rest_method:: DELETE /v2/share-access-rules/{access_id}/metadata/{key}
.. versionadded:: 2.45

View File

@ -11,7 +11,7 @@ Retrieve details about access rules
Describe share access rule
==========================
.. rest_method:: GET /v2/{project_id}/share-access-rules/{access_id}
.. rest_method:: GET /v2/share-access-rules/{access_id}
.. versionadded:: 2.45
@ -65,7 +65,7 @@ Response example
List share access rules
=======================
.. rest_method:: GET /v2/{project_id}/share-access-rules?share_id={share-id}
.. rest_method:: GET /v2/share-access-rules?share_id={share-id}
.. versionadded:: 2.45

View File

@ -70,7 +70,7 @@ methods:
an alphanumeric string that can contain some special characters
and is from 4 to 255 characters long.
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
Grants access to a share.
@ -133,7 +133,7 @@ Response example
Revoke access
=============
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
The shared file systems service stores each access rule in its database and
assigns it a unique ID. This ID can be used to revoke access after access
@ -181,7 +181,7 @@ List access rules (DEPRECATED)
:ref:`List share access rules <get-access-rules-after-2-45>` API
instead of this API from version 2.45.
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
Lists access rules for a share. The Access ID returned is necessary to deny
access.
@ -242,7 +242,7 @@ Response example
Reset share state
=================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
Administrator only. Explicitly updates the state of a share.
@ -284,7 +284,7 @@ Request example
Force-delete share
==================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
Administrator only. Force-deletes a share in any state.
@ -324,7 +324,7 @@ Request example
Extend share
============
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
Increases the size of a share.
@ -363,7 +363,7 @@ Request example
Shrink share
============
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
Shrinks the size of a share.
@ -401,7 +401,7 @@ Request example
Unmanage share (since API v2.7)
===============================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
.. versionadded:: 2.7
@ -462,7 +462,7 @@ There is no body content for the response.
Revert share to snapshot (since API v2.27)
==========================================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
.. versionadded:: 2.27

View File

@ -15,7 +15,7 @@ locations of non-active share replicas can only be retrieved using the
List export locations
=====================
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/export_locations
.. rest_method:: GET /v2/shares/{share_id}/export_locations
.. versionadded:: 2.9
@ -64,7 +64,7 @@ Response example
Show single export location
===========================
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/export_locations/{export_location_id}
.. rest_method:: GET /v2/shares/{share_id}/export_locations/{export_location_id}
.. versionadded:: 2.9

View File

@ -25,7 +25,7 @@ roles.
List share group snapshots
==========================
.. rest_method:: GET /v2/{project_id}/share-group-snapshots
.. rest_method:: GET /v2/share-group-snapshots
.. versionadded:: 2.31
@ -78,7 +78,7 @@ Response example
List share group snapshots with details
=======================================
.. rest_method:: GET /v2/{project_id}/share-group-snapshots/detail
.. rest_method:: GET /v2/share-group-snapshots/detail
.. versionadded:: 2.31
@ -137,7 +137,7 @@ Response example
List share group snapshots members
==================================
.. rest_method:: GET /v2/{project_id}/share-group-snapshots/{group_snapshot_id}/members
.. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id}/members
.. versionadded:: 2.31
@ -188,7 +188,7 @@ Response example
Show share group snapshot details
=================================
.. rest_method:: GET /v2/{project_id}/share-group-snapshots/{group_snapshot_id}
.. rest_method:: GET /v2/share-group-snapshots/{group_snapshot_id}
.. versionadded:: 2.31
@ -240,7 +240,7 @@ Response example
Create share group snapshot
===========================
.. rest_method:: POST /v2/{project_id}/share-group-snapshots
.. rest_method:: POST /v2/share-group-snapshots
.. versionadded:: 2.31
@ -302,7 +302,7 @@ Response example
Reset share group snapshot state
================================
.. rest_method:: POST /v2/{project_id}/share-group-snapshots/{group_snapshot_id}/action
.. rest_method:: POST /v2/share-group-snapshots/{group_snapshot_id}/action
.. versionadded:: 2.31
@ -344,7 +344,7 @@ Request example
Update share group snapshot
===========================
.. rest_method:: PUT /v2/{project_id}/share-group-snapshots/{group_snapshot_id}
.. rest_method:: PUT /v2/share-group-snapshots/{group_snapshot_id}
.. versionadded:: 2.31
@ -406,7 +406,7 @@ Response example
Delete share group snapshot
===========================
.. rest_method:: DELETE /v2/{project_id}/share-group-snapshots/{group_snapshot_id}
.. rest_method:: DELETE /v2/share-group-snapshots/{group_snapshot_id}
.. versionadded:: 2.31

View File

@ -39,7 +39,7 @@ share group type for the following purposes:
List share group types
======================
.. rest_method:: GET /v2/{project_id}/share-group-types
.. rest_method:: GET /v2/share-group-types
.. versionadded:: 2.31
@ -81,7 +81,7 @@ Response example
List default share group types
==============================
.. rest_method:: GET /v2/{project_id}/share-group-types/default
.. rest_method:: GET /v2/share-group-types/default
.. versionadded:: 2.31
@ -130,7 +130,7 @@ Response example
List share group types extra specs
==================================
.. rest_method:: GET /v2/{project_id}/share-group-types/{share_group_type_id}/group_specs
.. rest_method:: GET /v2/share-group-types/{share_group_type_id}/group_specs
.. versionadded:: 2.31
@ -175,7 +175,7 @@ Response example
Create share group type
=======================
.. rest_method:: POST /v2/{project_id}/share-group-types
.. rest_method:: POST /v2/share-group-types
.. versionadded:: 2.31
@ -235,7 +235,7 @@ Response example
Show share group type access details
====================================
.. rest_method:: GET /v2/{project_id}/share-group-types/{share_group_type_id}/share_type_access
.. rest_method:: GET /v2/share-group-types/{share_group_type_id}/share_type_access
.. versionadded:: 2.31
@ -283,7 +283,7 @@ Response example
Set extra spec for share group type
===================================
.. rest_method:: POST /v2/{project_id}/share-group-types/{share_group_type_id}/group_specs
.. rest_method:: POST /v2/share-group-types/{share_group_type_id}/group_specs
.. versionadded:: 2.31
@ -336,7 +336,7 @@ Response example
Unset an group spec
===================
.. rest_method:: DELETE /v2/{project_id}/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}
.. versionadded:: 2.31
@ -369,7 +369,7 @@ Request
Add share group type access
===========================
.. rest_method:: POST /v2/{project_id}/share-group-types/{share_group_type_id}/action
.. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action
.. versionadded:: 2.31
@ -412,7 +412,7 @@ Request example
Remove share group type access
==============================
.. rest_method:: POST /v2/{project_id}/share-group-types/{share_group_type_id}/action
.. rest_method:: POST /v2/share-group-types/{share_group_type_id}/action
.. versionadded:: 2.31
@ -455,7 +455,7 @@ Request example
Delete share group type
=======================
.. rest_method:: DELETE /v2/{project_id}/share-group-types/{share_group_type_id}
.. rest_method:: DELETE /v2/share-group-types/{share_group_type_id}
.. versionadded:: 2.31

View File

@ -25,7 +25,7 @@ share groups, and show information for delete a share group.
List share groups
=================
.. rest_method:: GET /v2/{project_id}/share_groups
.. rest_method:: GET /v2/share_groups
.. versionadded:: 2.31
@ -89,7 +89,7 @@ Response example
Show share group details
========================
.. rest_method:: GET /v2/{project_id}/share_groups/{share_group_id}
.. rest_method:: GET /v2/share_groups/{share_group_id}
.. versionadded:: 2.31
@ -148,7 +148,7 @@ Response example
Create share group
==================
.. rest_method:: POST /v2/{project_id}/share_groups
.. rest_method:: POST /v2/share_groups
.. versionadded:: 2.31
@ -220,7 +220,7 @@ Response example
Reset share group state
=======================
.. rest_method:: POST /v2/{project_id}/share-groups/{share_group_id}/action
.. rest_method:: POST /v2/share-groups/{share_group_id}/action
.. versionadded:: 2.31
@ -264,7 +264,7 @@ Request example
Update share group
==================
.. rest_method:: PUT /v2/{project_id}/share-groups/{share_group_id}
.. rest_method:: PUT /v2/share-groups/{share_group_id}
.. versionadded:: 2.31
@ -332,7 +332,7 @@ Response example
Delete share group
==================
.. rest_method:: DELETE /v2/{project_id}/share-groups/{share_group_id}
.. rest_method:: DELETE /v2/share-groups/{share_group_id}
.. versionadded:: 2.31

View File

@ -17,7 +17,7 @@ Show details of an export location belonging to a share instance.
List export locations
=====================
.. rest_method:: GET /v2/{project_id}/share_instances/{share_instance_id}/export_locations
.. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations
.. versionadded:: 2.9
@ -64,7 +64,7 @@ Response example
Show single export location
===========================
.. rest_method:: GET /v2/{project_id}/share_instances/{share_instance_id}/export_locations/{export_location_id}
.. rest_method:: GET /v2/share_instances/{share_instance_id}/export_locations/{export_location_id}
.. versionadded:: 2.9

View File

@ -12,7 +12,7 @@ file to grant permissions for these actions to other roles.
List share instances
====================
.. rest_method:: GET /v2/{project_id}/share_instances
.. rest_method:: GET /v2/share_instances
.. versionadded:: 2.3
@ -70,7 +70,7 @@ Response example
Show share instance details
===========================
.. rest_method:: GET /v2/{project_id}/share_instances/{share_instance_id}
.. rest_method:: GET /v2/share_instances/{share_instance_id}
.. versionadded:: 2.3
@ -128,7 +128,7 @@ Response example
Reset share instance state
==========================
.. rest_method:: POST /v2/{project_id}/share_instances/{share_instance_id}/action
.. rest_method:: POST /v2/share_instances/{share_instance_id}/action
.. versionadded:: 2.3
@ -170,7 +170,7 @@ Request example
Force-delete share instance
===========================
.. rest_method:: POST /v2/{project_id}/share_instances/{share_instance_id}/action
.. rest_method:: POST /v2/share_instances/{share_instance_id}/action
.. versionadded:: 2.3

View File

@ -10,7 +10,7 @@ Shows, sets, updates, and unsets share metadata.
Show all share metadata
=======================
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/metadata
.. rest_method:: GET /v2/shares/{share_id}/metadata
Shows all the metadata for a share, as key and value pairs.
@ -53,7 +53,7 @@ Response example
Show share metadata item
=========================
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/metadata/{key}
.. rest_method:: GET /v2/shares/{share_id}/metadata/{key}
Retrieves a specific metadata item from a share's metadata by its key. If
the specified key does not represent a valid metadata item, the API will
@ -99,7 +99,7 @@ Response example
Set share metadata
==================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/metadata
.. rest_method:: POST /v2/shares/{share_id}/metadata
Allows adding new metadata items as key-value pairs. This API will not delete
pre-existing metadata items. If the request object contains metadata items
@ -154,7 +154,7 @@ Response example
Update share metadata
=====================
.. rest_method:: PUT /v2/{project_id}/shares/{share_id}/metadata
.. rest_method:: PUT /v2/shares/{share_id}/metadata
Replaces the metadata for a given share with the metadata (specified as
key-value pairs) in the request object. All pre-existing metadata of the
@ -223,7 +223,7 @@ Response example
Delete share metadata item
==========================
.. rest_method:: DELETE /v2/{project_id}/shares/{share_id}/metadata/{key}
.. rest_method:: DELETE /v2/shares/{share_id}/metadata/{key}
Deletes a single metadata item on a share, idetified by its key. If
the specified key does not represent a valid metadata item, the API will

View File

@ -69,7 +69,7 @@ Possible use cases for data migration include:
Start Migration
===============
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
.. versionadded:: 2.22
@ -117,7 +117,7 @@ Request example
Complete Migration
==================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
.. versionadded:: 2.22
@ -157,7 +157,7 @@ Request example
Migration Get Process
=====================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
.. versionadded:: 2.22
@ -209,7 +209,7 @@ Response_parameters
Cancel Migration
================
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. rest_method:: POST /v2/shares/{share_id}/action
.. versionadded:: 2.22

View File

@ -46,7 +46,7 @@ A share network subnet resource has these attributes:
List share network subnets
==========================
.. rest_method:: GET /v2/{project_id}/share-networks/{share_network_id}/subnets
.. rest_method:: GET /v2/share-networks/{share_network_id}/subnets
.. versionadded:: 2.51
@ -102,7 +102,7 @@ Response example
Show share network subnet details
=================================
.. rest_method:: GET /v2/{project_id}/share-networks/{share_network_id}/subnets/{share_network_subnet_id}
.. rest_method:: GET /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id}
.. versionadded:: 2.51
@ -159,7 +159,7 @@ Response example
Create share network subnet
===========================
.. rest_method:: POST /v2/{project_id}/share-networks/{share_network_id}/subnets
.. rest_method:: POST /v2/share-networks/{share_network_id}/subnets
.. versionadded:: 2.51
@ -227,7 +227,7 @@ Response example
Delete share network subnet
===========================
.. rest_method:: DELETE /v2/{project_id}/share-networks/{share_network_id}/subnets/{share_network_subnet_id}
.. rest_method:: DELETE /v2/share-networks/{share_network_id}/subnets/{share_network_subnet_id}
.. versionadded:: 2.51

View File

@ -43,7 +43,7 @@ A share network resource can also have a user defined name and description.
List share networks
===================
.. rest_method:: GET /v2/{project_id}/share-networks
.. rest_method:: GET /v2/share-networks
Lists all share networks.
@ -89,7 +89,7 @@ Response example
List share networks with details
================================
.. rest_method:: GET /v2/{project_id}/share-networks/detail
.. rest_method:: GET /v2/share-networks/detail
Lists all share networks with details.
@ -153,7 +153,7 @@ Response example
Show share network details
==========================
.. rest_method:: GET /v2/{project_id}/share-networks/{share_network_id}
.. rest_method:: GET /v2/share-networks/{share_network_id}
Shows details for a share network.
@ -215,7 +215,7 @@ Response example
Create share network
====================
.. rest_method:: POST /v2/{project_id}/share-networks
.. rest_method:: POST /v2/share-networks
Creates a share network.
@ -302,7 +302,7 @@ Response example
Add security service to share network
=====================================
.. rest_method:: POST /v2/{project_id}/share-networks/{share_network_id}/action
.. rest_method:: POST /v2/share-networks/{share_network_id}/action
Adds a security service to a share network.
@ -373,7 +373,7 @@ Response example
Remove security service from share network
==========================================
.. rest_method:: POST /v2/{project_id}/share-networks/{share_network_id}/action
.. rest_method:: POST /v2/share-networks/{share_network_id}/action
Removes a security service from a share network.
@ -443,7 +443,7 @@ Response example
Update share network
====================
.. rest_method:: PUT /v2/{project_id}/share-networks/{share_network_id}
.. rest_method:: PUT /v2/share-networks/{share_network_id}
Updates a share network.
@ -522,7 +522,7 @@ Response example
Delete share network
====================
.. rest_method:: DELETE /v2/{project_id}/share-networks/{share_network_id}
.. rest_method:: DELETE /v2/share-networks/{share_network_id}
Deletes a share network.

View File

@ -11,7 +11,7 @@ Set of APIs used to view export locations of share replicas.
List export locations
=====================
.. rest_method:: GET /v2/{project_id}/share-replicas/{share_replica_id}/export-locations
.. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations
.. versionadded:: 2.47
@ -60,7 +60,7 @@ Response example
Show single export location
===========================
.. rest_method:: GET /v2/{project_id}/share-replicas/{share_replica_id}/export-locations/{export-location-id}
.. rest_method:: GET /v2/share-replicas/{share_replica_id}/export-locations/{export-location-id}
.. versionadded:: 2.47

View File

@ -55,7 +55,7 @@ one of these supported replication types:
Create share replica
====================
.. rest_method:: POST /v2/{project_id}/share-replicas
.. rest_method:: POST /v2/share-replicas
.. versionadded:: 2.11
@ -126,7 +126,7 @@ Response example
Promote share replica
=====================
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -158,7 +158,7 @@ Request
Resync share replica
====================
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -190,7 +190,7 @@ Request
List share replicas
===================
.. rest_method:: GET /v2/{project_id}/share-replicas?share_id={share_id}
.. rest_method:: GET /v2/share-replicas?share_id={share_id}
.. versionadded:: 2.11
@ -238,7 +238,7 @@ Response example
List share replicas with details
================================
.. rest_method:: GET /v2/{project_id}/share-replicas/detail?share_id={share_id}
.. rest_method:: GET /v2/share-replicas/detail?share_id={share_id}
.. versionadded:: 2.11
@ -292,7 +292,7 @@ Response example
Show share replica
==================
.. rest_method:: GET /v2/{project_id}/share-replicas/{share_replica_id}
.. rest_method:: GET /v2/share-replicas/{share_replica_id}
.. versionadded:: 2.11
@ -347,7 +347,7 @@ Response example
Reset status of the share replica
=================================
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -390,7 +390,7 @@ Request example
Reset replica_state of the share replica
========================================
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -433,7 +433,7 @@ Request example
Delete share replica
====================
.. rest_method:: DELETE /v2/{project_id}/share-replicas/{share_replica_id}
.. rest_method:: DELETE /v2/share-replicas/{share_replica_id}
.. versionadded:: 2.11
@ -470,7 +470,7 @@ Request
Force-delete share replica
==========================
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11

View File

@ -43,7 +43,7 @@ The possible share servers statuses are:
List share servers
==================
.. rest_method:: GET /v2/{project_id}/share-servers
.. rest_method:: GET /v2/share-servers
Lists all share servers.
@ -91,7 +91,7 @@ Response example
Show share server
=================
.. rest_method:: GET /v2/{project_id}/share-servers/{share_server_id}
.. rest_method:: GET /v2/share-servers/{share_server_id}
Show a share server's details.
@ -145,7 +145,7 @@ Response example
Show share server back end details
==================================
.. rest_method:: GET /v2/{project_id}/share-servers/{share_server_id}/details
.. rest_method:: GET /v2/share-servers/{share_server_id}/details
Shows back end details of a share server.
@ -188,7 +188,7 @@ Response example
Delete share server
===================
.. rest_method:: DELETE /v2/{project_id}/share-servers/{share_server_id}
.. rest_method:: DELETE /v2/share-servers/{share_server_id}
Deletes a share server.
@ -222,7 +222,7 @@ Request
Manage share server (since API v2.49)
=====================================
.. rest_method:: POST /v2/{project_id}/share-servers/manage
.. rest_method:: POST /v2/share-servers/manage
.. versionadded:: 2.49
@ -291,7 +291,7 @@ Response examples
Unmanage share server (since API v2.49)
=======================================
.. rest_method:: POST /v2/{project_id}/share-servers/{share_server_id}/action
.. rest_method:: POST /v2/share-servers/{share_server_id}/action
.. versionadded:: 2.49
@ -343,7 +343,7 @@ There is no body content for the response.
Reset status (since API v2.49)
==============================
.. rest_method:: POST /v2/{project_id}/share-servers/{share_server_id}/action
.. rest_method:: POST /v2/share-servers/{share_server_id}/action
.. versionadded:: 2.49

View File

@ -93,7 +93,7 @@ other roles.
List share types
================
.. rest_method:: GET /v2/{project_id}/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}
Lists all share types.
@ -142,7 +142,7 @@ Response example
List default share types
========================
.. rest_method:: GET /v2/{project_id}/types/default
.. rest_method:: GET /v2/types/default
Lists default share types.
@ -192,7 +192,7 @@ Response example
Show share type detail
======================
.. rest_method:: GET /v2/{project_id}/types/{share_type_id}
.. rest_method:: GET /v2/types/{share_type_id}
Shows details for a specified share type.
@ -247,7 +247,7 @@ Response Example
List extra specs
================
.. rest_method:: GET /v2/{project_id}/types/{share_type_id}/extra_specs
.. rest_method:: GET /v2/types/{share_type_id}/extra_specs
Lists the extra specifications for a share type.
@ -296,7 +296,7 @@ Response example
Create share type
=================
.. rest_method:: POST /v2/{project_id}/types
.. rest_method:: POST /v2/types
Creates a share type.
@ -369,7 +369,7 @@ Response example
Show share type access details
==============================
.. rest_method:: GET /v2/{project_id}/types/{share_type_id}/share_type_access
.. rest_method:: GET /v2/types/{share_type_id}/share_type_access
Shows access details for a share type.
@ -415,7 +415,7 @@ Response example
Set extra spec for share type
=============================
.. rest_method:: POST /v2/{project_id}/types/{share_type_id}/extra_specs
.. rest_method:: POST /v2/types/{share_type_id}/extra_specs
Sets an extra specification for the share type.
@ -471,7 +471,7 @@ Response example
Unset an extra spec
===================
.. rest_method:: DELETE /v2/{project_id}/types/{share_type_id}/extra_specs/{extra-spec-key}
.. rest_method:: DELETE /v2/types/{share_type_id}/extra_specs/{extra-spec-key}
Unsets an extra specification for the share type.
@ -502,7 +502,7 @@ Request
Add share type access
=====================
.. rest_method:: POST /v2/{project_id}/types/{share_type_id}/action
.. rest_method:: POST /v2/types/{share_type_id}/action
Adds share type access for a project.
@ -543,7 +543,7 @@ Request example
Remove share type access
========================
.. rest_method:: POST /v2/{project_id}/types/{share_type_id}/action
.. rest_method:: POST /v2/types/{share_type_id}/action
Removes share type access from a project.
@ -583,7 +583,7 @@ Request example
Delete share type
=================
.. rest_method:: DELETE /v2/{project_id}/types/{share_type_id}
.. rest_method:: DELETE /v2/types/{share_type_id}
Deletes a share type.
@ -613,7 +613,7 @@ Request
Update share type (since API v2.50)
===================================
.. rest_method:: PUT /v2/{project_id}/types/{share_type_id}
.. rest_method:: PUT /v2/types/{share_type_id}
.. versionadded:: 2.50

View File

@ -89,7 +89,7 @@ A share has one of these status values:
List shares
===========
.. rest_method:: GET /v2/{project_id}/shares
.. rest_method:: GET /v2/shares
Lists all shares.
@ -155,7 +155,7 @@ Response example
List shares with details
========================
.. rest_method:: GET /v2/{project_id}/shares/detail
.. rest_method:: GET /v2/shares/detail
Lists all shares, with details.
@ -249,7 +249,7 @@ Response example
Show share details
==================
.. rest_method:: GET /v2/{project_id}/shares/{share_id}
.. rest_method:: GET /v2/shares/{share_id}
Shows details for a share.
@ -321,7 +321,7 @@ Response example
Create share
============
.. rest_method:: POST /v2/{project_id}/shares
.. rest_method:: POST /v2/shares
Creates a share.
@ -412,7 +412,7 @@ Response example
Manage share (since API v2.7)
=============================
.. rest_method:: POST /v2/{project_id}/shares/manage
.. rest_method:: POST /v2/shares/manage
.. versionadded:: 2.7
@ -511,7 +511,7 @@ Response example
Update share
============
.. rest_method:: PUT /v2/{project_id}/shares/{share_id}
.. rest_method:: PUT /v2/shares/{share_id}
Updates a share.
@ -603,7 +603,7 @@ Response example
Delete share
============
.. rest_method:: DELETE /v2/{project_id}/shares/{share_id}
.. rest_method:: DELETE /v2/shares/{share_id}
Deletes a share.

View File

@ -19,7 +19,7 @@ to grant permissions for these actions to other roles.
List share snapshot instances
=============================
.. rest_method:: GET /v2/{project_id}/snapshot-instances
.. rest_method:: GET /v2/snapshot-instances
.. versionadded:: 2.19
@ -65,7 +65,7 @@ Response example
List share snapshot instances with details
==========================================
.. rest_method:: GET /v2/{project_id}/snapshot-instances/detail
.. rest_method:: GET /v2/snapshot-instances/detail
.. versionadded:: 2.19
@ -117,7 +117,7 @@ Response example
Show share snapshot instance details
====================================
.. rest_method:: GET /v2/{project_id}/snapshot-instances/{snapshot_instance_id}
.. rest_method:: GET /v2/snapshot-instances/{snapshot_instance_id}
.. versionadded:: 2.19
@ -170,7 +170,7 @@ Response example
Reset share snapshot instance state
===================================
.. rest_method:: POST /v2/{project_id}/snapshot-instances/{snapshot_instance_id}/action
.. rest_method:: POST /v2/snapshot-instances/{snapshot_instance_id}/action
.. versionadded:: 2.19

View File

@ -46,7 +46,7 @@ file to grant permissions for these actions to other roles.
List share snapshots
====================
.. rest_method:: GET /v2/{project_id}/snapshots
.. rest_method:: GET /v2/snapshots
Lists all share snapshots.
@ -90,7 +90,7 @@ Response example
List share snapshots with details
=================================
.. rest_method:: GET /v2/{project_id}/snapshots/detail
.. rest_method:: GET /v2/snapshots/detail
Lists all share snapshots with details.
@ -143,7 +143,7 @@ Response example
Show share snapshot details
===========================
.. rest_method:: GET /v2/{project_id}/snapshots/{snapshot_id}
.. rest_method:: GET /v2/snapshots/{snapshot_id}
Shows details for a share snapshot.
@ -195,7 +195,7 @@ Response example
Create share snapshot
=====================
.. rest_method:: POST /v2/{project_id}/snapshots
.. rest_method:: POST /v2/snapshots
Creates a snapshot from a share.
@ -262,7 +262,7 @@ Response example
Manage share snapshot (since API v2.12)
=======================================
.. rest_method:: POST /v2/{project_id}/snapshots/manage
.. rest_method:: POST /v2/snapshots/manage
.. versionadded:: 2.12
@ -337,7 +337,7 @@ Response example
Unmanage share snapshot (since API v2.12)
=========================================
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
.. rest_method:: POST /v2/snapshots/{snapshot_id}/action
.. versionadded:: 2.12
@ -387,7 +387,7 @@ There is no body content for the response.
Reset share snapshot state
==========================
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
.. rest_method:: POST /v2/snapshots/{snapshot_id}/action
Administrator only. Explicitly updates the state of a share snapshot.
@ -427,7 +427,7 @@ Request example
Force-delete share snapshot
===========================
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
.. rest_method:: POST /v2/snapshots/{snapshot_id}/action
Administrator only. Force-deletes a share snapshot in any state.
@ -467,7 +467,7 @@ Request example
Update share snapshot
=====================
.. rest_method:: PUT /v2/{project_id}/snapshots/{snapshot_id}
.. rest_method:: PUT /v2/snapshots/{snapshot_id}
Updates a share snapshot.
@ -540,7 +540,7 @@ Response example
Delete share snapshot
=====================
.. rest_method:: DELETE /v2/{project_id}/snapshots/{snapshot_id}
.. rest_method:: DELETE /v2/snapshots/{snapshot_id}
Deletes a share snapshot.

View File

@ -20,7 +20,7 @@ creation request with different parameters.
List user messages
==================
.. rest_method:: GET /v2/{project_id}/messages
.. rest_method:: GET /v2/messages
.. versionadded:: 2.37
@ -83,7 +83,7 @@ Response example
Show user message details
=========================
.. rest_method:: GET /v2/{project_id}/messages/{message_id}
.. rest_method:: GET /v2/messages/{message_id}
.. versionadded:: 2.37
@ -136,7 +136,7 @@ Response example
Delete message
==============
.. rest_method:: DELETE /v2/{project_id}/messages/{message_id}
.. rest_method:: DELETE /v2/messages/{message_id}
.. versionadded:: 2.37

View File

@ -108,56 +108,56 @@ must create a database, service credentials, and `API endpoints`.
$ openstack endpoint create --region RegionOne \
share public http://controller:8786/v1/%\(tenant_id\)s
+--------------+-----------------------------------------+
| Field | Value |
+--------------+-----------------------------------------+
| enabled | True |
| id | 0bd2bbf8d28b433aaea56a254c69f69d |
| interface | public |
| region | RegionOne |
| region_id | RegionOne |
| service_id | 82378b5a16b340aa9cc790cdd46a03ba |
| service_name | manila |
| service_type | share |
| url | http://controller:8786/v1/%(tenant_id)s |
+--------------+-----------------------------------------+
+--------------+------------------------------------------+
| Field | Value |
+--------------+------------------------------------------+
| enabled | True |
| id | 0bd2bbf8d28b433aaea56a254c69f69d |
| interface | public |
| region | RegionOne |
| region_id | RegionOne |
| service_id | 82378b5a16b340aa9cc790cdd46a03ba |
| service_name | manila |
| service_type | share |
| url | http://controller:8786/v1/%(project_id)s |
+--------------+------------------------------------------+
$ openstack endpoint create --region RegionOne \
share internal http://controller:8786/v1/%\(tenant_id\)s
+--------------+-----------------------------------------+
| Field | Value |
+--------------+-----------------------------------------+
| enabled | True |
| id | a2859b5732cc48b5b083dd36dafb6fd9 |
| interface | internal |
| region | RegionOne |
| region_id | RegionOne |
| service_id | 82378b5a16b340aa9cc790cdd46a03ba |
| service_name | manila |
| service_type | share |
| url | http://controller:8786/v1/%(tenant_id)s |
+--------------+-----------------------------------------+
+--------------+------------------------------------------+
| Field | Value |
+--------------+------------------------------------------+
| enabled | True |
| id | a2859b5732cc48b5b083dd36dafb6fd9 |
| interface | internal |
| region | RegionOne |
| region_id | RegionOne |
| service_id | 82378b5a16b340aa9cc790cdd46a03ba |
| service_name | manila |
| service_type | share |
| url | http://controller:8786/v1/%(project_id)s |
+--------------+------------------------------------------+
$ openstack endpoint create --region RegionOne \
share admin http://controller:8786/v1/%\(tenant_id\)s
+--------------+-----------------------------------------+
| Field | Value |
+--------------+-----------------------------------------+
| enabled | True |
| id | f7f46df93a374cc49c0121bef41da03c |
| interface | admin |
| region | RegionOne |
| region_id | RegionOne |
| service_id | 82378b5a16b340aa9cc790cdd46a03ba |
| service_name | manila |
| service_type | share |
| url | http://controller:8786/v1/%(tenant_id)s |
+--------------+-----------------------------------------+
+--------------+------------------------------------------+
| Field | Value |
+--------------+------------------------------------------+
| enabled | True |
| id | f7f46df93a374cc49c0121bef41da03c |
| interface | admin |
| region | RegionOne |
| region_id | RegionOne |
| service_id | 82378b5a16b340aa9cc790cdd46a03ba |
| service_name | manila |
| service_type | share |
| url | http://controller:8786/v1/%(project_id)s |
+--------------+------------------------------------------+
.. code-block:: console
$ openstack endpoint create --region RegionOne \
sharev2 public http://controller:8786/v2/%\(tenant_id\)s
sharev2 public http://controller:8786/v2
+--------------+-----------------------------------------+
| Field | Value |
+--------------+-----------------------------------------+
@ -169,11 +169,11 @@ must create a database, service credentials, and `API endpoints`.
| service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 |
| service_name | manilav2 |
| service_type | sharev2 |
| url | http://controller:8786/v2/%(tenant_id)s |
| url | http://controller:8786/v2 |
+--------------+-----------------------------------------+
$ openstack endpoint create --region RegionOne \
sharev2 internal http://controller:8786/v2/%\(tenant_id\)s
sharev2 internal http://controller:8786/v2
+--------------+-----------------------------------------+
| Field | Value |
+--------------+-----------------------------------------+
@ -185,11 +185,11 @@ must create a database, service credentials, and `API endpoints`.
| service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 |
| service_name | manilav2 |
| service_type | sharev2 |
| url | http://controller:8786/v2/%(tenant_id)s |
| url | http://controller:8786/v2 |
+--------------+-----------------------------------------+
$ openstack endpoint create --region RegionOne \
sharev2 admin http://controller:8786/v2/%\(tenant_id\)s
sharev2 admin http://controller:8786/v2
+--------------+-----------------------------------------+
| Field | Value |
+--------------+-----------------------------------------+
@ -201,7 +201,7 @@ must create a database, service credentials, and `API endpoints`.
| service_id | 30d92a97a81a4e5d8fd97a32bafd7b88 |
| service_name | manilav2 |
| service_type | sharev2 |
| url | http://controller:8786/v2/%(tenant_id)s |
| url | http://controller:8786/v2 |
+--------------+-----------------------------------------+
.. note::