openstack/manila
Code Issues Proposed changes

Merge "[api-ref] Fix incorrect parameters"

Browse Source
This commit is contained in:
Zuul 2021-03-23 01:34:21 +00:00 committed by Gerrit Code Review
commit 50401393c7
10 changed files with 402 additions and 394 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -51,11 +51,10 @@ Request
- protocol: protocol - protocol: protocol
- name: name_request - name: name_request
- display_name: display_name_request - display_name: display_name_request
- share_type: share_type_2 - share_type: share_type_request
- driver_options: driver_options - driver_options: driver_options
- export_path: export_path - export_path: export_path
- service_host: service_host - service_host: service_host
- is_public: is_public
- description: description_request - description: description_request
- display_description: display_description_request - display_description: display_description_request
@ -72,29 +71,26 @@ Response parameters
- share: share - share: share
- links: links - links: links
- availability_zone: availability_zone_1 - availability_zone: availability_zone
- share_network_id: share_network_id - share_network_id: share_network_id
- export_locations: export_locations - export_locations: export_locations
- share_server_id: share_server_id - share_server_id: share_server_id
- snapshot_id: snapshot_id_share_response - snapshot_id: snapshot_id_shares_response
- id: id_4 - id: share_id_response
- size: size_2 - size: size_response
- share_type: share_type_1 - share_type: share_type_shares_response
- share_type_name: share_type_name - share_type_name: share_type_name
- has_replicas: has_replicas
- replication_type: replication_type
- export_location: export_location - export_location: export_location
- project_id: project_id - project_id: project_id
- metadata: metadata - metadata: metadata
- status: status_8 - status: share_status_response
- description: description - description: description
- host: host_1 - host: host_resource_response
- is_public: is_public - is_public: is_public_shares_response
- snapshot_support: snapshot_support - snapshot_support: snapshot_support
- name: name - name: name
- created_at: created_at - created_at: created_at
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type
Response example Response example
---------------- ----------------

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

@ -491,12 +491,8 @@ source_share_group_snapshot_id_query:
min_version: 2.31 min_version: 2.31
status_query: status_query:
description: | description: |
Filters by a share status. A valid value is Filters by a share status. For valid statuses, see the `section
``creating``, ``creating_from_snapshot``, ``error``, ``available``, above <#shares>`_.
``deleting``, ``error_deleting``, ``manage_starting``, ``manage_error``,
``unmanage_starting``, ``unmanage_error``, ``migrating``,
``extending``, ``extending_error``, ``shrinking``,
``shrinking_error``, or ``shrinking_possible_data_loss_error``.
in: query in: query
required: false required: false
type: string type: string
@ -542,8 +538,10 @@ access_level:
description: | description: |
The access level to the share. To grant or deny The access level to the share. To grant or deny
access to a share, you specify one of the following share access access to a share, you specify one of the following share access
levels: - ``rw``. Read and write (RW) access. - ``ro``. Read- levels:
only (RO) access.
- ``rw``. Read and write (RW) access.
- ``ro``. Read-only (RO) access.
in: body in: body
required: true required: true
type: string type: string
@ -583,13 +581,6 @@ access_share_id:
in: body in: body
required: true required: true
type: string type: string
access_status:
description: |
The share access status, which is ``new``,
``error``, ``active``.
in: body
required: true
type: string
access_to: access_to:
description: | description: |
The value that defines the access. The back end The value that defines the access. The back end
@ -654,26 +645,19 @@ allow_access:
type: object type: object
availability_zone: availability_zone:
description: | description: |
The availability zone. The name of the availability zone the share exists within.
in: body
required: false
type: string
min_version: 2.1
availability_zone_1:
description: |
The availability zone.
in: body in: body
required: true required: true
type: string type: string
availability_zone_id: availability_zone_id:
description: | description: |
The availability zone ID. The availability zone ID the resource exists within.
in: body in: body
required: true required: true
type: string type: string
availability_zone_id_2: availability_zone_id_share_group:
description: | description: |
The availability zone ID for create share group. The availability zone ID that the share group exists within.
in: body in: body
required: true required: true
type: string type: string
@ -686,7 +670,7 @@ availability_zone_name:
type: string type: string
availability_zone_request: availability_zone_request:
description: | description: |
The UUID or name of an availability zone for the share network subnet. The UUID or name of an availability zone for resource to be created within.
in: body in: body
required: false required: false
type: string type: string
@ -705,8 +689,8 @@ backend:
backend_details: backend_details:
description: | description: |
The back-end details for a server. Each back end The back-end details for a server. Each back end
can store any key- value information that it requires. For can store any key-value information that it requires. For
example, the generic back- end driver might store the router ID. example, the generic back-end driver might store the router ID.
in: body in: body
required: true required: true
type: object type: object
@ -719,9 +703,11 @@ backend_host:
backend_name: backend_name:
description: | description: |
The name of the back end in this format: The name of the back end in this format:
``host@backend#POOL``. - ``host``. The host name for the back ``host@backend#POOL``:
end. - ``backend``. The name of the back end. - ``POOL``. The
pool name for the back end. - ``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 in: body
required: true required: true
type: string type: string
@ -754,7 +740,7 @@ capability_driver_version:
capability_free_capacity_gb: capability_free_capacity_gb:
description: | description: |
The amount of free capacity for the back end, in The amount of free capacity for the back end, in
GBs. A valid value is a string, such as ``unknown``, or an GiBs. A valid value is a string, such as ``unknown``, or an
integer. integer.
in: body in: body
required: true required: true
@ -806,7 +792,7 @@ capability_storage_protocol:
type: string type: string
capability_total_capacity_gb: capability_total_capacity_gb:
description: | description: |
The total capacity for the back end, in GBs. A The total capacity for the back end, in GiBs. A
valid value is a string, such as ``unknown``, or an integer. valid value is a string, such as ``unknown``, or an integer.
in: body in: body
required: true required: true
@ -836,7 +822,9 @@ consistent_snapshot_support:
min_version: 2.34 min_version: 2.34
count: count:
description: | description: |
The total count of requested resource before pagination is applied. The total count of requested resource before pagination is applied. This
parameter is only present in the API response if "with_count=True" is
supplied in the query.
in: body in: body
required: false required: false
type: integer type: integer
@ -856,6 +844,15 @@ create_share_from_snapshot_support_body:
in: body in: body
required: false required: false
type: boolean type: boolean
create_share_from_snapshot_support_share_capability:
description: |
Whether or not this share supports snapshots that can be cloned into new
shares. Inconsequential if the share doesn't support snapshots. (see
capability "snapshot_support")
in: body
required: true
type: boolean
min_version: 2.24
created_at: created_at:
description: | description: |
The date and time stamp when the resource was created within the service's The date and time stamp when the resource was created within the service's
@ -941,9 +938,9 @@ export_location:
The export location. For newer API versions it is available in The export location. For newer API versions it is available in
separate APIs. See sections `Share export locations separate APIs. See sections `Share export locations
<#share-share-export-locations>`_ and `Share instance export <#share-share-export-locations>`_ and `Share instance export
locations <#share-share-instance-export- locations>`_. locations <#share-share-instance-export-locations>`_.
in: body in: body
required: false required: true
type: string type: string
max_version: 2.8 max_version: 2.8
export_location_availability_zone: export_location_availability_zone:
@ -1007,18 +1004,19 @@ export_locations:
locations. For newer API versions it is available in separate APIs. locations. For newer API versions it is available in separate APIs.
See sections `Share export locations <#share-share-export-locations>`_ See sections `Share export locations <#share-share-export-locations>`_
and `Share instance export locations <#share-share-instance- and `Share instance export locations <#share-share-instance-
export- locations>`_. export-locations>`_.
in: body in: body
required: false required: true
type: array type: array
max_version: 2.8 max_version: 2.8
export_path: export_path:
description: | description: |
The share export path in the format appropriate The share export path in the format appropriate
for the protocol: - NFS protocol. ``10.0.0.1:/foo_path``. For for the protocol:
example, ``10.254.0.5:/shares/share-42033c24-0261-424f-abda-
4fef2f6dbfd5``. - CIFS protocol. - NFS protocol. ``10.0.0.1:/foo_path``. For example, ``10.254.0
``\\10.0.0.1\foo_name_of_cifs_share``. .5:/shares/share-42033c24-0261-424f-abda-4fef2f6dbfd5``.
- CIFS protocol. For example, ``\\10.0.0.1\foo_name_of_cifs_share``.
in: body in: body
required: true required: true
type: string type: string
@ -1163,34 +1161,14 @@ host:
in: body in: body
required: true required: true
type: string type: string
host_1: host_resource_response:
description: | description: |
The share host name. The host name of the service back end that the resource is contained
within. This parameter is always present in the response schema, but the
value may be represented as "null" to non-admin users.
in: body in: body
required: true required: true
type: string type: string
host_10:
description: |
The host pool of the destination back end, in
this format: ``host@backend#POOL``. - ``host``. The host name for
the destination back end. - ``backend``. The name of the
destination back end. - ``POOL``. The pool name for the
destination back end.
in: body
required: true
type: string
host_6:
description: |
The share instance host name.
in: body
required: true
type: string
host_9:
description: |
The share host name.
in: body
required: false
type: string
host_share_server_body: host_share_server_body:
description: | description: |
The share server host name or IP address. The share server host name or IP address.
@ -1203,12 +1181,6 @@ id_13:
in: body in: body
required: true required: true
type: string type: string
id_4:
description: |
The UUID of the share.
in: body
required: true
type: string
identifier: identifier:
description: | description: |
The identifier of the share server in the back-end storage system. The identifier of the share server in the back-end storage system.
@ -1259,26 +1231,42 @@ is_group_type_default:
required: true required: true
type: boolean type: boolean
min_version: 2.46 min_version: 2.46
is_public: is_public_manage_request:
description: | description: |
The level of visibility for the share. Set to ``true`` to make The level of visibility for the share. Set to ``true`` to make
share public. Set to ``false`` to make it private. Default value share visible to all projects in the cloud. Set to ``false`` to make it
is ``false``. private to your project. Default value is ``false``.
in: body in: body
required: false required: false
type: boolean type: boolean
min_version: 2.8 min_version: 2.8
is_public_request:
description: |
The level of visibility for the share. Set to ``true`` to make
share visible to all projects in the cloud. Set to ``false`` to make it
private to your project. Default value is ``false``.
in: body
required: false
type: boolean
is_public_shares_response:
description: |
Whether the share is visible publicly (by all projects in the cloud) or
not.
in: body
required: true
type: boolean
links: links:
description: | description: |
The share links Pagination and bookmark links for the resource.
in: body in: body
required: true required: true
type: array type: array
manage_host: manage_host:
description: | description: |
The host of the destination back end, in this format: ``host@backend``. The host of the destination back end, in this format: ``host@backend``.
- ``host``. The host name for the destination back end.
- ``backend``. The name of the destination back end. - ``host``: The host name for the destination back end.
- ``backend``: The name of the destination back end.
in: body in: body
required: true required: true
type: string type: string
@ -1437,7 +1425,7 @@ metadata:
One or more metadata key and value pairs as a One or more metadata key and value pairs as a
dictionary of strings. dictionary of strings.
in: body in: body
required: false required: true
type: object type: object
metadata_2: metadata_2:
description: | description: |
@ -1511,6 +1499,15 @@ mount_snapshot_support_body:
in: body in: body
required: false required: false
type: boolean type: boolean
mount_snapshot_support_share_capability:
description: |
Whether or not this share supports snapshots that can be mounted
and access controlled independently of the share. Inconsequential if the
share doesn't support snapshots (see capability "snapshot_support").
in: body
required: true
type: boolean
min_version: 2.32
name: name:
description: | description: |
The user defined name of the resource. The user defined name of the resource.
@ -1968,17 +1965,31 @@ replica_state:
min_version: 2.11 min_version: 2.11
replication_type: replication_type:
description: | description: |
The share replication type. Type of replication supported for shares of this type. Valid values are:
- ``null``: replication is not supported
- ``readable``: users can create replicas of the share that are
read-only until they are promoted,
- ``writable``: users can create read/write replicas
- ``dr``: users can create replicas that are not exported until
they are promoted.
in: body in: body
required: false required: false
type: string type: string
replication_type_share_capability:
description: |
The share replication type. The value can be:
- ``null``, if the share cannot be replicated.
- ``readable``, if one or more read-only replicas of the share can be
created
- ``writable``, if one or more active replicas of the share can be created
- ``dr``, if one or more replicas of the share can be created that will
remain inaccessible until they are promoted.
in: body
required: true
type: string
min_version: 2.11 min_version: 2.11
replication_type_body:
description: |
The share replication type.
in: body
required: false
type: string
request_id_body: request_id_body:
description: | description: |
The UUID of the request during which the message was created. The UUID of the request during which the message was created.
@ -2025,6 +2036,15 @@ revert_to_snapshot_support_body:
in: body in: body
required: false required: false
type: boolean type: boolean
revert_to_snapshot_support_share_capability:
description: |
Whether or not this share supports being reverted to its latest snapshot.
Inconsequential if the share doesn't support snapshots (see capability
"snapshot_support").
in: body
required: true
type: boolean
min_version: 2.27
security_service_dns_ip: security_service_dns_ip:
description: | description: |
The DNS IP address that is used inside the project network. The DNS IP address that is used inside the project network.
@ -2200,9 +2220,11 @@ service_enable_host_response:
service_host: service_host:
description: | description: |
The manage-share service host in this format: The manage-share service host in this format:
``host@backend#POOL``. - ``host``. The host name for the back ``host@backend#POOL``:
end. - ``backend``. The name of the back end. - ``POOL``. The
pool name for the back end. - ``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 in: body
required: true required: true
type: string type: string
@ -2332,10 +2354,15 @@ share_group_type_name_request:
in: body in: body
required: false required: false
type: string type: string
share_id_2: share_id_response:
description: | description: |
The UUID of the share from which the share The UUID of the share.
instance was created. in: body
required: true
type: string
share_id_share_instances_response:
description: |
The UUID of the share to which the share instance belongs to.
in: body in: body
required: true required: true
type: string type: string
@ -2370,34 +2397,31 @@ share_network_gateway:
max_version: 2.50 max_version: 2.50
share_network_id: share_network_id:
description: | description: |
The share network ID. The share network ID where the resource is exported to.
in: body in: body
required: true required: true
type: string type: string
share_network_id_1: share_network_id_manage_server_request:
description: | description: |
The ID of a share network. Note that when using The UUID of the share network that the share server will pertain to.
a share type with the ``driver_handles_share_servers`` extra spec
as ``False``, you should not provide a ``share_network_id``.
in: body
required: false
type: string
share_network_id_2:
description: |
The UUID of a share network where the share
server exists or will be created. If ``share_network_id`` is
``None`` and you provide a ``snapshot_id``, the
``share_network_id`` value from the snapshot is used.
in: body
required: false
type: string
share_network_id_4:
description: |
The share network ID.
in: body in: body
required: true required: true
type: string type: string
share_network_id_share_server_body: share_network_id_request:
description: |
The ID of a share network that the resource must be exported to. Note
that when using a share type with the ``driver_handles_share_servers``
extra spec as ``False``, you should not provide a ``share_network_id``.
in: body
required: false
type: string
share_network_id_share_networks_response:
description: |
The UUID of a share network resource.
in: body
required: true
type: string
share_network_id_share_servers_response:
description: | description: |
The UUID of a share network that is associated The UUID of a share network that is associated
with the share server. with the share server.
@ -2540,7 +2564,7 @@ share_network_subnet_share_network_name:
type: string type: string
share_new_size: share_new_size:
description: | description: |
New size of the share, in GBs. New size of the share, in GiBs.
in: body in: body
required: true required: true
type: integer type: integer
@ -2666,29 +2690,19 @@ share_share_type_name:
required: true required: true
type: string type: string
min_version: 2.6 min_version: 2.6
share_type: share_status_request:
description: | description: |
The share type name. If you omit this parameter, The share or share instance status to be set. Possible values are listed in
the default share type is used. To view the default share type set the `section above <#shares>`_.
by the administrator, issue a list default share types request.
You cannot specify both the ``share_type`` and ``volume_type``
parameters.
in: body
required: false
type: string
share_type_1:
description: |
The UUID of the share type. In minor versions, this parameter is
a share type name, as a string.
in: body in: body
required: true required: true
type: string type: string
min_version: 2.6 share_status_response:
share_type_2:
description: | description: |
The share type name. The share or share instance status. Possible values are listed in
the `section above <#shares>`_.
in: body in: body
required: false required: true
type: string type: string
share_type_access:is_public: share_type_access:is_public:
description: | description: |
@ -2759,6 +2773,24 @@ share_type_name_request:
in: body in: body
required: false required: false
type: string type: string
share_type_request:
description: |
The name or ID of the share type to be used to create the resource. If you
omit this parameter, the default share type is used. To view the default
share type set by the administrator, issue a list default share types
request.
in: body
required: false
type: string
share_type_shares_response:
description: |
The UUID of the share type that the share belongs to. Prior to API
version 2.6, this parameter resolved to the name of the share type. In
API version 2.6 and beyond, this parameter holds the share type ID
instead of the name.
in: body
required: true
type: string
share_types: share_types:
description: | description: |
A list of one or more share type IDs. A list of one or more share type IDs.
@ -2790,17 +2822,17 @@ shrink:
in: body in: body
required: true required: true
type: object type: object
size: size_request:
description: | description: |
The share size, in GBs. The requested share size The share size, in GiBs. The requested share size cannot be greater than
cannot be greater than the allowed GB quota. To view the allowed the allowed GiB quota. To view the allowed quota, issue a get limits
quota, issue a get limits request. request.
in: body in: body
required: true required: true
type: integer type: integer
size_2: size_response:
description: | description: |
The share size, in GBs. The share size, in GiBs.
in: body in: body
required: true required: true
type: integer type: integer
@ -2824,7 +2856,7 @@ snapshot_id_request:
in: body in: body
required: false required: false
type: string type: string
snapshot_id_share_response: snapshot_id_shares_response:
description: | description: |
The UUID of the snapshot that was used to create The UUID of the snapshot that was used to create
the share. the share.
@ -2911,13 +2943,13 @@ snapshot_share_protocol:
type: string type: string
snapshot_share_size: snapshot_share_size:
description: | description: |
The share snapshot size, in GBs. The share snapshot size, in GiBs.
in: body in: body
required: true required: true
type: integer type: integer
snapshot_size: snapshot_size:
description: | description: |
The snapshot size, in GBs. The snapshot size, in GiBs.
in: body in: body
required: true required: true
type: integer type: integer
@ -2947,13 +2979,14 @@ snapshot_support:
required: true required: true
type: boolean type: boolean
min_version: 2.2 min_version: 2.2
snapshot_support_1: snapshot_support_share_capability:
description: | description: |
An extra specification that filters back ends by Whether or not this share supports snapshots. Snapshots are point in
whether they do or do not support share snapshots. time backups of the share.
in: body in: body
required: false required: true
type: boolean type: boolean
min_version: 2.2
snapshot_unmanage: snapshot_unmanage:
description: | description: |
To unmanage a share snapshot, include this parameter and set its value to To unmanage a share snapshot, include this parameter and set its value to
@ -2982,6 +3015,13 @@ source_share_group_snapshot_id_response:
in: body in: body
required: true required: true
type: string type: string
source_share_group_snapshot_member_id:
description: |
ID of the group snapshot instance that was the source of this share.
in: body
required: true
type: string
min_version: 2.31
state: state:
description: | description: |
Prior to versions 2.28, the state of all access rules of a given share Prior to versions 2.28, the state of all access rules of a given share
@ -2994,68 +3034,6 @@ state:
in: body in: body
required: true required: true
type: string type: string
status:
description: |
The consistency group snapshot status, which is
``available``, ``creating``, ``error``, ``deleting``, or
``error_deleting``.
in: body
required: true
type: string
status_1:
description: |
The consistency group status. A valid value is
``creating``, ``available``, ``error``, ``deleting``, or
``error_deleting``.
in: body
required: true
type: string
status_16:
description: |
The share status, which is ``creating``, ``creating_from_snapshot``,
``error``, ``available``, ``deleting``, ``error_deleting``,
``manage_starting``, ``manage_error``, ``unmanage_starting``,
``unmanage_error``, ``unmanaged``, ``extend``,
``extending_error``, ``shrinking``, ``shrinking_error``, or
``shrinking_possible_data_loss_error``.
in: body
required: true
type: string
status_3:
description: |
The share status. A valid value is: -
``creating``. The share is being created. - ``deleting``. The
share is being deleted. - ``error``. An error occurred during
share creation. - ``error_deleting``. An error occurred during
share deletion. - ``available``. The share is ready to use. -
``manage_starting``. Share manage started. - ``manage_error``.
Share manage failed. - ``unmanage_starting``. Share unmanage
started. - ``unmanage_error``. Share cannot be unmanaged. -
``unmanaged``. Share was unmanaged. - ``extending``. The extend,
or increase, share size request was issued successfully. -
``extending_error``. Extend share failed. - ``shrinking``. Share
is being shrunk. - ``shrinking_error``. Failed to update quota on
share shrinking. - ``shrinking_possible_data_loss_error``. Shrink
share failed due to possible data loss. - ``creating_from_snapshot``.
The share is being created from a parent snapshot.
in: body
required: true
type: string
status_5:
description: |
The share instance status. A valid value is
``available``, ``error``, ``creating``, ``deleting``,
``creating_from_snapshot``, or ``error_deleting``.
in: body
required: true
type: string
status_8:
description: |
The share status, which is ``available``,
``manage_starting``, or ``manage_error``.
in: body
required: true
type: string
status_share_server_body: status_share_server_body:
description: | description: |
The share server status, which is ``active``, The share server status, which is ``active``,
@ -3069,8 +3047,7 @@ task_state:
value is ``null``, ``migration_starting``, ``migration_error``, value is ``null``, ``migration_starting``, ``migration_error``,
``migration_success``, ``migration_completing``, or ``migrating``. ``migration_success``, ``migration_completing``, or ``migrating``.
The ``task_state`` is ``null`` unless the share is migrated from The ``task_state`` is ``null`` unless the share is migrated from
one back-end to another. For details, see ``os-migrate_share`` one back-end to another.
extension request.
in: body in: body
required: true required: true
type: string type: string
@ -3294,6 +3271,14 @@ volume_type:
in: body in: body
required: false required: false
type: string type: string
volume_type_shares_response:
description: |
The share type ID. This is a legacy parameter that contains the same value
as the ``share_type`` parameter. Do not rely on this parameter as it may
be removed in a future API revision.
in: body
required: true
type: string
writable: writable:
description: | description: |
Specifies whether migration should only be performed Specifies whether migration should only be performed

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

@ -271,7 +271,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- share_id: share_id - share_id: share_id
- reset_status: reset_status - reset_status: reset_status
- status: access_status - status: share_status_request
Request example Request example

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

@ -135,7 +135,7 @@ Response parameters
- share_network_id: share_network_id - share_network_id: share_network_id
- share_types: share_types_1 - share_types: share_types_1
- links: share_group_links - links: share_group_links
- availability_zone: availability_zone_id_2 - availability_zone: availability_zone_id_share_group
- consistent_snapshot_support: consistent_snapshot_support - consistent_snapshot_support: consistent_snapshot_support
Response example Response example
@ -180,9 +180,9 @@ Request
- description: description_request - description: description_request
- share_types: share_types - share_types: share_types
- share_group_type: share_group_type_id - share_group_type: share_group_type_id
- share_network: share_network_id_1 - share_network: share_network_id_request
- source_share_group_snapshot: source_share_group_snapshot_id - source_share_group_snapshot: source_share_group_snapshot_id
- availability_zone: availability_zone_id_2 - availability_zone: availability_zone_id_share_group
Request example Request example
--------------- ---------------
@ -207,7 +207,7 @@ Response parameters
- share_network_id: share_network_id - share_network_id: share_network_id
- share_types: share_types_1 - share_types: share_types_1
- links: share_group_links - links: share_group_links
- availability_zone: availability_zone_id_2 - availability_zone: availability_zone_id_share_group
- consistent_snapshot_support: consistent_snapshot_support - consistent_snapshot_support: consistent_snapshot_support
Response example Response example
@ -319,7 +319,7 @@ Response parameters
- share_network_id: share_network_id - share_network_id: share_network_id
- share_types: share_types_1 - share_types: share_types_1
- links: share_group_links - links: share_group_links
- availability_zone: availability_zone_id_2 - availability_zone: availability_zone_id_share_group
- consistent_snapshot_support: consistent_snapshot_support - consistent_snapshot_support: consistent_snapshot_support
Response example Response example

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

@ -45,19 +45,19 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_5 - status: share_status_response
- access_rules_status: access_rules_status - access_rules_status: access_rules_status
- share_id: share_id_2 - share_id: share_id_share_instances_response
- progress: progress_share_instance - progress: progress_share_instance
- availability_zone: availability_zone_1 - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- replica_state: replica_state - replica_state: replica_state
- export_location: export_location - export_location: export_location
- export_locations: export_locations - export_locations: export_locations
- cast_rules_to_readonly: share_instance_cast_rules_to_readonly - cast_rules_to_readonly: share_instance_cast_rules_to_readonly
- share_network_id: share_network_id_4 - share_network_id: share_network_id
- share_server_id: share_server_id - share_server_id: share_server_id
- host: host_6 - host: host_resource_response
- id: id_13 - id: id_13
Response example Response example
@ -103,19 +103,19 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- status: status_5 - status: share_status_response
- access_rules_status: access_rules_status - access_rules_status: access_rules_status
- share_id: share_id_2 - share_id: share_id_share_instances_response
- progress: progress_share_instance - progress: progress_share_instance
- availability_zone: availability_zone_1 - availability_zone: availability_zone
- created_at: created_at - created_at: created_at
- replica_state: replica_state - replica_state: replica_state
- export_location: export_location - export_location: export_location
- export_locations: export_locations - export_locations: export_locations
- cast_rules_to_readonly: share_instance_cast_rules_to_readonly - cast_rules_to_readonly: share_instance_cast_rules_to_readonly
- share_network_id: share_network_id_4 - share_network_id: share_network_id
- share_server_id: share_server_id - share_server_id: share_server_id
- host: host_6 - host: host_resource_response
- id: id_13 - id: id_13
Response example Response example
@ -158,7 +158,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- share_instance_id: share_instance_id - share_instance_id: share_instance_id
- status: status_5 - status: share_status_request
Request example Request example
--------------- ---------------

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

@ -202,7 +202,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_subnet_id
- neutron_net_id: share_network_subnet_neutron_net_id - neutron_net_id: share_network_subnet_neutron_net_id
- neutron_subnet_id: share_network_subnet_neutron_subnet_id - neutron_subnet_id: share_network_subnet_neutron_subnet_id
- network_type: share_network_subnet_network_type - network_type: share_network_subnet_network_type

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

@ -76,7 +76,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_id_share_networks_response
- name: name - name: name
Response example Response example
@ -122,7 +122,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_id_share_networks_response
- project_id: project_id - project_id: project_id
- neutron_net_id: neutron_net_id - neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id - neutron_subnet_id: neutron_subnet_id
@ -184,7 +184,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_id_share_networks_response
- project_id: project_id - project_id: project_id
- neutron_net_id: neutron_net_id - neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id - neutron_subnet_id: neutron_subnet_id
@ -268,7 +268,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_id_share_networks_response
- project_id: project_id - project_id: project_id
- neutron_net_id: neutron_net_id - neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id - neutron_subnet_id: neutron_subnet_id
@ -342,7 +342,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_id_share_networks_response
- project_id: project_id - project_id: project_id
- neutron_net_id: neutron_net_id - neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id - neutron_subnet_id: neutron_subnet_id
@ -413,7 +413,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_id_share_networks_response
- project_id: project_id - project_id: project_id
- neutron_net_id: neutron_net_id - neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id - neutron_subnet_id: neutron_subnet_id
@ -492,7 +492,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: share_network_id - id: share_network_id_share_networks_response
- project_id: project_id - project_id: project_id
- neutron_net_id: neutron_net_id - neutron_net_id: neutron_net_id
- neutron_subnet_id: neutron_subnet_id - neutron_subnet_id: neutron_subnet_id

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

@ -75,7 +75,7 @@ Response parameters
- id: share_server_id - id: share_server_id
- project_id: project_id - project_id: project_id
- status: status_share_server_body - status: status_share_server_body
- share_network_id: share_network_id - share_network_id: share_network_id_share_servers_response
- share_network_name: share_network_name - share_network_name: share_network_name
- host: host_share_server_body - host: host_share_server_body
- updated_at: updated_at - updated_at: updated_at
@ -126,7 +126,7 @@ Response parameters
- project_id: project_id - project_id: project_id
- status: status_share_server_body - status: status_share_server_body
- backend_details: backend_details - backend_details: backend_details
- share_network_id: share_network_id_share_server_body - share_network_id: share_network_id_share_servers_response
- share_network_name: share_network_name - share_network_name: share_network_name
- host: host_share_server_body - host: host_share_server_body
- created_at: created_at - created_at: created_at
@ -252,7 +252,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- host: manage_host - host: manage_host
- identifier: identifier - identifier: identifier
- share_network: share_network_id - share_network: share_network_id_manage_server_request
- driver_options: driver_options - driver_options: driver_options
- share_network_subnet_id: share_network_subnet_id_manage_server_request - share_network_subnet_id: share_network_subnet_id_manage_server_request
@ -273,7 +273,7 @@ Response parameters
- status: share_server_status - status: share_server_status
- host: manage_host - host: manage_host
- share_network_name: share_network_name - share_network_name: share_network_name
- share_network_id: share_network_id - share_network_id: share_network_id_share_servers_response
- created_at: created_at - created_at: created_at
- backend_details: backend_details - backend_details: backend_details
- is_auto_deletable: is_auto_deletable - is_auto_deletable: is_auto_deletable

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

@ -124,7 +124,7 @@ Response parameters
- extra_specs: extra_specs - extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers - driver_handles_share_servers: driver_handles_share_servers
- replication_type: replication_type - replication_type: replication_type
- snapshot_support: snapshot_support_1 - snapshot_support: snapshot_support
- mount_snapshot_support: mount_snapshot_support - mount_snapshot_support: mount_snapshot_support
- revert_to_snapshot_support: revert_to_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support
- share_type_access:is_public: share_type_access:is_public - share_type_access:is_public: share_type_access:is_public
@ -176,7 +176,7 @@ Response parameters
- required_extra_specs: required_extra_specs - required_extra_specs: required_extra_specs
- extra_specs: extra_specs - extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers - driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1 - snapshot_support: snapshot_support
- share_type_access:is_public: share_type_access:is_public - share_type_access:is_public: share_type_access:is_public
- name: share_type_name - name: share_type_name
- description: share_type_description - description: share_type_description
@ -227,7 +227,7 @@ Response Parameters
- required_extra_specs: required_extra_specs - required_extra_specs: required_extra_specs
- extra_specs: extra_specs - extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers - driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1 - snapshot_support: snapshot_support
- replication_type: replication_type - replication_type: replication_type
- mount_snapshot_support: mount_snapshot_support - mount_snapshot_support: mount_snapshot_support
- revert_to_snapshot_support: revert_to_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support
@ -280,7 +280,7 @@ Response parameters
- extra_specs: extra_specs - extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers - driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1 - snapshot_support: snapshot_support
- replication_type: replication_type - replication_type: replication_type
- mount_snapshot_support: mount_snapshot_support - mount_snapshot_support: mount_snapshot_support
- revert_to_snapshot_support: revert_to_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support
@ -324,7 +324,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- extra_specs: extra_specs - extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers - driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1 - snapshot_support: snapshot_support
- os-share-type-access:is_public: os-share-type-access:is_public - os-share-type-access:is_public: os-share-type-access:is_public
- name: share_type_name_request - name: share_type_name_request
- replication_type: replication_type - replication_type: replication_type
@ -348,7 +348,7 @@ Response parameters
- required_extra_specs: required_extra_specs - required_extra_specs: required_extra_specs
- extra_specs: extra_specs - extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers - driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1 - snapshot_support: snapshot_support
- os-share-type-access:is_public: os-share-type-access:is_public - os-share-type-access:is_public: os-share-type-access:is_public
- share_type_access:is_public: share_type_access:is_public - share_type_access:is_public: share_type_access:is_public
- name: share_type_name - name: share_type_name
@ -663,10 +663,10 @@ Response parameters
- required_extra_specs: required_extra_specs - required_extra_specs: required_extra_specs
- extra_specs: extra_specs - extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers - driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1 - snapshot_support: snapshot_support
- share_type_access:is_public: share_type_access:is_public_body - share_type_access:is_public: share_type_access:is_public_body
- name: share_type_name - name: share_type_name
- replication_type: replication_type_body - replication_type: replication_type
- mount_snapshot_support: mount_snapshot_support_body - mount_snapshot_support: mount_snapshot_support_body
- revert_to_snapshot_support: revert_to_snapshot_support_body - revert_to_snapshot_support: revert_to_snapshot_support_body
- create_share_from_snapshot_support: create_share_from_snapshot_support_body - create_share_from_snapshot_support: create_share_from_snapshot_support_body

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

@ -140,7 +140,7 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: id_4 - id: share_id_response
- links: links - links: links
- name: name - name: name
- count: count - count: count
@ -208,36 +208,41 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- share_type_name: share_type_name - id: share_id_response
- links: links - size: size_response
- availability_zone: availability_zone - availability_zone: availability_zone
- share_network_id: share_network_id
- export_locations: export_locations
- share_server_id: share_server_id
- snapshot_id: snapshot_id_share_response
- id: id_4
- size: size_2
- share_type: share_type_1
- export_location: export_location
- project_id: project_id
- metadata: metadata
- status: status_16
- progress: progress_share_instance
- 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
- has_replicas: has_replicas
- replication_type: replication_type
- created_at: created_at - created_at: created_at
- status: share_status_response
- name: name
- description: description
- project_id: project_id
- snapshot_id: snapshot_id_shares_response
- share_network_id: share_network_id
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - metadata: metadata
- count: count - share_type: share_type_shares_response
- links: links
- is_public: is_public_shares_response
- share_server_id: share_server_id
- host: host_resource_response
- snapshot_support: snapshot_support_share_capability
- task_state: task_state
- share_type_name: share_type_name
- access_rules_status: access_rules_status
- replication_type: replication_type_share_capability
- has_replicas: has_replicas
- user_id: share_user_id - user_id: share_user_id
- create_share_from_snapshot_support: create_share_from_snapshot_support_share_capability
- revert_to_snapshot_support: revert_to_snapshot_support_share_capability
- share_group_id: share_group_id
- source_share_group_snapshot_member_id: source_share_group_snapshot_member_id
- mount_snapshot_support: mount_snapshot_support_share_capability
- progress: progress_share_instance
- count: count
- volume_type: volume_type_shares_response
- export_location: export_location
- export_locations: export_locations
Response example Response example
---------------- ----------------
@ -281,35 +286,40 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- share_type_name: share_type_name - id: share_id_response
- links: links - size: size_response
- availability_zone: availability_zone_1 - availability_zone: availability_zone
- share_network_id: share_network_id
- export_locations: export_locations
- share_server_id: share_server_id
- snapshot_id: snapshot_id_share_response
- id: id_4
- size: size_2
- share_type: share_type_1
- export_location: export_location
- project_id: project_id
- metadata: metadata
- status: status_16
- progress: progress_share_instance
- 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
- has_replicas: has_replicas
- replication_type: replication_type
- created_at: created_at - created_at: created_at
- status: share_status_response
- name: name
- description: description
- project_id: project_id
- snapshot_id: snapshot_id_shares_response
- share_network_id: share_network_id
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - metadata: metadata
- share_type: share_type_shares_response
- links: links
- is_public: is_public_shares_response
- share_server_id: share_server_id
- host: host_resource_response
- snapshot_support: snapshot_support_share_capability
- task_state: task_state
- share_type_name: share_type_name
- access_rules_status: access_rules_status
- replication_type: replication_type_share_capability
- has_replicas: has_replicas
- user_id: share_user_id - user_id: share_user_id
- create_share_from_snapshot_support: create_share_from_snapshot_support_share_capability
- revert_to_snapshot_support: revert_to_snapshot_support_share_capability
- share_group_id: share_group_id
- source_share_group_snapshot_member_id: source_share_group_snapshot_member_id
- mount_snapshot_support: mount_snapshot_support_share_capability
- progress: progress_share_instance
- count: count
- volume_type: volume_type_shares_response
- export_location: export_location
- export_locations: export_locations
Response example Response example
---------------- ----------------
@ -348,19 +358,18 @@ Request
- project_id: project_id_path - project_id: project_id_path
- share_proto: share_proto - share_proto: share_proto
- size: size - size: size_request
- name: name_request - name: name_request
- description: description_request - description: description_request
- display_name: display_name_request - display_name: display_name_request
- display_description: display_description_request - display_description: display_description_request
- share_type: share_type - share_type: share_type_request
- volume_type: volume_type
- snapshot_id: snapshot_id_request - snapshot_id: snapshot_id_request
- is_public: is_public - is_public: is_public_request
- share_group_id: share_group_id_request - share_group_id: share_group_id_request
- metadata: metadata - metadata: metadata
- share_network_id: share_network_id_2 - share_network_id: share_network_id_request
- availability_zone: availability_zone - availability_zone: availability_zone_request
Request example Request example
--------------- ---------------
@ -373,34 +382,40 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- id: id_4 - id: share_id_response
- status: status_3 - size: size_response
- progress: progress_share_instance - availability_zone: availability_zone
- links: links - created_at: created_at
- project_id: project_id - status: share_status_response
- share_proto: share_proto
- size: size
- name: name - name: name
- description: description - description: description
- share_type: share_type_1 - project_id: project_id
- share_type_name: share_share_type_name - snapshot_id: snapshot_id_shares_response
- has_replicas: has_replicas
- replication_type: replication_type
- volume_type: volume_type
- snapshot_id: snapshot_id_share_response
- is_public: is_public
- share_group_id: share_group_id
- metadata: metadata
- share_network_id: share_network_id - share_network_id: share_network_id
- availability_zone: availability_zone_1 - share_proto: share_proto
- metadata: metadata
- share_type: share_type_shares_response
- links: links
- is_public: is_public_shares_response
- share_server_id: share_server_id
- host: host_resource_response
- snapshot_support: snapshot_support_share_capability
- task_state: task_state
- share_type_name: share_type_name
- access_rules_status: access_rules_status
- replication_type: replication_type_share_capability
- has_replicas: has_replicas
- user_id: share_user_id
- create_share_from_snapshot_support: create_share_from_snapshot_support_share_capability
- revert_to_snapshot_support: revert_to_snapshot_support_share_capability
- share_group_id: share_group_id
- source_share_group_snapshot_member_id: source_share_group_snapshot_member_id
- mount_snapshot_support: mount_snapshot_support_share_capability
- progress: progress_share_instance
- count: count
- volume_type: volume_type_shares_response
- export_location: export_location - export_location: export_location
- export_locations: export_locations - export_locations: export_locations
- host: host_1
- task_state: task_state
- share_server_id: share_server_id
- snapshot_support: snapshot_support
- created_at: created_at
- user_id: share_user_id
Response example Response example
---------------- ----------------
@ -453,12 +468,12 @@ Request
- share: share - share: share
- protocol: protocol - protocol: protocol
- name: name_request - name: name_request
- share_type: share_type_2 - share_type: share_type_request
- driver_options: driver_options - driver_options: driver_options
- export_path: export_path - export_path: export_path
- service_host: service_host - service_host: service_host
- share_server_id: manage_share_server_id - share_server_id: manage_share_server_id
- is_public: is_public - is_public: is_public_manage_request
- description: description_request - description: description_request
Request example Request example
@ -472,34 +487,40 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- share: share - id: share_id_response
- links: links - size: size_response
- availability_zone: availability_zone_1 - availability_zone: availability_zone
- share_network_id: share_network_id
- export_locations: export_locations
- share_server_id: share_server_id
- snapshot_id: snapshot_id_share_response
- id: id_4
- size: size_2
- share_type: share_type_1
- share_type_name: share_share_type_name
- has_replicas: has_replicas
- replication_type: replication_type
- export_location: export_location
- project_id: project_id
- metadata: metadata
- status: status_8
- share_server_id: manage_share_server_id
- description: description
- host: host_9
- is_public: is_public
- share_group_id: share_group_id
- snapshot_support: snapshot_support
- name: name
- created_at: created_at - created_at: created_at
- status: share_status_response
- name: name
- description: description
- project_id: project_id
- snapshot_id: snapshot_id_shares_response
- share_network_id: share_network_id
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - metadata: metadata
- share_type: share_type_shares_response
- links: links
- is_public: is_public_shares_response
- share_server_id: share_server_id
- host: host_resource_response
- snapshot_support: snapshot_support_share_capability
- task_state: task_state
- share_type_name: share_type_name
- access_rules_status: access_rules_status
- replication_type: replication_type_share_capability
- has_replicas: has_replicas
- user_id: managed_share_user_id - user_id: managed_share_user_id
- create_share_from_snapshot_support: create_share_from_snapshot_support_share_capability
- revert_to_snapshot_support: revert_to_snapshot_support_share_capability
- share_group_id: share_group_id
- source_share_group_snapshot_member_id: source_share_group_snapshot_member_id
- mount_snapshot_support: mount_snapshot_support_share_capability
- progress: progress_share_instance
- count: count
- volume_type: volume_type_shares_response
- export_location: export_location
- export_locations: export_locations
Response example Response example
---------------- ----------------
@ -549,7 +570,7 @@ Request
- project_id: project_id_path - project_id: project_id_path
- share_id: share_id - share_id: share_id
- is_public: is_public - is_public: is_public_request
- display_name: display_name_request - display_name: display_name_request
- display_description: display_description_request - display_description: display_description_request
@ -564,34 +585,40 @@ Response parameters
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- share_type_name: share_share_type_name - id: share_id_response
- links: links - size: size_response
- availability_zone: availability_zone_1 - availability_zone: availability_zone
- share_network_id: share_network_id
- export_locations: export_locations
- share_server_id: share_server_id
- snapshot_id: snapshot_id_share_response
- id: id_4
- size: size_2
- share_type: share_type_1
- export_location: export_location
- project_id: project_id
- metadata: metadata
- status: status_16
- 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
- has_replicas: has_replicas
- replication_type: replication_type
- created_at: created_at - created_at: created_at
- status: share_status_response
- name: name
- description: description
- project_id: project_id
- snapshot_id: snapshot_id_shares_response
- share_network_id: share_network_id
- share_proto: share_proto - share_proto: share_proto
- volume_type: volume_type - metadata: metadata
- share_type: share_type_shares_response
- links: links
- is_public: is_public_shares_response
- share_server_id: share_server_id
- host: host_resource_response
- snapshot_support: snapshot_support_share_capability
- task_state: task_state
- share_type_name: share_type_name
- access_rules_status: access_rules_status
- replication_type: replication_type_share_capability
- has_replicas: has_replicas
- user_id: share_user_id - user_id: share_user_id
- create_share_from_snapshot_support: create_share_from_snapshot_support_share_capability
- revert_to_snapshot_support: revert_to_snapshot_support_share_capability
- share_group_id: share_group_id
- source_share_group_snapshot_member_id: source_share_group_snapshot_member_id
- mount_snapshot_support: mount_snapshot_support_share_capability
- progress: progress_share_instance
- count: count
- volume_type: volume_type_shares_response
- export_location: export_location
- export_locations: export_locations
Response example Response example
---------------- ----------------