openstack/manila
Code Issues Proposed changes

[api-ref] De-duplicate name and description parameters

Browse Source 
Many resources in manila have user-defined
names and descriptions. All of them have the
same restrictions that apply, so represent them
as the fewest parameters needed.

Having common parameters is easier to maintain in
the documentation.

Change-Id: Ib175e8d78e4240bf40d87a47af2459ac520fb24a
Partial-Bug: #1760644
This commit is contained in:
Goutham Pacha Ravi 2019-03-28 17:48:10 -07:00
parent f185ff0f44
commit 5bf0337396
10 changed files with 184 additions and 417 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -20,7 +20,8 @@ Manage share (DEPRECATED)
.. 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.
Systems service. In the service, the share will be represented as a resource
in the database. It can have a user defined name and description.
Administrator only. Use the ``policy.json`` file to grant permissions for this
action to other roles.
@ -48,15 +49,15 @@ Request
- project_id: project_id_path
- share: share
- protocol: protocol
- name: name_5
- display_name: display_name
- name: name_request
- display_name: display_name_request
- share_type: share_type_2
- driver_options: driver_options
- export_path: export_path
- service_host: service_host
- is_public: is_public
- description: description_5
- display_description: display_description
- description: description_request
- display_description: display_description_request
Request example
---------------
@ -86,11 +87,11 @@ Response parameters
- project_id: project_id
- metadata: metadata
- status: status_8
- description: description_5
- description: description
- host: host_7
- is_public: is_public
- snapshot_support: snapshot_support
- name: name_5
- name: name
- created_at: created_at
- share_proto: share_proto
- volume_type: volume_type

327
api-ref/source/parameters.yaml
View File

@ -190,8 +190,7 @@ description_inexact_query:
min_version: 2.36
description_query:
description: |
The share group description that can be used to filter
share groups.
The user defined description text that can be used to filter resources.
in: query
required: false
type: string
@ -227,20 +226,6 @@ extra_specs_query:
required: false
type: string
min_version: 2.43
group_snapshot_description_query:
description: |
The share group snapshot description that can be used to filter
share group snapshots.
in: query
required: false
type: string
group_snapshot_name_query:
description: |
The share group snapshot name that can be used to filter
share group snapshots.
in: query
required: false
type: string
group_snapshot_status_query:
description: |
Filters by a share group snapshot status. A valid value is
@ -296,7 +281,7 @@ name_inexact_query:
min_version: 2.36
name_query:
description: |
The share group name that can be used to filter share groups.
The user defined name of the resource to filter resources by.
in: query
required: false
type: string
@ -923,48 +908,19 @@ deny_access:
in: body
required: true
type: object
description_10:
description:
description: |
The snapshot description.
in: body
required: false
type: string
description_11:
description: |
The snapshot description.
The user defined description of the resource.
in: body
required: true
type: string
description_3:
description_request:
description: |
The security service description.
The user defined description of the resource. The value of this field is
limited to 255 characters.
in: body
required: false
type: string
description_4:
description: |
The share network description.
in: body
required: false
type: string
description_5:
description: |
The share description.
in: body
required: false
type: string
description_8:
description: |
The extension description.
in: body
required: true
type: string
description_9:
description: |
The security service description.
in: body
required: true
type: string
detail_id_body:
in: body
required: true
@ -977,56 +933,17 @@ disabled:
in: body
required: true
type: boolean
display_description:
display_description_request:
description: |
The share description. The Shared File Systems
API supports the use of both ``description`` and
``display_description`` parameters, which are inherited attributes
from the Block Storage API.
The user defined description of the resource. This field sets the
``description`` parameter.
in: body
required: false
type: string
display_description_2:
display_name_request:
description: |
The snapshot description. If you specify this
attribute, the snapshot ``description`` is updated.
in: body
required: false
type: string
display_description_3:
description: |
The share description. If you specify this
parameter, the share description is updated.
in: body
required: false
type: string
display_name:
description: |
The share name. The Shared File Systems API
supports the use of both ``name`` and ``display_name`` attributes,
which are inherited attributes from the Block Storage API.
in: body
required: false
type: string
display_name_2:
description: |
The snapshot name. The shared file systems API
supports the use of both ``name`` and ``display_name`` attributes,
which are inherited attributes from the Block Storage API.
in: body
required: false
type: string
display_name_3:
description: |
The snapshot name. If you specify this attribute,
the snapshot ``name`` is updated.
in: body
required: false
type: string
display_name_4:
description: |
The share name. If you specify this parameter,
the share name is updated.
The user defined name of the resource. This field sets the ``name``
parameter.
in: body
required: false
type: string
@ -1179,7 +1096,7 @@ extension_alias:
type: string
extension_description:
description: |
The extension description.
The description of the extension API.
in: body
required: true
type: string
@ -1250,18 +1167,6 @@ free_capacity_gb:
in: body
required: true
type: string
group_snapshot_description:
description: |
The share group snapshot description.
in: body
required: true
type: string
group_snapshot_description_option:
description: |
The share group snapshot description.
in: body
required: false
type: string
group_snapshot_id:
description: |
The share group snapshot ID.
@ -1280,18 +1185,6 @@ group_snapshot_members:
in: body
required: true
type: string
group_snapshot_name:
description: |
The share group snapshot name.
in: body
required: true
type: string
group_snapshot_name_option:
description: |
The share group snapshot name.
in: body
required: false
type: string
group_snapshot_status_required:
description: |
Filters by a share group snapshot status. A valid value is
@ -1705,60 +1598,14 @@ mount_snapshot_support:
min_version: 2.32
name:
description: |
The share network name.
The user defined name of the resource.
in: body
required: true
type: string
name_10:
name_request:
description: |
The name of the extension. For example, "Fox In
Socks."
in: body
required: true
type: string
name_11:
description: |
The name of the back end in this format:
``host@backend#POOL``. - ``host``. The host name for the back
end. - ``backend``. The name of the back end. - ``POOL``. The
pool name for the back end.
in: body
required: true
type: string
name_14:
description: |
The snapshot name.
in: body
required: false
type: string
name_15:
description: |
The snapshot name.
in: body
required: true
type: string
name_16:
description: |
The security service name. If you specify this
value, the name is updated.
in: body
required: false
type: string
name_3:
description: |
The security service name.
in: body
required: false
type: string
name_4:
description: |
The share network name.
in: body
required: false
type: string
name_5:
description: |
The share name.
The user defined name of the resource. The value of this field is
limited to 255 characters.
in: body
required: false
type: string
@ -2200,19 +2047,6 @@ revert_to_snapshot_support:
required: false
type: boolean
min_version: 2.27
security_service_description:
description: |
Description of the security service in plain text.
in: body
required: true
type: string
security_service_description_request:
description: |
The security service description. If you specify
this value, the description is updated.
in: body
required: false
type: string
security_service_dns_ip:
description: |
The DNS IP address that is used inside the project network.
@ -2243,12 +2077,6 @@ security_service_id:
in: body
required: true
type: string
security_service_name:
description: |
The security service name.
in: body
required: true
type: string
security_service_ou:
description: |
The security service ou.
@ -2482,18 +2310,6 @@ share_force_delete:
in: body
required: true
type: string
share_group_description:
description: |
The share group description.
in: body
required: false
type: string
share_group_description_response:
description: |
The share group description.
in: body
required: true
type: string
share_group_host:
description: |
The share group host name.
@ -2504,14 +2320,14 @@ share_group_id:
description: |
The UUID of the share group.
in: body
required: True
required: true
type: string
min_version: 2.31
share_group_id_request:
description: |
The UUID of the share group.
in: body
required: False
required: false
type: string
min_version: 2.31
share_group_links:
@ -2520,18 +2336,6 @@ share_group_links:
in: body
required: true
type: string
share_group_name:
description: |
The share group name.
in: body
required: false
type: string
share_group_name_response:
description: |
The share group name.
in: body
required: true
type: string
share_group_status:
description: |
The share group status, which is ``available``,
@ -2573,6 +2377,13 @@ share_group_type_name:
in: body
required: true
type: string
share_group_type_name_request:
description: |
The name of the share group type resource. The value of this field is
limited to 255 characters.
in: body
required: false
type: string
share_id_2:
description: |
The UUID of the share from which the share
@ -2594,18 +2405,6 @@ share_instance_id_1:
in: body
required: true
type: string
share_network_description:
description: |
The share network description.
in: body
required: true
type: string
share_network_description_request:
description: |
The share network description.
in: body
required: false
type: string
share_network_gateway:
description: |
The gateway of a share network.
@ -2664,16 +2463,11 @@ share_network_mtu:
min_version: 2.20
share_network_name:
description: |
The name of a share network.
The name of a share network that is associated
with the share server.
in: body
required: true
type: string
share_network_name_request:
description: |
The name of a share network.
in: body
required: false
type: string
share_network_security_service_id:
description: |
The UUID of the security service to remove from
@ -2810,6 +2604,13 @@ share_server_unmanage:
in: body
required: true
type: object
share_share_type_name:
description: |
Name of the share type.
in: body
required: true
type: string
min_version: 2.6
share_size_1:
description: |
The size of a source share, in GBs.
@ -2857,7 +2658,8 @@ share_type_description:
min_version: 2.41
share_type_description_request:
description: |
The description of the share type.
The description of the share type. The value of this field is limited to
255 characters.
in: body
required: false
type: string
@ -2870,13 +2672,17 @@ share_type_id_body:
type: string
share_type_name:
description: |
The share type name. Minor versions support only the
``share_type`` parameter where the share type name is
expected.
Name of the share type.
in: body
required: true
type: string
min_version: 2.6
share_type_name_request:
description: |
Name of the share type. The value of this field is limited to 255
characters.
in: body
required: false
type: string
share_types:
description: |
A list of one or more share type IDs.
@ -2921,35 +2727,6 @@ size_2:
in: body
required: true
type: integer
snapshot_description:
description: |
The snapshot description.
in: body
required: true
type: string
snapshot_description_request:
description: |
The snapshot description.
in: body
required: false
type: string
snapshot_display_description:
description: |
The snapshot description. The shared file
systems API supports the use of both ``name`` and ``display_name``
attributes, which are inherited attributes from the block storage
API.
in: body
required: false
type: string
snapshot_display_name:
description: |
The snapshot name. The Shared File Systems API
supports the use of both ``name`` and ``display_name`` attributes,
which are inherited attributes from the Block Storage API.
in: body
required: false
type: string
snapshot_force_delete:
description: |
To force-delete a snapshot, include this param and set its value to
@ -3013,18 +2790,6 @@ snapshot_manage_status:
in: body
required: true
type: string
snapshot_name:
description: |
The snapshot name.
in: body
required: true
type: string
snapshot_name_request:
description: |
The snapshot name.
in: body
required: false
type: string
snapshot_project_id:
description: |
ID of the project that the snapshot belongs to.

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

@ -4,14 +4,13 @@
Security services
=================
You can create, update, view, and delete a security service. A
security service stores configuration information for clients for
You can create, update, view, and delete security services. A
security service resource represents configuration information for clients for
authentication and authorization (AuthN/AuthZ). For example, a
share server will be the client for an existing service such as
share server will be the client for an existing security service such as
LDAP, Kerberos, or Microsoft Active Directory.
You can associate a share with from one to three security service
types:
The Shared File Systems service supports three security service types:
- ``ldap``. LDAP.
@ -34,6 +33,8 @@ You can configure a security service with these options:
- The password for the user, if you specify a user name.
A security service resource can also be given a user defined name and
description.
List security services
======================
@ -71,7 +72,7 @@ Response parameters
- status: security_service_status
- type: security_service_type
- id: security_service_id
- name: security_service_name
- name: name
Response example
----------------
@ -117,8 +118,8 @@ Response parameters
- id: security_service_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
- name: name
- description: description
- dns_ip: security_service_dns_ip
- user: security_service_user
- password: security_service_password
@ -173,8 +174,8 @@ Response parameters
- id: security_service_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
- name: name
- description: description
- dns_ip: security_service_dns_ip
- user: security_service_user
- password: security_service_password
@ -219,8 +220,8 @@ Request
- project_id: project_id_path
- type: security_service_type
- name: security_service_name
- description: security_service_description_request
- name: name_request
- description: description_request
- dns_ip: security_service_dns_ip_request
- user: security_service_user_request
- password: security_service_password_request
@ -243,8 +244,8 @@ Response parameters
- id: security_service_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
- name: name
- description: description
- dns_ip: security_service_dns_ip
- user: security_service_user
- password: security_service_password
@ -296,8 +297,8 @@ Request
- project_id: project_id_path
- security_service_id: security_service_id_path
- type: security_service_type
- name: security_service_name
- description: security_service_description_request
- name: name_request
- description: description_request
- dns_ip: security_service_dns_ip_request
- user: security_service_user_request
- password: security_service_password_request
@ -320,8 +321,8 @@ Response parameters
- id: security_service_id
- project_id: project_id
- type: security_service_type
- name: security_service_name
- description: security_service_description
- name: name
- description: description
- dns_ip: security_service_dns_ip
- user: security_service_user
- password: security_service_password

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

@ -4,7 +4,7 @@
Share group snapshots (since API v2.31)
=======================================
Use the shared file service to make snapshots of share groups. A share
Use the Shared File Systems Service to make snapshots of share groups. A share
group snapshot is a point-in-time, read-only copy of the data that is
contained in a share group. You can create, update, and delete
share group snapshots. After you create a share group snapshot, you
@ -50,8 +50,8 @@ Request
- project_id: project_id_path
- all_tenants: all_tenants
- name: group_snapshot_name_query
- description: group_snapshot_description_query
- name: name_query
- description: description_query
- status: group_snapshot_status_query
- share_group_id: share_group_id_query
- limit: limit_query
@ -65,7 +65,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: group_snapshot_id
- name: snapshot_name
- name: name
- links: group_snapshot_links
Response example
@ -103,8 +103,8 @@ Request
- project_id: project_id_path
- all_tenants: all_tenants
- name: group_snapshot_name_query
- description: group_snapshot_description_query
- name: name_query
- description: description_query
- status: group_snapshot_status_query
- share_group_id: share_group_id_query
- limit: limit_query
@ -121,8 +121,8 @@ Response parameters
- project_id: project_id
- status: group_snapshot_status_required
- share_group_id: share_group_id
- name: group_snapshot_name
- description: group_snapshot_description
- name: name
- description: description
- created_at: created_at
- members: group_snapshot_members
- links: group_snapshot_links
@ -173,7 +173,7 @@ Response parameters
- project_id: project_id
- size: snapshot_size
- share_protocol: snapshot_share_protocol
- name: snapshot_name
- name: name
- share_group_snapshot_id: group_snapshot_id
- share_id: snapshot_share_id
@ -224,8 +224,8 @@ Response parameters
- project_id: project_id
- status: group_snapshot_status_required
- share_group_id: share_group_id
- name: group_snapshot_name
- description: group_snapshot_description
- name: name
- description: description
- created_at: created_at
- members: group_snapshot_members
- links: group_snapshot_links
@ -267,8 +267,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- name: group_snapshot_name_option
- description: group_snapshot_description_option
- name: name_request
- description: description_request
- share_group_id: share_group_id
Request example
@ -286,8 +286,8 @@ Response parameters
- project_id: project_id
- status: group_snapshot_status_required
- share_group_id: share_group_id
- name: group_snapshot_name
- description: group_snapshot_description
- name: name
- description: description
- created_at: created_at
- members: group_snapshot_members
- links: group_snapshot_links
@ -372,8 +372,8 @@ Request
- project_id: project_id_path
- group_snapshot_id: group_snapshot_id_path
- name: group_snapshot_name_option
- description: group_snapshot_description_option
- name: name_request
- description: description_request
Request example
---------------
@ -390,8 +390,8 @@ Response parameters
- project_id: project_id
- status: group_snapshot_status_required
- share_group_id: share_group_id
- name: group_snapshot_name
- description: group_snapshot_description
- name: name
- description: description
- created_at: created_at
- members: group_snapshot_members
- links: group_snapshot_links

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

@ -201,7 +201,7 @@ Request
- project_id: project_id_path
- share_types: share_types_1
- name: share_group_type_name
- name: share_group_type_name_request
- group_specs: group_specs
- is_public: share_group_type_is_public_request

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

@ -74,9 +74,9 @@ Response parameters
- id: share_group_id
- links: share_group_links
- name: share_group_name_response
- name: name
- status: share_group_status
- description: share_group_description_response
- description: description
Response example
----------------
@ -123,10 +123,10 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: share_group_id
- name: share_group_name_response
- name: name
- created_at: created_at
- status: share_group_status
- description: share_group_description_response
- description: description
- project_id: project_id
- host: backend_host
- share_group_type_id: share_group_type_id_required
@ -175,8 +175,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- name: share_group_name
- description: share_group_description
- name: name_request
- description: description_request
- share_types: share_types
- share_group_type: share_group_type_id
- share_network: share_network_id_1
@ -195,10 +195,10 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: share_group_id
- name: share_group_name_response
- name: name
- created_at: created_at
- status: share_group_status
- description: share_group_description_response
- description: description
- project_id: project_id
- host: share_group_host
- share_group_type_id: share_group_type_id_required
@ -291,8 +291,8 @@ Request
- project_id: project_id_path
- share_group_id: share_group_id_path
- display_name: share_group_name
- display_description: share_group_description
- name: name_request
- description: description_request
Request example
@ -307,10 +307,10 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: share_group_id
- name: share_group_name_response
- name: name
- created_at: created_at
- status: share_group_status
- description: share_group_description_response
- description: description
- project_id: project_id
- host: share_group_host
- share_group_type_id: share_group_type_id_required

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

@ -4,25 +4,20 @@
Share networks
==============
A share network stores network information that share servers can
use where shares are hosted. You can associate a share with a
single share network. When you create a share, you can optionally
specify the ID of a share network through which instances can
access the share.
A share network resource stores network information to create and manage
share servers. Shares created with share networks are exported on these
networks with the help of share servers.
You can create, update, view, and delete a share network.
When you create a share network, you may optionally specify an associated
neutron network and subnetwork:
- Neutron network. Specify a network ID and subnet ID.
neutron network and subnetwork.
For more information about supported plug-ins for share networks,
see `Manila Network Plugins <https://docs.openstack.org/manila/latest/
admin/shared-file-systems-network-plugins.html>`_.
A share network has these attributes:
A share network resource has these attributes:
- The IP block in Classless Inter-Domain Routing (CIDR) notation
from which to allocate the network.
@ -35,6 +30,7 @@ A share network has these attributes:
- If the network uses segmentation, a segmentation identifier. For
example, VLAN, VXLAN, and GRE networks use segmentation.
A share network resource can also have a user defined name and description.
List share networks
===================
@ -73,7 +69,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: share_network_id
- name: share_network_name
- name: name
Response example
----------------
@ -126,8 +122,8 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: share_network_name
- description: share_network_description
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- gateway: share_network_gateway
@ -182,8 +178,8 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: share_network_name
- description: share_network_description
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- gateway: share_network_gateway
@ -227,8 +223,8 @@ Request
- project_id: project_id_path
- neutron_net_id: neutron_net_id_request
- neutron_subnet_id: neutron_subnet_id_request
- name: share_network_name_request
- description: share_network_description_request
- name: name_request
- description: description_request
Request example
---------------
@ -249,8 +245,8 @@ Response parameters
- segmentation_id: segmentation_id_1
- cidr: cidr_1
- ip_version: ip_version_1
- name: share_network_name
- description: share_network_description
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- gateway: share_network_gateway
@ -314,8 +310,8 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: share_network_name
- description: share_network_description
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- gateway: share_network_gateway
@ -379,8 +375,8 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: share_network_name
- description: share_network_description
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- gateway: share_network_gateway
@ -425,8 +421,8 @@ Request
- project_id: project_id_path
- share_network_id: share_network_id_path
- name: share_network_name_request
- description: share_network_description_request
- name: name_request
- description: description_request
- neutron_net_id: neutron_net_id_request
- neutron_subnet_id: neutron_subnet_id_request
@ -449,8 +445,8 @@ Response parameters
- segmentation_id: segmentation_id
- cidr: cidr
- ip_version: ip_version
- name: share_network_name
- description: share_network_description
- name: name
- description: description
- created_at: created_at
- updated_at: updated_at
- gateway: share_network_gateway

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

@ -320,7 +320,7 @@ Request
- driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1
- os-share-type-access:is_public: os-share-type-access:is_public
- name: share_type_name
- name: share_type_name_request
- replication_type: replication_type
- mount_snapshot_support: mount_snapshot_support
- revert_to_snapshot_support: revert_to_snapshot_support

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

@ -4,9 +4,11 @@
Shares
======
A share is a remote, mountable file system. You can mount a share
to and access a share from several hosts by several users at a
time.
A share is a remote, mountable file system. In the APIs below, a share
resource is a representation of this remote file system within the Shared
File Systems service. This resource representation includes useful metadata,
communicating the characteristics of the remote file system as determined by
the user and the Shared File Systems service.
You can create a share and associate it with a network, list
shares, and show information for, update, and delete a share.
@ -109,7 +111,7 @@ Request
- project_id: project_id_path
- all_tenants: all_tenants
- name: name_5
- name: name_request
- status: status_6
- share_server_id: share_server_id
- metadata: metadata
@ -177,7 +179,6 @@ Request
- project_id: project_id_path
- all_tenants: all_tenants
- name: name_5
- status: status_6
- share_server_id: share_server_id
- metadata: metadata
@ -187,6 +188,7 @@ Request
- offset: offset
- sort_key: sort_key
- sort_dir: sort_dir
- name: name_query
- snapshot_id: snapshot_id_query
- host: host_1
- share_network_id: share_network_id
@ -218,14 +220,14 @@ Response parameters
- project_id: project_id
- metadata: metadata
- status: status_16
- description: description_5
- description: description
- host: host_1
- access_rules_status: access_rules_status
- is_public: is_public
- share_group_id: share_group_id
- task_state: task_state
- snapshot_support: snapshot_support
- name: name_5
- name: name
- has_replicas: has_replicas
- replication_type: replication_type
- created_at: created_at
@ -289,14 +291,14 @@ Response parameters
- project_id: project_id
- metadata: metadata
- status: status_16
- description: description_5
- description: description
- host: host_9
- access_rules_status: access_rules_status
- is_public: is_public
- share_group_id: share_group_id
- task_state: task_state
- snapshot_support: snapshot_support
- name: name_5
- name: name
- has_replicas: has_replicas
- replication_type: replication_type
- created_at: created_at
@ -341,10 +343,10 @@ Request
- project_id: project_id_path
- share_proto: share_proto
- size: size
- name: name_5
- description: description_5
- display_name: display_name
- display_description: display_description
- name: name_request
- description: description_request
- display_name: display_name_request
- display_description: display_description_request
- share_type: share_type
- volume_type: volume_type
- snapshot_id: snapshot_id_request
@ -371,12 +373,10 @@ Response parameters
- project_id: project_id
- share_proto: share_proto
- size: size
- name: name_5
- description: description_5
- display_name: display_name
- display_description: display_description
- name: name
- description: description
- share_type: share_type_1
- share_type_name: share_type_name
- share_type_name: share_share_type_name
- has_replicas: has_replicas
- replication_type: replication_type
- volume_type: volume_type
@ -444,14 +444,14 @@ Request
- project_id: project_id_path
- share: share
- protocol: protocol
- name: name_5
- name: name_request
- share_type: share_type_2
- driver_options: driver_options
- export_path: export_path
- service_host: service_host
- share_server_id: manage_share_server_id
- is_public: is_public
- description: description_5
- description: description_request
Request example
---------------
@ -474,7 +474,7 @@ Response parameters
- id: id_4
- size: size_2
- share_type: share_type_1
- share_type_name: share_type_name
- share_type_name: share_share_type_name
- has_replicas: has_replicas
- replication_type: replication_type
- export_location: export_location
@ -482,12 +482,12 @@ Response parameters
- metadata: metadata
- status: status_8
- share_server_id: manage_share_server_id
- description: description_5
- description: description
- host: host_9
- is_public: is_public
- share_group_id: share_group_id
- snapshot_support: snapshot_support
- name: name_5
- name: name
- created_at: created_at
- share_proto: share_proto
- volume_type: volume_type
@ -541,8 +541,8 @@ Request
- project_id: project_id_path
- share_id: share_id
- is_public: is_public
- display_name: display_name_3
- display_description: display_description_3
- display_name: display_name_request
- display_description: display_description_request
Request example
---------------
@ -555,7 +555,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- share_type_name: share_type_name
- share_type_name: share_share_type_name
- links: links
- availability_zone: availability_zone_1
- share_network_id: share_network_id
@ -569,14 +569,14 @@ Response parameters
- project_id: project_id
- metadata: metadata
- status: status_16
- description: description_5
- description: description
- host: host_9
- access_rules_status: access_rules_status
- is_public: is_public
- share_group_id: share_group_id
- task_state: task_state
- snapshot_support: snapshot_support
- name: name_5
- name: name
- has_replicas: has_replicas
- replication_type: replication_type
- created_at: created_at

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

@ -4,9 +4,13 @@
Share snapshots
===============
Use the shared file service to make snapshots of shares. A share
Use the Shared File Systems service to make snapshots of shares. A share
snapshot is a point-in-time, read-only copy of the data that is
contained in a share. You can create, manage, update, and delete
contained in a share. The APIs below allow controlling share snapshots. They
are represented by a "snapshot" resource in the Shared File Systems service,
and they can have user-defined metadata such as a name and description.
You can create, manage, update, and delete
share snapshots. After you create or manage a share snapshot, you
can create a share from it. You can also revert a share to its most
recent snapshot.
@ -74,7 +78,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: snapshot_id
- name: snapshot_name
- name: name
Response example
----------------
@ -120,8 +124,8 @@ Response parameters
- id: snapshot_id
- status: snapshot_status
- share_id: snapshot_share_id
- name: snapshot_name
- description: snapshot_description
- name: name
- description: description
- created_at: created_at
- share_proto: snapshot_share_protocol
- share_size: snapshot_share_size
@ -172,8 +176,8 @@ Response parameters
- id: snapshot_id
- status: snapshot_status
- share_id: snapshot_share_id
- name: snapshot_name
- description: snapshot_description
- name: name
- description: description
- created_at: created_at
- share_proto: snapshot_share_protocol
- share_size: snapshot_share_size
@ -219,10 +223,10 @@ Request
- project_id: project_id_path
- share_id: snapshot_share_id_request
- force: force_snapshot_request
- name: snapshot_name_request
- display_name: snapshot_display_name
- description: snapshot_description_request
- display_description: snapshot_display_description
- name: name_request
- description: description_request
- display_name: display_name_request
- display_description: display_description_request
Request example
---------------
@ -238,8 +242,8 @@ Response parameters
- id: snapshot_id
- share_id: snapshot_share_id
- status: snapshot_status
- name: snapshot_name
- description: snapshot_description
- name: name
- description: description
- created_at: created_at
- share_proto: snapshot_share_protocol
- share_size: snapshot_share_size
@ -293,10 +297,10 @@ Request
- project_id: project_id_path
- share_id: snapshot_manage_share_id
- provider_location: snapshot_provider_location_request
- name: snapshot_name_request
- display_name: snapshot_display_name
- description: snapshot_description_request
- display_description: snapshot_display_description
- name: name_request
- display_name: display_name_request
- description: description_request
- display_description: display_description_request
- driver_options: driver_options
Request example
@ -313,8 +317,8 @@ Response parameters
- id: snapshot_id
- share_id: snapshot_share_id
- status: snapshot_manage_status
- name: snapshot_name
- description: snapshot_description
- name: name
- description: description
- created_at: created_at
- share_proto: snapshot_share_protocol
- share_size: snapshot_share_size
@ -500,8 +504,8 @@ Request
- project_id: project_id_path
- snapshot_id: snapshot_id_path
- display_name: snapshot_display_name
- display_description: snapshot_display_description
- display_name: display_name_request
- display_description: display_description_request
Request example
---------------
@ -517,8 +521,8 @@ Response parameters
- id: snapshot_id
- status: snapshot_status
- share_id: snapshot_share_id
- name: snapshot_name
- description: snapshot_description
- name: name
- description: description
- created_at: created_at
- share_proto: snapshot_share_protocol
- share_size: snapshot_share_size