openstack/manila
Code Issues Proposed changes

[api-ref] Replace "tenant" terminology with "project"

Browse Source 
Nowadays "project" and "project_id" are used instead of "tenant" in
the OpenStack world. See [1] and [2].

- Replace "tenant_id" in the API paths to "project_id"
- For most manila resources, the "project_id" in an API response body
  refers to the project that owns the resource. So, create a unified
  parameter and share that across the APIs.
- Fix path variable names, and their order
- Fix usage of "UUID" to refer to project and user IDs
- Fix query parameters

[1] https://docs.openstack.org/operations-guide/ops-projects-users.html
[2] https://developer.openstack.org/api-ref/identity/v3/index.html#projects

Partial-Bug: #1760644
Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com>
Change-Id: I64e4ef8ad258d07c7d80d11a4d015c4b82156722
This commit is contained in:
Thomas Bechtold 2018-12-07 19:55:30 +01:00 committed by Goutham Pacha Ravi
parent fb4a1b81f4
commit d7140ffe09
30 changed files with 445 additions and 441 deletions

4
api-ref/source/availability-zones.inc

@ -16,7 +16,7 @@ configured with.
List availability zones
=======================
.. rest_method:: GET /v2/{tenant_id}/availability-zones
.. rest_method:: GET /v2/{project_id}/availability-zones
Lists all availability zones.
@ -38,7 +38,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- project_id: project_id_path
Response parameters
-------------------

4
api-ref/source/extensions.inc

@ -10,7 +10,7 @@ Lists available Shared File Systems API extensions.
List extensions
===============
.. rest_method:: GET /v2/{tenant_id}/extensions
.. rest_method:: GET /v2/{project_id}/extensions
Lists all extensions.
@ -32,7 +32,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
Response parameters
-------------------

4
api-ref/source/limits.inc

@ -33,7 +33,7 @@ GET requests that can be processed during a one-minute period.
List share limits
=================
.. rest_method:: GET /v2/{tenant_id}/limits
.. rest_method:: GET /v2/{project_id}/limits
Lists share limits.
@ -55,7 +55,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
Response parameters
-------------------

10
api-ref/source/os-share-manage.inc

@ -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/{tenant_id}/os-share-manage
.. rest_method:: POST /v2/{project_id}/os-share-manage
Use this API to bring a share under the management of the Shared File
Systems service.
@ -45,7 +45,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share: share
- protocol: protocol
- name: name_5
@ -83,7 +83,7 @@ Response parameters
- has_replicas: has_replicas
- replication_type: replication_type
- export_location: export_location
- project_id: project_id_8
- project_id: project_id
- metadata: metadata
- status: status_8
- description: description_5
@ -112,7 +112,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/{tenant_id}/os-share-unmanage/{share_id}/unmanage
.. rest_method:: POST /v2/{project_id}/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.
@ -149,7 +149,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: share_id

209
api-ref/source/parameters.yaml

@ -20,7 +20,7 @@ export_location_id_path:
in: path
required: true
type: string
extra-spec-key-path:
extra_spec_key_path:
description: |
The extra specification key
in: path
@ -48,7 +48,18 @@ metadata_key_path:
type: string
project_id_path:
description: |
The ID of the project what owns the resource.
The project ID of the user or service making the API request.
in: path
required: true
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.
in: path
required: true
type: string
@ -127,21 +138,6 @@ snapshot_instance_id_path:
in: path
required: true
type: string
tenant_id:
description: |
The ID for the tenant for which you want to
show, update, or delete quotas. This ID is different from the
first tenant ID that you specify in the URI: That ID is for the
administrative tenant.
in: path
required: true
type: string
tenant_id_path:
description: |
The tenant ID in a multi-tenancy cloud.
in: path
required: true
type: string
# variables in query
action_id:
@ -154,7 +150,7 @@ all_tenants:
description: |
(Admin only). Defines whether to list the requested resources for
all projects. Set to ``1`` to list resources for all projects.
Set to ``0`` to list resources only for the current tenant. Examples
Set to ``0`` to list resources only for the current project. Examples
of resources include shares, snapshots, share networks, security services
and share groups.
in: query
@ -259,6 +255,13 @@ host_7:
in: query
required: false
type: string
is_public_query:
description: |
A boolean query parameter that, when set to true, allows retrieving
public resources that belong to all projects.
in: query
required: false
type: boolean
limit:
description: |
The maximum number of shares to return.
@ -304,19 +307,19 @@ offset:
in: query
required: false
type: integer
project_id_6:
description: |
The ID of the project in which the share was
created. Useful with ``all_tenants`` parameter.
in: query
required: false
type: string
project_id_messages:
description: |
The ID of the project for which the message was created.
in: query
required: false
type: string
project_id_query:
description: |
The ID of the project that owns the resource. This query parameter is
useful in conjunction with the ``all_tenants`` parameter.
in: query
required: false
type: string
request_id:
description: |
The ID of the request during which the message was created.
@ -389,6 +392,18 @@ share_group_type_id_query:
in: query
required: false
type: string
share_id_access_rules_query:
description: |
The share ID to filter share access rules with.
in: query
required: true
type: string
share_id_replicas_query:
description: |
The share ID to filter share replicas with.
in: query
required: false
type: string
share_network_id_query:
description: |
The UUID of the share network.
@ -490,9 +505,9 @@ status_6:
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 tenant.
If you omit this parameter, you update the quotas for the project.
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.
in: query
required: false
type: string
@ -661,6 +676,13 @@ action_id_body:
type: string
description: >
The ID of the action during which the message was created.
add_project_access:
description: |
An object representing the project resource that access should be
granted to.
in: body
required: true
type: object
alias:
description: |
The alias for the extension. For example,
@ -1357,7 +1379,7 @@ extension_updated:
in: body
required: true
type: string
extra-spec-key:
extra_spec_key:
description: |
The extra specification key
in: body
@ -2078,56 +2100,33 @@ project:
in: body
required: true
type: string
project_1:
description: |
The UUID of the project for which access to the
share type is denied.
in: body
required: true
type: string
project_id:
description: |
The UUID of the project where the share network
was created.
in: body
required: true
type: string
project_id_4:
description: |
The UUID of the project in which the share was
created.
in: body
required: true
type: string
project_id_8:
description: |
The UUID of the project where the share was
created.
in: body
required: true
type: string
project_id_9:
description: |
The UUID of the project for which access to the
share type is granted.
The ID of the project that owns the resource.
in: body
required: true
type: string
project_id_messages_body:
description: |
The UUID of the project for which the message was created.
The ID of the project for which the message was created.
in: body
required: true
type: string
project_id_share_server_body:
project_id_type_access:
description: |
The project ID.
The ID of the project that has been granted access to the type resource.
in: body
required: true
type: string
project_id_share_server_manage:
project_id_type_access_grant_request:
description: |
The ID of the project that owns the share server.
The ID of the project that needs to have access to the type resource.
in: body
required: true
type: string
project_id_type_access_revoke_request:
description: |
The ID of the project whose access to the type resource must be revoked.
in: body
required: true
type: string
@ -2159,24 +2158,30 @@ quota_class_set:
type: object
quota_gigabytes:
description: |
The number of gigabytes allowed for each tenant.
The number of gigabytes allowed for each project.
in: body
required: true
type: integer
quota_gigabytes_detail:
description: |
The limit, in_use, reserved number of gigabytes allowed
for each tenant.
for each project.
in: body
min_version: 2.25
required: true
type: object
quota_gigabytes_request:
description: |
The number of gigabytes for the tenant.
The number of gigabytes for the project.
in: body
required: false
type: integer
quota_project_id:
description: |
The ID of the project the quota pertains to.
in: body
required: true
type: string
quota_set:
description: |
The ``quota_set`` object.
@ -2185,7 +2190,7 @@ quota_set:
type: object
quota_share_group_snapshots:
description: |
The number of share group snapshots allowed for each tenant or user.
The number of share group snapshots allowed for each project or user.
in: body
min_version: 2.40
required: true
@ -2193,21 +2198,21 @@ quota_share_group_snapshots:
quota_share_group_snapshots_detail:
description: |
The limit, in_use, reserved number of share group snapshots
for each tenant or user.
for each project or user.
in: body
min_version: 2.40
required: true
type: object
quota_share_group_snapshots_request:
description: |
The number of share group snapshots allowed for each tenant or user.
The number of share group snapshots allowed for each project or user.
in: body
min_version: 2.40
required: false
type: integer
quota_share_groups:
description: |
The number of share groups allowed for each tenant or user.
The number of share groups allowed for each project or user.
in: body
min_version: 2.40
required: true
@ -2215,14 +2220,14 @@ quota_share_groups:
quota_share_groups_detail:
description: |
The limit, in_use, reserved number of share groups
for each tenant or user.
for each project or user.
in: body
min_version: 2.40
required: true
type: object
quota_share_groups_request:
description: |
The number of share groups allowed for each tenant or user.
The number of share groups allowed for each project or user.
in: body
min_version: 2.40
required: false
@ -2236,7 +2241,7 @@ quota_share_networks:
type: integer
quota_share_networks_default:
description: |
The number of share networks allowed for each tenant.
The number of share networks allowed for each project.
in: body
required: true
type: integer
@ -2250,41 +2255,40 @@ quota_share_networks_detail:
type: object
quota_share_networks_request:
description: |
The number of share networks for the tenant.
The number of share networks for the project.
in: body
required: false
type: integer
quota_shares:
description: |
The number of shares allowed for each tenant.
The number of shares allowed for each project.
in: body
required: true
type: integer
quota_shares_detail:
description: |
The limit, in_use, reserved number of shares allowed
for each tenant.
for each project.
in: body
min_version: 2.25
required: true
type: object
quota_shares_request:
description: |
The number of shares for the tenant.
The number of shares for the project.
in: body
required: false
type: integer
quota_snapshot_gigabytes:
description: |
The number of gigabytes for the snapshots allowed
for each tenant.
The number of gigabytes for the snapshots allowed for each project.
in: body
required: true
type: integer
quota_snapshot_gigabytes_detail:
description: |
The limit, in_use, reserved number of gigabytes for the
snapshots allowed for each tenant.
snapshots allowed for each project.
in: body
min_version: 2.25
required: true
@ -2292,37 +2296,30 @@ quota_snapshot_gigabytes_detail:
quota_snapshot_gigabytes_request:
description: |
The number of gigabytes for the snapshots for the
tenant.
project.
in: body
required: false
type: integer
quota_snapshots:
description: |
The number of snapshots allowed for each tenant.
The number of snapshots allowed for each project.
in: body
required: true
type: integer
quota_snapshots_detail:
description: |
The limit, in_use, reserved number of snapshots allowed
for each tenant.
for each project.
in: body
min_version: 2.25
required: true
type: object
quota_snapshots_request:
description: |
The number of snapshots for the tenant.
The number of snapshots for the project.
in: body
required: false
type: integer
quota_tenant_id:
description: |
The UUID of the tenant for which you manage
quotas.
in: body
required: true
type: string
regex:
description: |
An API regular expression. For example,
@ -2336,6 +2333,13 @@ remaining:
in: body
required: false
type: integer
remove_project_access:
description: |
An object representing the project resource that access should be
revoked from.
in: body
required: true
type: object
replica_state:
description: |
The share replica state. Has set value only when replication
@ -2431,15 +2435,13 @@ security_service_description_request:
type: string
security_service_dns_ip:
description: |
The DNS IP address that is used inside the tenant
network.
The DNS IP address that is used inside the project network.
in: body
required: true
type: string
security_service_dns_ip_request:
description: |
The DNS IP address that is used inside the tenant
network.
The DNS IP address that is used inside the project network.
in: body
required: false
type: string
@ -2494,13 +2496,6 @@ security_service_password_request:
in: body
required: false
type: string
security_service_project_id:
description: |
The UUID of the project where the security
service was created.
in: body
required: true
type: string
security_service_server:
description: |
The security service host name or IP address.
@ -2553,15 +2548,13 @@ security_service_updated_at:
type: string
security_service_user:
description: |
The security service user or group name that is
used by the tenant.
The security service user or group name that is used by the project.
in: body
required: true
type: string
security_service_user_request:
description: |
The security service user or group name that is
used by the tenant.
The security service user or group name that is used by the project.
in: body
required: false
type: string
@ -3855,7 +3848,7 @@ uri:
type: string
user_id:
description: |
ID of the user that is part of a given tenant.
ID of the user that is part of a given project.
in: body
required: false
type: string

8
api-ref/source/quota-classes.inc

@ -9,7 +9,7 @@ Quota classes can be shown and updated for a project.
Show quota classes for a project
================================
.. rest_method:: GET /v2/{tenant_id}/quota-class-sets/{quota_class_name}
.. rest_method:: GET /v2/{project_id}/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.
@ -31,7 +31,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- project_id: project_id_path
- quota_class_name: quota_class_name
@ -60,7 +60,7 @@ Response Example
Update quota classes for a project
==================================
.. rest_method:: PUT /v2/{tenant_id}/quota-class-sets/{quota_class_name}
.. rest_method:: PUT /v2/{project_id}/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.
@ -83,7 +83,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- project_id: project_id_path
- quota_class_name: quota_class_name
- shares: maxTotalSharesOptional
- snapshots: maxTotalShareSnapshotsOptional

56
api-ref/source/quota-sets.inc

@ -26,9 +26,9 @@ Provides quotas management support.
Show default quota set
======================
.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}/defaults
.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}/defaults
Shows default quotas for a tenant.
Shows default quotas for a given project.
Response codes
--------------
@ -48,8 +48,8 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- project_id: project_id_path
- project_id: project_id_quota_request_path
Response parameters
-------------------
@ -57,7 +57,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
- id: quota_tenant_id
- id: quota_project_id
- gigabytes: quota_gigabytes
- snapshots: quota_snapshots
- shares: quota_shares
@ -77,12 +77,12 @@ Response example
Show quota set
==============
.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id}
.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
Shows quotas for a tenant.
Shows quotas for a given project..
If you specify the optional ``user_id`` query parameter, you get
the quotas for this user in the tenant. If you omit this parameter,
the quotas for this user in the project. If you omit this parameter,
you get the quotas for the project.
Response codes
@ -103,8 +103,8 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- project_id: project_id_path
- project_id: project_id_quota_request_path
- user_id: user_id_query
- share_type: share_type_for_quota
@ -114,7 +114,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
- id: quota_tenant_id
- id: quota_project_id
- gigabytes: quota_gigabytes
- snapshots: quota_snapshots
- shares: quota_shares
@ -133,14 +133,14 @@ Response example
Show quota set in detail (since API v2.25)
==========================================
.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}/detail?user_id={user_id}
.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}/detail?user_id={user_id}
.. versionadded:: 2.25
Shows quotas for a tenant in detail.
Shows quotas for a project in detail.
If you specify the optional ``user_id`` query parameter, you get
the quotas for this user in the tenant. If you omit this parameter,
the quotas for this user in the project. If you omit this parameter,
you get the quotas for the project.
Response codes
@ -161,8 +161,8 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- project_id: project_id_path
- project_id: project_id_quota_request_path
- user_id: user_id_query
- share_type: share_type_for_quota
@ -172,7 +172,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
- id: quota_tenant_id
- id: quota_project_id
- gigabytes: quota_gigabytes_detail
- snapshots: quota_snapshots_detail
- shares: quota_shares_detail
@ -191,12 +191,12 @@ Response example
Update quota set
================
.. rest_method:: PUT /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id}
.. rest_method:: PUT /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
Updates quotas for a tenant.
Updates quotas for a project.
If you specify the optional ``user_id`` query parameter, you update
the quotas for this user in the tenant. If you omit this parameter,
the quotas for this user in the project. If you omit this parameter,
you update the quotas for the project.
Response codes
@ -217,8 +217,8 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- project_id: project_id_path
- project_id: project_id_quota_request_path
- user_id: user_id_query
- quota_set: quota_set
- force: force
@ -243,7 +243,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- quota_set: quota_set
- id: quota_tenant_id
- id: quota_project_id
- gigabytes: quota_gigabytes
- snapshots: quota_snapshots
- shares: quota_shares
@ -262,12 +262,12 @@ Response example
Delete quota set
================
.. rest_method:: DELETE /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id}
.. rest_method:: DELETE /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
Deletes quotas for a tenant. The quota reverts to the default quota.
Deletes quotas for a project. The quota reverts to the default quota.
If you specify the optional ``user_id`` query parameter, you delete
the quotas for this user in the tenant. If you omit this parameter,
the quotas for this user in the project. If you omit this parameter,
you delete the quotas for the project.
Response codes
@ -288,7 +288,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- tenant_id: tenant_id
- project_id: project_id_path
- project_id: project_id_quota_request_path
- user_id: user_id_query
- share_type: share_type_for_quota

8
api-ref/source/scheduler-stats.inc

@ -11,7 +11,7 @@ to the scheduler service.
List back-end storage pools
===========================
.. rest_method:: GET /v2/{tenant_id}/scheduler-stats/pools?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type}
.. rest_method:: GET /v2/{project_id}/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.
@ -34,7 +34,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- pool_name: backend_pool_query
- host_name: backend_host_query
- backend_name: backend_query
@ -61,7 +61,7 @@ Response example
List back-end storage pools with details
========================================
.. rest_method:: GET /v2/{tenant_id}/scheduler-stats/pools/detail?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type}
.. 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}
Lists all back-end storage pools with details. If search options are provided,
the pool list that is returned is filtered with these options.
@ -84,7 +84,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- pool_name: backend_pool_query
- host_name: backend_host_query
- backend_name: backend_query

32
api-ref/source/security-services.inc

@ -38,7 +38,7 @@ You can configure a security service with these options:
List security services
======================
.. rest_method:: GET /v2/{tenant_id}/security-services
.. rest_method:: GET /v2/{project_id}/security-services
Lists all security services.
@ -60,7 +60,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
Response parameters
@ -83,7 +83,7 @@ Response example
List security services with details
===================================
.. rest_method:: GET /v2/{tenant_id}/security-services/detail
.. rest_method:: GET /v2/{project_id}/security-services/detail
Lists all security services with details.
@ -105,7 +105,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
Response parameters
@ -115,7 +115,7 @@ Response parameters
- status: security_service_status
- id: security_service_id
- project_id: security_service_project_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
@ -138,7 +138,7 @@ Response example
Show security service details
=============================
.. rest_method:: GET /v2/{tenant_id}/security-services/{security_service_id}
.. rest_method:: GET /v2/{project_id}/security-services/{security_service_id}
Shows details for a security service.
@ -161,7 +161,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- security_service_id: security_service_id_path
Response parameters
@ -171,7 +171,7 @@ Response parameters
- status: security_service_status
- id: security_service_id
- project_id: security_service_project_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
@ -194,7 +194,7 @@ Response example
Create security service
=======================
.. rest_method:: POST /v2/{tenant_id}/security-services
.. rest_method:: POST /v2/{project_id}/security-services
Creates a security service.
@ -217,7 +217,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- type: security_service_type
- name: security_service_name
- description: security_service_description_request
@ -241,7 +241,7 @@ Response parameters
- status: security_service_status
- id: security_service_id
- project_id: security_service_project_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
@ -264,7 +264,7 @@ Response example
Update security service
=======================
.. rest_method:: PUT /v2/{tenant_id}/security-services/{security_service_id}
.. rest_method:: PUT /v2/{project_id}/security-services/{security_service_id}
Updates a security service.
@ -293,7 +293,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- security_service_id: security_service_id_path
- type: security_service_type
- name: security_service_name
@ -318,7 +318,7 @@ Response parameters
- status: security_service_status
- id: security_service_id
- project_id: security_service_project_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
@ -341,7 +341,7 @@ Response example
Delete security service
=======================
.. rest_method:: DELETE /v2/{tenant_id}/security-services/{security_service_id}
.. rest_method:: DELETE /v2/{project_id}/security-services/{security_service_id}
Deletes a security service.
@ -364,5 +364,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- security_service_id: security_service_id_path

12
api-ref/source/services.inc

@ -16,7 +16,7 @@ These APIs help in interacting with the Shared File Systems services,
List services
=============
.. rest_method:: GET /v2/{tenant_id}/services?host={host}&binary={binary}&zone={zone}&state={state}&status={status}
.. rest_method:: GET /v2/{project_id}/services?host={host}&binary={binary}&zone={zone}&state={state}&status={status}
Lists all services optionally filtered with the specified search options.
@ -38,7 +38,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- host: service_host_query
- binary: service_binary_query
- zone: service_zone_query
@ -69,7 +69,7 @@ Response example
Enable service
==============
.. rest_method:: PUT /v2/{tenant_id}/services/enable
.. rest_method:: PUT /v2/{project_id}/services/enable
Enables a service.
@ -92,7 +92,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- binary: service_enable_binary_request
- host: service_enable_host_request
@ -121,7 +121,7 @@ Response example
Disable service
===============
.. rest_method:: PUT /v2/{tenant_id}/services/disable
.. rest_method:: PUT /v2/{project_id}/services/disable
Disables a service.
@ -144,7 +144,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- binary: service_disable_binary_request
- host: service_disable_host_request

10
api-ref/source/share-access-rule-metadata.inc

@ -9,7 +9,7 @@ Updates, and unsets share access rule metadata.
Update share access rule metadata
==================================
.. rest_method:: PUT /v2/{tenant_id}/share-access-rules/{access_id}/metadata
.. rest_method:: PUT /v2/{project_id}/share-access-rules/{access_id}/metadata
.. versionadded:: 2.45
@ -34,9 +34,9 @@ Request
.. rest_parameters:: parameters.yaml
- metadata: access_metadata
- project_id: project_id_path
- access_id: access_id_path
- tenant_id: tenant_id_path
- metadata: access_metadata
Request example
---------------
@ -61,7 +61,7 @@ Response example
Unset share access rule metadata
================================
.. rest_method:: DELETE /v2/{tenant_id}/share-access-rules/{access_id}/metadata/{key}
.. rest_method:: DELETE /v2/{project_id}/share-access-rules/{access_id}/metadata/{key}
.. versionadded:: 2.45
@ -89,6 +89,6 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- access_id: access_id_path
- tenant_id: tenant_id_path
- key: metadata_key_path

10
api-ref/source/share-access-rules.inc

@ -11,7 +11,7 @@ Retrieve details about access rules
Describe share access rule
==========================
.. rest_method:: GET /v2/{tenant_id}/share-access-rules/{access_id}
.. rest_method:: GET /v2/{project_id}/share-access-rules/{access_id}
.. versionadded:: 2.45
@ -36,8 +36,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- access_id: access_id_path
- tenant_id: tenant_id_path
Response parameters
-------------------
@ -65,7 +65,7 @@ Response example
List share access rules
=======================
.. rest_method:: GET /v2/{tenant_id}/share-access-rules?share_id={share-id}
.. rest_method:: GET /v2/{project_id}/share-access-rules?share_id={share-id}
.. versionadded:: 2.45
@ -95,9 +95,9 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id_access_rules_query
- metadata: metadata
- share_id: share_id
- tenant_id: tenant_id_path
Response parameters
-------------------

59
api-ref/source/share-actions.inc

@ -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/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
Grants access to a share.
@ -93,12 +93,12 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- allow_access: allow_access
- access_level: access_level
- access_type: access_type
- access_to: access_to
- share_id: share_id
- tenant_id: tenant_id_path
- access_metadata: metadata
Request example
@ -133,7 +133,7 @@ Response example
Revoke access
=============
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/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
@ -158,10 +158,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- deny_access: deny_access
- access_id: access_id
- share_id: share_id
- tenant_id: tenant_id_path
Request example
---------------
@ -180,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/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
Lists access rules for a share. The Access ID returned is necessary to deny
access.
@ -204,9 +205,10 @@ Request
.. rest_parameters:: parameters.yaml
- access_list: access_list
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- access_list: access_list
Request example
---------------
@ -240,7 +242,7 @@ Response example
Reset share state
=================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
Administrator only. Explicitly updates the state of a share.
@ -266,10 +268,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- reset_status: reset_status
- status: access_status
- share_id: share_id
- tenant_id: tenant_id_path
Request example
---------------
@ -281,7 +284,7 @@ Request example
Force-delete share
==================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
Administrator only. Force-deletes a share in any state.
@ -307,9 +310,9 @@ Request
.. rest_parameters:: parameters.yaml
- force_delete: share_force_delete
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- force_delete: share_force_delete
Request example
---------------
@ -321,7 +324,7 @@ Request example
Extend share
============
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
Increases the size of a share.
@ -344,10 +347,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- extend: extend
- new_size: share_new_size
- share_id: share_id
- tenant_id: tenant_id_path
Request example
---------------
@ -359,7 +363,7 @@ Request example
Shrink share
============
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
Shrinks the size of a share.
@ -382,10 +386,10 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- shrink: shrink
- new_size: share_new_size
- share_id: share_id
- tenant_id: tenant_id_path
Request example
---------------
@ -397,7 +401,7 @@ Request example
Unmanage share (since API v2.7)
===============================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. versionadded:: 2.7
@ -439,9 +443,9 @@ Request
.. rest_parameters:: parameters.yaml
- unmanage: share_unmanage
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- unmanage: share_unmanage
Request example
---------------
@ -458,7 +462,7 @@ There is no body content for the response.
Revert share to snapshot (since API v2.27)
==========================================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. versionadded:: 2.27
@ -485,9 +489,10 @@ Request
.. rest_parameters:: parameters.yaml
- snapshot_id: snapshot_id
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- snapshot_id: snapshot_id
Request example
---------------

8
api-ref/source/share-export-locations.inc

@ -15,7 +15,7 @@ locations of non-active share replicas can only be retrieved using the
List export locations
=====================
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}/export_locations
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/export_locations
.. versionadded:: 2.9
@ -40,8 +40,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
Response parameters
-------------------
@ -64,7 +64,7 @@ Response example
Show single export location
===========================
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}/export_locations/​{export_location_id}​
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/export_locations/​{export_location_id}​
.. versionadded:: 2.9
@ -89,8 +89,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- export_location_id: export_location_id_path
Response parameters

34
api-ref/source/share-group-snapshots.inc

@ -25,7 +25,7 @@ roles.
List share group snapshots
==========================
.. rest_method:: GET /v2/{tenant_id}/share-group-snapshots
.. rest_method:: GET /v2/{project_id}/share-group-snapshots
.. versionadded:: 2.31
@ -48,8 +48,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id
- project_id: project_id_path
- all_tenants: all_tenants
- name: group_snapshot_name_query
- description: group_snapshot_description_query
@ -79,7 +78,7 @@ Response example
List share group snapshots with details
=======================================
.. rest_method:: GET /v2/{tenant_id}/share-group-snapshots/detail
.. rest_method:: GET /v2/{project_id}/share-group-snapshots/detail
.. versionadded:: 2.31
@ -102,8 +101,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id
- project_id: project_id_path
- all_tenants: all_tenants
- name: group_snapshot_name_query
- description: group_snapshot_description_query
@ -139,7 +137,7 @@ Response example
List share group snapshots members
==================================
.. rest_method:: GET /v2/{tenant_id}/share-group-snapshots/{group_snapshot_id}/members
.. rest_method:: GET /v2/{project_id}/share-group-snapshots/{group_snapshot_id}/members
.. versionadded:: 2.31
@ -162,7 +160,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
Response parameters
@ -190,7 +188,7 @@ Response example
Show share group snapshot details
=================================
.. rest_method:: GET /v2/{tenant_id}/share-group-snapshots/{group_snapshot_id}
.. rest_method:: GET /v2/{project_id}/share-group-snapshots/{group_snapshot_id}
.. versionadded:: 2.31
@ -214,7 +212,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
Response parameters
@ -242,7 +240,7 @@ Response example
Create share group snapshot
===========================
.. rest_method:: POST /v2/{tenant_id}/share-group-snapshots
.. rest_method:: POST /v2/{project_id}/share-group-snapshots
.. versionadded:: 2.31
@ -268,7 +266,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- name: group_snapshot_name_option
- description: group_snapshot_description_option
- share_group_id: share_group_id
@ -304,7 +302,7 @@ Response example
Reset share group snapshot state
================================
.. rest_method:: POST /v2/{tenant_id}/share-group-snapshots/{group_snapshot_id}/action
.. rest_method:: POST /v2/{project_id}/share-group-snapshots/{group_snapshot_id}/action
.. versionadded:: 2.31
@ -332,7 +330,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
- status: group_snapshot_status_required
@ -346,7 +344,7 @@ Request example
Update share group snapshot
===========================
.. rest_method:: PUT /v2/{tenant_id}/share-group-snapshots/{group_snapshot_id}
.. rest_method:: PUT /v2/{project_id}/share-group-snapshots/{group_snapshot_id}
.. versionadded:: 2.31
@ -372,7 +370,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
- name: group_snapshot_name_option
- description: group_snapshot_description_option
@ -408,7 +406,7 @@ Response example
Delete share group snapshot
===========================
.. rest_method:: DELETE /v2/{tenant_id}/share-group-snapshots/{group_snapshot_id}
.. rest_method:: DELETE /v2/{project_id}/share-group-snapshots/{group_snapshot_id}
.. versionadded:: 2.31
@ -433,5 +431,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path

49
api-ref/source/share-group-types.inc

@ -37,7 +37,7 @@ share group type for the following purposes:
List share group types
======================
.. rest_method:: GET /v2/{tenant_id}/share-group-types
.. rest_method:: GET /v2/{project_id}/share-group-types
.. versionadded:: 2.31
@ -55,7 +55,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
Response parameters
-------------------
@ -79,7 +79,7 @@ Response example
List default share group types
==============================
.. rest_method:: GET /v2/{tenant_id}/share-group-types/default
.. rest_method:: GET /v2/{project_id}/share-group-types/default
.. versionadded:: 2.31
@ -104,7 +104,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
Response parameters
-------------------
@ -128,7 +128,7 @@ Response example
List share group types extra specs
==================================
.. rest_method:: GET /v2/{tenant_id}/share-group-types/{share_group_type_id}/group_specs
.. rest_method:: GET /v2/{project_id}/share-group-types/{share_group_type_id}/group_specs
.. versionadded:: 2.31
@ -153,7 +153,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_group_type_id: share_group_type_id_required
Response parameters
@ -173,7 +173,7 @@ Response example
Create share group type
=======================
.. rest_method:: POST /v2/{tenant_id}/share-group-types
.. rest_method:: POST /v2/{project_id}/share-group-types
.. versionadded:: 2.31
@ -199,7 +199,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_types: share_types_1
- name: share_group_type_name
- group_specs: group_specs
@ -233,7 +233,7 @@ Response example
Show share group type access details
====================================
.. rest_method:: GET /v2/{tenant_id}/share-group-types/{share_group_type_id}/share_type_access
.. rest_method:: GET /v2/{project_id}/share-group-types/{share_group_type_id}/share_type_access
.. versionadded:: 2.31
@ -260,7 +260,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_group_type_id: share_group_type_id_required
Response parameters
@ -269,7 +269,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- share_group_type_id: share_group_type_id_required
- project_id: project_id_9
- project_id: project_id_type_access
Response example
----------------
@ -281,7 +281,7 @@ Response example
Set extra spec for share group type
===================================
.. rest_method:: POST /v2/{tenant_id}/share-group-types/{share_group_type_id}/group_specs
.. rest_method:: POST /v2/{project_id}/share-group-types/{share_group_type_id}/group_specs
.. versionadded:: 2.31
@ -307,7 +307,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_group_type_id: share_group_type_id_required
- group_specs: group_specs_required
@ -334,7 +334,7 @@ Response example
Unset an group spec
===================
.. rest_method:: DELETE /v2/{tenant_id}/share-group-types/{share_group_type_id}/group-specs/{group_spec_key}
.. rest_method:: DELETE /v2/{project_id}/share-group-types/{share_group_type_id}/group-specs/{group_spec_key}
.. versionadded:: 2.31
@ -359,7 +359,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_group_type_id: share_group_type_id_required
- group_spec_key: group_spec_key
@ -367,7 +367,7 @@ Request
Add share group type access
===========================
.. rest_method:: POST /v2/{tenant_id}/share-group-types/{share_group_type_id}/action
.. rest_method:: POST /v2/{project_id}/share-group-types/{share_group_type_id}/action
.. versionadded:: 2.31
@ -395,9 +395,10 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_group_type_id: share_group_type_id_path
- project: project
- addProjectAccess: add_project_access
- project: project_id_type_access_grant_request
Request example
---------------
@ -409,7 +410,7 @@ Request example
Remove share group type access
==============================
.. rest_method:: POST /v2/{tenant_id}/share-group-types/{share_group_type_id}/action
.. rest_method:: POST /v2/{project_id}/share-group-types/{share_group_type_id}/action
.. versionadded:: 2.31
@ -436,9 +437,11 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_group_type_id: share_group_type_id_path
- project: project
- removeProjectAccess: remove_project_access
- project: project_id_type_access_revoke_request
Request example
---------------
@ -450,7 +453,7 @@ Request example
Delete share group type
=======================
.. rest_method:: DELETE /v2/{tenant_id}/share-group-types/{share_group_type_id}
.. rest_method:: DELETE /v2/{project_id}/share-group-types/{share_group_type_id}
.. versionadded:: 2.31
@ -475,5 +478,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_group_type_id: share_group_type_id_path

31
api-ref/source/share-groups.inc

@ -26,7 +26,7 @@ share groups, and show information for delete a share group.
List share groups
=================
.. rest_method:: GET /v2/{tenant_id}/share_groups
.. rest_method:: GET /v2/{project_id}/share_groups
.. versionadded:: 2.31
@ -50,8 +50,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- project_id: project_id
- project_id: project_id_path
- all_tenants: all_tenants
- name: name_query
- description: description_query
@ -89,7 +88,7 @@ Response example
Show share group details
========================
.. rest_method:: GET /v2/{tenant_id}/share_groups/{share_group_id}
.. rest_method:: GET /v2/{project_id}/share_groups/{share_group_id}
.. versionadded:: 2.31
@ -115,8 +114,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_group_id: share_group_id_path
- tenant_id: tenant_id
Response parameters
-------------------
@ -148,7 +147,7 @@ Response example
Create share group
==================
.. rest_method:: POST /v2/{tenant_id}/share_groups
.. rest_method:: POST /v2/{project_id}/share_groups
.. versionadded:: 2.31
@ -175,7 +174,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- name: share_group_name
- description: share_group_description
- share_types: share_types
@ -220,7 +219,7 @@ Response example
Reset share group state
=======================
.. rest_method:: POST /v2/{tenant_id}/share-groups/{share_group_id}/action
.. rest_method:: POST /v2/{project_id}/share-groups/{share_group_id}/action
.. versionadded:: 2.31
@ -248,10 +247,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_group_id: share_group_id_path
- reset_status: reset_status
- status: share_group_status
- share_group_id: share_group_id_path
- tenant_id: tenant_id_path
Request example
---------------
@ -263,7 +263,7 @@ Request example
Update share group
==================
.. rest_method:: PUT /v2/{tenant_id}/share-groups/{share_group_id}
.. rest_method:: PUT /v2/{project_id}/share-groups/{share_group_id}
.. versionadded:: 2.31
@ -289,10 +289,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_group_id: share_group_id_path
- display_name: share_group_name
- display_description: share_group_description
- share_group_id: share_group_id_path
- tenant_id: tenant_id_path
Request example
---------------
@ -330,7 +331,7 @@ Response example
Delete share group
==================
.. rest_method:: DELETE /v2/{tenant_id}/share-groups/{share_group_id}
.. rest_method:: DELETE /v2/{project_id}/share-groups/{share_group_id}
.. versionadded:: 2.31
@ -356,6 +357,6 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_group_id: share_group_id_path
- tenant_id: tenant_id_path
- force: share_force_delete

8
api-ref/source/share-instance-export-locations.inc

@ -17,7 +17,7 @@ Show details of an export location belonging to a share instance.
List export locations
=====================
.. rest_method:: GET /v2/{tenant_id}/share_instances/{share_instance_id}/export_locations
.. rest_method:: GET /v2/{project_id}/share_instances/{share_instance_id}/export_locations
.. versionadded:: 2.9
@ -40,7 +40,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_instance_id: share_instance_id
Response parameters
@ -64,7 +64,7 @@ Response example
Show single export location
===========================
.. rest_method:: GET /v2/{tenant_id}/share_instances/{share_instance_id}/export_locations/{export_location_id}
.. rest_method:: GET /v2/{project_id}/share_instances/{share_instance_id}/export_locations/{export_location_id}
.. versionadded:: 2.9
@ -87,7 +87,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_instance_id: share_instance_id
- export_location_id: export_location_id_path

16
api-ref/source/share-instances.inc

@ -12,7 +12,7 @@ file to grant permissions for these actions to other roles.
List share instances
====================
.. rest_method:: GET /v2/{tenant_id}/share_instances
.. rest_method:: GET /v2/{project_id}/share_instances
.. versionadded:: 2.3
@ -36,7 +36,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- export_location_id: export_location_id_query
- export_location_path: export_location_path_query
@ -69,7 +69,7 @@ Response example
Show share instance details
===========================
.. rest_method:: GET /v2/{tenant_id}/share_instances/{share_instance_id}
.. rest_method:: GET /v2/{project_id}/share_instances/{share_instance_id}
.. versionadded:: 2.3
@ -94,7 +94,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_instance_id: share_instance_id
Response parameters
@ -126,7 +126,7 @@ Response example
Reset share instance state
==========================
.. rest_method:: POST /v2/{tenant_id}/share_instances/{share_instance_id}/action
.. rest_method:: POST /v2/{project_id}/share_instances/{share_instance_id}/action
.. versionadded:: 2.3
@ -154,7 +154,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_instance_id: share_instance_id
- status: status_5
@ -168,7 +168,7 @@ Request example
Force-delete share instance
===========================
.. rest_method:: POST /v2/{tenant_id}/share_instances/{share_instance_id}/action
.. rest_method:: POST /v2/{project_id}/share_instances/{share_instance_id}/action
.. versionadded:: 2.3
@ -196,7 +196,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_instance_id: share_instance_id
- force_delete: force_delete_2

22
api-ref/source/share-metadata.inc

@ -10,7 +10,7 @@ Shows, sets, updates, and unsets share metadata.
Show share metadata
===================
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}/metadata
.. rest_method:: GET /v2/{project_id}/shares/{share_id}/metadata
Shows the metadata for a share.
@ -33,8 +33,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
Response parameters
-------------------
@ -53,7 +53,7 @@ Response example
Set share metadata
==================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/metadata
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/metadata
Sets the metadata on a share.
@ -77,9 +77,10 @@ Request
.. rest_parameters:: parameters.yaml
- metadata: metadata_2
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- metadata: metadata_2
Request example
---------------
@ -104,7 +105,7 @@ Response example
Update share metadata
=====================
.. rest_method:: PUT /v2/{tenant_id}/shares/{share_id}/metadata
.. rest_method:: PUT /v2/{project_id}/shares/{share_id}/metadata
Updates the metadata for a share.
@ -127,9 +128,10 @@ Request
.. rest_parameters:: parameters.yaml
- metadata: metadata_2
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- metadata: metadata_2
Request example
---------------
@ -154,7 +156,7 @@ Response example
Unset share metadata
====================
.. rest_method:: DELETE /v2/{tenant_id}/shares/{share_id}/metadata/{key}
.. rest_method:: DELETE /v2/{project_id}/shares/{share_id}/metadata/{key}
Un-sets the metadata on a share.
@ -180,6 +182,6 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
- key: metadata_key_request

12
api-ref/source/share-migration.inc

@ -29,7 +29,7 @@ Migrate share (DEPRECATED)
this API will fail with a 404 starting from microversion 2.15. Please see
the new experimental API below.
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. versionadded:: 2.5
@ -61,7 +61,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: share_id
- os-migrate_share: os-migrate_share
- migrate_share: migrate_share
@ -72,7 +72,7 @@ Request
Start Migration (since API v2.15)
=================================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. versionadded:: 2.15
@ -99,7 +99,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: share_id
- migrate-start: migrate-start
- host: host_10
@ -110,7 +110,7 @@ Request
Complete Migration (since API v2.15)
=======================================
.. rest_method:: POST /v2/{tenant_id}/shares/{share_id}/action
.. rest_method:: POST /v2/{project_id}/shares/{share_id}/action
.. versionadded:: 2.15
@ -137,7 +137,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: share_id
- migration_complete: migration_complete
- host: host_10

32
api-ref/source/share-networks.inc

@ -39,7 +39,7 @@ A share network has these attributes:
List share networks
===================
.. rest_method:: GET /v2/{tenant_id}/share-networks
.. rest_method:: GET /v2/{project_id}/share-networks
Lists all share networks.
@ -62,7 +62,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
- name~: name_inexact_query
- description~: description_inexact_query
@ -85,7 +85,7 @@ Response example
List share networks with details
================================
.. rest_method:: GET /v2/{tenant_id}/share-networks/detail
.. rest_method:: GET /v2/{project_id}/share-networks/detail
Lists all share networks with details.
@ -108,7 +108,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
- name~: name_inexact_query
- description~: description_inexact_query
@ -143,7 +143,7 @@ Response example
Show share network details
==========================
.. rest_method:: GET /v2/{tenant_id}/share-networks/{share_network_id}
.. rest_method:: GET /v2/{project_id}/share-networks/{share_network_id}
Shows details for a share network.
@ -166,7 +166,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_network_id: share_network_id_path
Response parameters
@ -199,7 +199,7 @@ Response example
Create share network
====================
.. rest_method:: POST /v2/{tenant_id}/share-networks
.. rest_method:: POST /v2/{project_id}/share-networks
Creates a share network.
@ -224,7 +224,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- neutron_net_id: neutron_net_id_request
- neutron_subnet_id: neutron_subnet_id_request
- name: share_network_name_request
@ -266,7 +266,7 @@ Response example
Add security service to share network
=====================================
.. rest_method:: POST /v2/{tenant_id}/share-networks/{share_network_id}/action
.. rest_method:: POST /v2/{project_id}/share-networks/{share_network_id}/action
Adds a security service to a share network.
@ -290,7 +290,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- project_id: project_id
- share_network_id: share_network_id_path
- security_service_id: security_service_id
@ -331,7 +331,7 @@ Response example
Remove security service from share network
==========================================
.. rest_method:: POST /v2/{tenant_id}/share-networks/{share_network_id}/action
.. rest_method:: POST /v2/{project_id}/share-networks/{share_network_id}/action
Removes a security service from a share network.
@ -356,7 +356,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_network_id: share_network_id_path
- security_service_id: share_network_security_service_id
@ -396,7 +396,7 @@ Response example
Update share network
====================
.. rest_method:: PUT /v2/{tenant_id}/share-networks/{share_network_id}
.. rest_method:: PUT /v2/{project_id}/share-networks/{share_network_id}
Updates a share network.
@ -423,7 +423,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_network_id: share_network_id_path
- name: share_network_name_request
- description: share_network_description_request
@ -466,7 +466,7 @@ Response example
Delete share network
====================
.. rest_method:: DELETE /v2/{tenant_id}/share-networks/{share_network_id}
.. rest_method:: DELETE /v2/{project_id}/share-networks/{share_network_id}
Deletes a share network.
@ -496,5 +496,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_network_id: share_network_id_path

8
api-ref/source/share-replica-export-locations.inc

@ -11,7 +11,7 @@ Set of APIs used to view export locations of share replicas.
List export locations
=====================
.. rest_method:: GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations
.. rest_method:: GET /v2/{project_id}/share-replicas/{share_replica_id}/export-locations
.. versionadded:: 2.47
@ -34,7 +34,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_replica_id: share_replica_id_path
Response parameters
@ -60,7 +60,7 @@ Response example
Show single export location
===========================
.. rest_method:: GET /v2/{tenant_id}/share-replicas/{share_replica_id}/export-locations/{export-location-id}
.. rest_method:: GET /v2/{project_id}/share-replicas/{share_replica_id}/export-locations/{export-location-id}
.. versionadded:: 2.47
@ -84,7 +84,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_replica_id: share_replica_id_path
- export_location_id: export_location_id_path

48
api-ref/source/share-replicas.inc

@ -55,7 +55,7 @@ one of these supported replication types:
Create share replica
====================
.. rest_method:: POST /v2/{tenant_id}/share-replicas
.. rest_method:: POST /v2/{project_id}/share-replicas
.. versionadded:: 2.11
@ -80,7 +80,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: share_replica_share_id
- availability_zone: share_replica_az
- share_network_id: share_replica_share_network_id
@ -118,7 +118,7 @@ Response example
Promote share replica
=====================
.. rest_method:: POST /v2/{tenant_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -143,14 +143,14 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_replica_id: share_replica_id_path
Resync share replica
====================
.. rest_method:: POST /v2/{tenant_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -175,14 +175,14 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_replica_id: share_replica_id_path
List share replicas
===================
.. rest_method:: GET /v2/{tenant_id}/share-replicas?share_id={share_id}
.. rest_method:: GET /v2/{project_id}/share-replicas?share_id={share_id}
.. versionadded:: 2.11
@ -207,8 +207,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
Response parameters
-------------------
@ -230,7 +230,7 @@ Response example
List share replicas with details
================================
.. rest_method:: GET /v2/{tenant_id}/share-replicas/detail?share_id={share_id}
.. rest_method:: GET /v2/{project_id}/share-replicas/detail?share_id={share_id}
.. versionadded:: 2.11
@ -255,8 +255,8 @@ Request
.. rest_parameters:: parameters.yaml
- share_id: share_id
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: share_id_replicas_query
Response parameters
-------------------
@ -284,7 +284,7 @@ Response example
Show share replica
==================
.. rest_method:: GET /v2/{tenant_id}/share-replicas/{share_replica_id}
.. rest_method:: GET /v2/{project_id}/share-replicas/{share_replica_id}
.. versionadded:: 2.11
@ -309,8 +309,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_replica_id: share_replica_id_path
- tenant_id: tenant_id_path
Response parameters
@ -339,7 +339,7 @@ Response example
Reset status of the share replica
=================================
.. rest_method:: POST /v2/{tenant_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -367,10 +367,10 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_replica_id: share_replica_id_path
- reset_status: reset_status
- status: share_replica_status
- share_replica_id: share_replica_id_path
- tenant_id: tenant_id_path
Request example
---------------
@ -382,7 +382,7 @@ Request example
Reset replica_state of the share replica
========================================
.. rest_method:: POST /v2/{tenant_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -410,10 +410,10 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_replica_id: share_replica_id_path
- reset_replica_state: share_replica_reset_replica_state
- replica_state: share_replica_replica_state
- share_replica_id: share_replica_id_path
- tenant_id: tenant_id_path
Request example
---------------
@ -425,7 +425,7 @@ Request example
Delete share replica
====================
.. rest_method:: DELETE /v2/{tenant_id}/share-replicas/{share_replica_id}
.. rest_method:: DELETE /v2/{project_id}/share-replicas/{share_replica_id}
.. versionadded:: 2.11
@ -455,14 +455,14 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_replica_id: share_replica_id_path
- tenant_id: tenant_id_path
Force-delete share replica
==========================
.. rest_method:: POST /v2/{tenant_id}/share-replicas/{share_replica_id}/action
.. rest_method:: POST /v2/{project_id}/share-replicas/{share_replica_id}/action
.. versionadded:: 2.11
@ -494,9 +494,9 @@ Request
.. rest_parameters:: parameters.yaml
- force_delete: share_replica_force_delete
- project_id: project_id_path
- share_replica_id: share_replica_id_path
- tenant_id: tenant_id_path
- force_delete: share_replica_force_delete
Request example
---------------

26
api-ref/source/share-servers.inc

@ -43,7 +43,7 @@ The possible share servers statuses are:
List share servers
==================
.. rest_method:: GET /v2/{tenant_id}/share-servers
.. rest_method:: GET /v2/{project_id}/share-servers
Lists all share servers.
@ -65,7 +65,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
Response parameters
-------------------
@ -73,7 +73,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: share_server_id
- project_id: project_id_share_server_body
- project_id: project_id
- status: status_share_server_body
- share_network_id: share_network_id
- share_network_name: share_network_name
@ -90,7 +90,7 @@ Response example
Show share server
=================
.. rest_method:: GET /v2/{tenant_id}/share-servers/{share_server_id}
.. rest_method:: GET /v2/{project_id}/share-servers/{share_server_id}
Show a share server's details.
@ -113,7 +113,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_server_id: share_server_id
Response parameters
@ -122,7 +122,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: share_server_id
- project_id: project_id_share_server_body
- project_id: project_id
- status: status_share_server_body
- backend_details: backend_details
- share_network_id: share_network_id_share_server_body
@ -143,7 +143,7 @@ Response example
Show share server back end details
==================================
.. rest_method:: GET /v2/{tenant_id}/share-servers/{share_server_id}/details
.. rest_method:: GET /v2/{project_id}/share-servers/{share_server_id}/details
Shows back end details of a share server.
@ -166,7 +166,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_server_id: share_server_id
Response parameters
@ -186,7 +186,7 @@ Response example
Delete share server
===================
.. rest_method:: DELETE /v2/{tenant_id}/share-servers/{share_server_id}
.. rest_method:: DELETE /v2/{project_id}/share-servers/{share_server_id}
Deletes a share server.
@ -213,7 +213,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_server_id: share_server_id
@ -265,7 +265,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: share_server_id
- project_id: project_id_share_server_manage
- project_id: project_id
- updated_at: share_server_updated_at
- status: share_server_status
- host: manage_host
@ -318,7 +318,7 @@ Request parameters
.. rest_parameters:: parameters.yaml
- project_id: project_id
- project_id: project_id_path
- share_server_id: share_server_id
- force: force
- unmanage: share_server_unmanage
@ -366,8 +366,8 @@ Request parameters
.. rest_parameters:: parameters.yaml
- share_server_id: share_server_id
- project_id: project_id_path
- share_server_id: share_server_id
- status: share_server_status
Request example

54
api-ref/source/share-types.inc

@ -88,7 +88,7 @@ other roles.
List share types
================
.. rest_method:: GET /v2/{tenant_id}/types
.. rest_method:: GET /v2/{project_id}/types
Lists all share types.
@ -104,7 +104,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- extra_specs: extra_specs_query
Response parameters
@ -136,7 +136,7 @@ Response example
List default share types
========================
.. rest_method:: GET /v2/{tenant_id}/types/default
.. rest_method:: GET /v2/{project_id}/types/default
Lists default share types.
@ -159,7 +159,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
Response parameters
-------------------
@ -186,7 +186,7 @@ Response example
Show share type detail
======================
.. rest_method:: GET /v2/{tenant_id}/types/{share_type_id}
.. rest_method:: GET /v2/{project_id}/types/{share_type_id}
Shows details for a specified share type.
@ -209,7 +209,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- project_id: project_id_path
- share_type_id: share_type_id
Response Parameters
@ -241,7 +241,7 @@ Response Example
List extra specs
================
.. rest_method:: GET /v2/{tenant_id}/types/{share_type_id}/extra_specs
.. rest_method:: GET /v2/{project_id}/types/{share_type_id}/extra_specs
Lists the extra specifications for a share type.
@ -264,7 +264,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_type_id: share_type_id
Response parameters
@ -290,7 +290,7 @@ Response example
Create share type
=================
.. rest_method:: POST /v2/{tenant_id}/types
.. rest_method:: POST /v2/{project_id}/types
Creates a share type.
@ -315,7 +315,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1
@ -363,7 +363,7 @@ Response example
Show share type access details
==============================
.. rest_method:: GET /v2/{tenant_id}/types/{share_type_id}/share_type_access
.. rest_method:: GET /v2/{project_id}/types/{share_type_id}/share_type_access
Shows access details for a share type.
@ -388,7 +388,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_type_id: share_type_id
Response parameters
@ -396,7 +396,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- project_id: project_id_9
- project_id: project_id_type_access
- share_type_id: share_type_id_body
Response example
@ -409,7 +409,7 @@ Response example
Set extra spec for share type
=============================
.. rest_method:: POST /v2/{tenant_id}/types/{share_type_id}/extra_specs
.. rest_method:: POST /v2/{project_id}/types/{share_type_id}/extra_specs
Sets an extra specification for the share type.
@ -438,7 +438,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_type_id: share_type_id
- extra_specs: extra_specs
@ -465,7 +465,7 @@ Response example
Unset an extra spec
===================
.. rest_method:: DELETE /v2/{tenant_id}/types/{share_type_id}/extra_specs/{extra-spec-key}
.. rest_method:: DELETE /v2/{project_id}/types/{share_type_id}/extra_specs/{extra-spec-key}
Unsets an extra specification for the share type.
@ -488,15 +488,15 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_type_id: share_type_id
- extra-spec-key: extra-spec-key-path
- extra-spec-key: extra_spec_key_path
Add share type access
=====================
.. rest_method:: POST /v2/{tenant_id}/types/{share_type_id}/action
.. rest_method:: POST /v2/{project_id}/types/{share_type_id}/action
Adds share type access for a project.
@ -522,9 +522,10 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_type_id: share_type_id
- project: project
- addProjectAccess: add_project_access
- project: project_id_type_access_grant_request
Request example
---------------
@ -536,7 +537,7 @@ Request example
Remove share type access
========================
.. rest_method:: POST /v2/{tenant_id}/types/{share_type_id}/action
.. rest_method:: POST /v2/{project_id}/types/{share_type_id}/action
Removes share type access from a project.
@ -561,9 +562,10 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_type_id: share_type_id
- project: project
- removeProjectAccess: remove_project_access
- project: project_id_type_access_revoke_request
Request example
---------------
@ -575,7 +577,7 @@ Request example
Delete share type
=================
.. rest_method:: DELETE /v2/{tenant_id}/types/{share_type_id}
.. rest_method:: DELETE /v2/{project_id}/types/{share_type_id}
Deletes a share type.
@ -598,5 +600,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_type_id: share_type_id

44
api-ref/source/shares.inc

@ -85,7 +85,7 @@ A share has one of these status values:
List shares
===========
.. rest_method:: GET /v2/{tenant_id}/shares
.. rest_method:: GET /v2/{project_id}/shares
Lists all shares.
@ -107,7 +107,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
- name: name_5
- status: status_6
@ -122,7 +122,7 @@ Request
- snapshot_id: snapshot_id_query
- host: host_1
- share_network_id: share_network_id
- project_id: project_id_6
- project_id: project_id
- is_public: is_public
- share_group_id: share_group_id_query
- export_location_id: export_location_id_query
@ -151,7 +151,7 @@ Response example
List shares with details
========================
.. rest_method:: GET /v2/{tenant_id}/shares/detail
.. rest_method:: GET /v2/{project_id}/shares/detail
Lists all shares, with details.
@ -175,7 +175,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
- name: name_5
- status: status_6
@ -190,8 +190,8 @@ Request
- snapshot_id: snapshot_id_query
- host: host_1
- share_network_id: share_network_id
- project_id: project_id_6
- is_public: is_public
- project_id: project_id_query
- is_public: is_public_query
- share_group_id: share_group_id_query
- export_location_id: export_location_id_query
- export_location_path: export_location_path_query
@ -215,7 +215,7 @@ Response parameters
- size: size_2
- share_type: share_type_1
- export_location: export_location
- project_id: project_id_4
- project_id: project_id
- metadata: metadata
- status: status_16
- description: description_5
@ -243,7 +243,7 @@ Response example
Show share details
==================
.. rest_method:: GET /v2/{tenant_id}/shares/{share_id}
.. rest_method:: GET /v2/{project_id}/shares/{share_id}
Shows details for a share.
@ -267,8 +267,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path
Response parameters
-------------------
@ -286,7 +286,7 @@ Response parameters
- size: size_2
- share_type: share_type_1
- export_location: export_location
- project_id: project_id_4
- project_id: project_id
- metadata: metadata
- status: status_16
- description: description_5
@ -313,7 +313,7 @@ Response example
Create share
============
.. rest_method:: POST /v2/{tenant_id}/shares
.. rest_method:: POST /v2/{project_id}/shares
Creates a share.
@ -338,7 +338,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_proto: share_proto
- size: size
- name: name_5
@ -404,7 +404,7 @@ Response example
Manage share (since API v2.7)
=============================
.. rest_method:: POST /v2/{tenant_id}/shares/manage
.. rest_method:: GET /v2/{project_id}/shares/manage
.. versionadded:: 2.7
@ -441,7 +441,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share: share
- protocol: protocol
- name: name_5
@ -478,7 +478,7 @@ Response parameters
- has_replicas: has_replicas
- replication_type: replication_type
- export_location: export_location
- project_id: project_id_4
- project_id: project_id
- metadata: metadata
- status: status_8
- share_server_id: manage_share_server_id
@ -502,7 +502,7 @@ Response example
Update share
============
.. rest_method:: PUT /v2/{tenant_id}/shares/{share_id}
.. rest_method:: PUT /v2/{project_id}/shares/{share_id}
Updates a share.
@ -538,11 +538,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- is_public: is_public
- display_name: display_name_3
- display_description: display_description_3
- share_id: share_id
- tenant_id: tenant_id_path
Request example
---------------
@ -566,7 +566,7 @@ Response parameters
- size: size_2
- share_type: share_type_1
- export_location: export_location
- project_id: project_id_4
- project_id: project_id
- metadata: metadata
- status: status_16
- description: description_5
@ -593,7 +593,7 @@ Response example
Delete share
============
.. rest_method:: DELETE /v2/{tenant_id}/shares/{share_id}
.. rest_method:: DELETE /v2/{project_id}/shares/{share_id}
Deletes a share.
@ -627,5 +627,5 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- share_id: share_id
- tenant_id: tenant_id_path

16
api-ref/source/snapshot-instances.inc

@ -19,7 +19,7 @@ to grant permissions for these actions to other roles.
List share snapshot instances
=============================
.. rest_method:: GET /v2/{tenant_id}/snapshot-instances
.. rest_method:: GET /v2/{project_id}/snapshot-instances
.. versionadded:: 2.19
@ -43,7 +43,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_query
Response parameters
@ -65,7 +65,7 @@ Response example
List share snapshot instances with details
==========================================
.. rest_method:: GET /v2/{tenant_id}/snapshot-instances/detail
.. rest_method:: GET /v2/{project_id}/snapshot-instances/detail
.. versionadded:: 2.19
@ -89,7 +89,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_query
Response parameters
@ -117,7 +117,7 @@ Response example
Show share snapshot instance details
====================================
.. rest_method:: GET /v2/{tenant_id}/snapshot-instances/{snapshot_instance_id}
.. rest_method:: GET /v2/{project_id}/snapshot-instances/{snapshot_instance_id}
.. versionadded:: 2.19
@ -142,7 +142,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_instance_id: snapshot_instance_id_path
Response parameters
@ -170,7 +170,7 @@ Response example
Reset share snapshot instance state
===================================
.. rest_method:: POST /v2/{tenant_id}/snapshot-instances/{snapshot_instance_id}/action
.. rest_method:: POST /v2/{project_id}/snapshot-instances/{snapshot_instance_id}/action
.. versionadded:: 2.19
@ -198,7 +198,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_instance_id: snapshot_instance_id_path
- status: snapshot_instance_status

40
api-ref/source/snapshots.inc

@ -42,7 +42,7 @@ file to grant permissions for these actions to other roles.
List share snapshots
====================
.. rest_method:: GET /v2/{tenant_id}/snapshots
.. rest_method:: GET /v2/{project_id}/snapshots
Lists all share snapshots.
@ -63,7 +63,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
- name~: name_inexact_query
- description~: description_inexact_query
@ -86,7 +86,7 @@ Response example
List share snapshots with details
=================================
.. rest_method:: GET /v2/{tenant_id}/snapshots/detail
.. rest_method:: GET /v2/{project_id}/snapshots/detail
Lists all share snapshots with details.
@ -107,7 +107,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- all_tenants: all_tenants
- name~: name_inexact_query
- description~: description_inexact_query
@ -139,7 +139,7 @@ Response example
Show share snapshot details
===========================
.. rest_method:: GET /v2/{tenant_id}/snapshots/{snapshot_id}
.. rest_method:: GET /v2/{project_id}/snapshots/{snapshot_id}
Shows details for a share snapshot.
@ -161,7 +161,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_path
Response parameters
@ -191,7 +191,7 @@ Response example
Create share snapshot
=====================
.. rest_method:: POST /v2/{tenant_id}/snapshots
.. rest_method:: POST /v2/{project_id}/snapshots
Creates a snapshot from a share.
@ -216,7 +216,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: snapshot_share_id_request
- force: force_snapshot_request
- name: snapshot_name_request
@ -258,7 +258,7 @@ Response example
Manage share snapshot (since API v2.12)
=======================================
.. rest_method:: POST /v2/{tenant_id}/snapshots/manage
.. rest_method:: POST /v2/{project_id}/snapshots/manage
.. versionadded:: 2.12
@ -290,7 +290,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- share_id: snapshot_manage_share_id
- provider_location: snapshot_provider_location_request
- name: snapshot_name_request
@ -333,7 +333,7 @@ Response example
Unmanage share snapshot (since API v2.12)
=========================================
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/action
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
.. versionadded:: 2.12
@ -365,7 +365,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_path
- unmanage: snapshot_unmanage
@ -383,7 +383,7 @@ There is no body content for the response.
Reset share snapshot state
==========================
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/action
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
Administrator only. Explicitly updates the state of a share snapshot.
@ -409,7 +409,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_path
- status: snapshot_status_request
@ -423,7 +423,7 @@ Request example
Force-delete share snapshot
===========================
.. rest_method:: POST /v2/{tenant_id}/snapshots/{snapshot_id}/action
.. rest_method:: POST /v2/{project_id}/snapshots/{snapshot_id}/action
Administrator only. Force-deletes a share snapshot in any state.
@ -449,7 +449,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_path
- force_delete: snapshot_force_delete
@ -463,7 +463,7 @@ Request example
Update share snapshot
=====================
.. rest_method:: PUT /v2/{tenant_id}/snapshots/{snapshot_id}
.. rest_method:: PUT /v2/{project_id}/snapshots/{snapshot_id}
Updates a share snapshot.
@ -498,7 +498,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_path
- display_name: snapshot_display_name
- display_description: snapshot_display_description
@ -536,7 +536,7 @@ Response example
Delete share snapshot
=====================
.. rest_method:: DELETE /v2/{tenant_id}/snapshots/{snapshot_id}
.. rest_method:: DELETE /v2/{project_id}/snapshots/{snapshot_id}
Deletes a share snapshot.
@ -563,5 +563,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- snapshot_id: snapshot_id_path

12
api-ref/source/user-messages.inc

@ -20,7 +20,7 @@ creation request with different parameters.
List user messages
==================
.. rest_method:: GET /v2/{tenant_id}/messages
.. rest_method:: GET /v2/{project_id}/messages
.. versionadded:: 2.37
@ -45,7 +45,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- limit: limit
- offset: offset
- sort_key: sort_key_messages
@ -83,7 +83,7 @@ Response example
Show user message details
=========================
.. rest_method:: GET /v2/{tenant_id}/messages/{message_id}
.. rest_method:: GET /v2/{project_id}/messages/{message_id}
.. versionadded:: 2.37
@ -108,7 +108,7 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- message_id: message_id
Response parameters
@ -136,7 +136,7 @@ Response example
Delete message
==============
.. rest_method:: DELETE /v2/{tenant_id}/messages/{message_id}
.. rest_method:: DELETE /v2/{project_id}/messages/{message_id}
.. versionadded:: 2.37
@ -161,5 +161,5 @@ Request
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path
- project_id: project_id_path
- message_id: message_id