From 2eab5de88580bffcd57ed2befd0f73e1dc25ff1c Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Fri, 12 Feb 2021 18:17:24 -0800 Subject: [PATCH] [api-ref] Fix incorrect parameters Some of the response parameters for the /shares APIs were either incorrect or out of date. These inconsistencies were discovered by Ashley Rodriguez when working on the openstacksdk integration for these APIs. Change-Id: I475a7e4df2ee6924699b97c196f1958d4885c01d Signed-off-by: Goutham Pacha Ravi --- api-ref/source/os-share-manage.inc | 22 +- api-ref/source/parameters.yaml | 403 +++++++++++------------ api-ref/source/share-actions.inc | 2 +- api-ref/source/share-groups.inc | 10 +- api-ref/source/share-instances.inc | 22 +- api-ref/source/share-network-subnets.inc | 2 +- api-ref/source/share-networks.inc | 14 +- api-ref/source/share-servers.inc | 8 +- api-ref/source/share-types.inc | 16 +- api-ref/source/shares.inc | 297 +++++++++-------- 10 files changed, 402 insertions(+), 394 deletions(-) diff --git a/api-ref/source/os-share-manage.inc b/api-ref/source/os-share-manage.inc index 97601d01a7..10eda4096c 100644 --- a/api-ref/source/os-share-manage.inc +++ b/api-ref/source/os-share-manage.inc @@ -51,11 +51,10 @@ Request - protocol: protocol - name: name_request - display_name: display_name_request - - share_type: share_type_2 + - share_type: share_type_request - driver_options: driver_options - export_path: export_path - service_host: service_host - - is_public: is_public - description: description_request - display_description: display_description_request @@ -72,29 +71,26 @@ Response parameters - share: share - links: links - - 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 + - snapshot_id: snapshot_id_shares_response + - id: share_id_response + - size: size_response + - share_type: share_type_shares_response - share_type_name: share_type_name - - has_replicas: has_replicas - - replication_type: replication_type - export_location: export_location - project_id: project_id - metadata: metadata - - status: status_8 + - status: share_status_response - description: description - - host: host_1 - - is_public: is_public + - host: host_resource_response + - is_public: is_public_shares_response - snapshot_support: snapshot_support - name: name - created_at: created_at - share_proto: share_proto - - volume_type: volume_type Response example ---------------- diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 2387d58520..5b095e9d5f 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -476,12 +476,8 @@ source_share_group_snapshot_id_query: min_version: 2.31 status_query: description: | - Filters by a share status. A valid value is - ``creating``, ``creating_from_snapshot``, ``error``, ``available``, - ``deleting``, ``error_deleting``, ``manage_starting``, ``manage_error``, - ``unmanage_starting``, ``unmanage_error``, ``migrating``, - ``extending``, ``extending_error``, ``shrinking``, - ``shrinking_error``, or ``shrinking_possible_data_loss_error``. + Filters by a share status. For valid statuses, see the `section + above <#shares>`_. in: query required: false type: string @@ -526,8 +522,10 @@ access_level: description: | The access level to the share. To grant or deny access to a share, you specify one of the following share access - levels: - ``rw``. Read and write (RW) access. - ``ro``. Read- - only (RO) access. + levels: + + - ``rw``. Read and write (RW) access. + - ``ro``. Read-only (RO) access. in: body required: true type: string @@ -567,13 +565,6 @@ access_share_id: in: body required: true type: string -access_status: - description: | - The share access status, which is ``new``, - ``error``, ``active``. - in: body - required: true - type: string access_to: description: | The value that defines the access. The back end @@ -638,26 +629,19 @@ allow_access: type: object availability_zone: description: | - The availability zone. - in: body - required: false - type: string - min_version: 2.1 -availability_zone_1: - description: | - The availability zone. + The name of the availability zone the share exists within. in: body required: true type: string availability_zone_id: description: | - The availability zone ID. + The availability zone ID the resource exists within. in: body required: true type: string -availability_zone_id_2: +availability_zone_id_share_group: description: | - The availability zone ID for create share group. + The availability zone ID that the share group exists within. in: body required: true type: string @@ -670,7 +654,7 @@ availability_zone_name: type: string availability_zone_request: 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 required: false type: string @@ -689,8 +673,8 @@ backend: backend_details: description: | The back-end details for a server. Each back end - can store any key- value information that it requires. For - example, the generic back- end driver might store the router ID. + can store any key-value information that it requires. For + example, the generic back-end driver might store the router ID. in: body required: true type: object @@ -703,9 +687,11 @@ backend_host: backend_name: 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. + ``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 @@ -738,7 +724,7 @@ capability_driver_version: capability_free_capacity_gb: description: | 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. in: body required: true @@ -790,7 +776,7 @@ capability_storage_protocol: type: string capability_total_capacity_gb: 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. in: body required: true @@ -820,7 +806,9 @@ consistent_snapshot_support: min_version: 2.34 count: 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 required: false type: integer @@ -840,6 +828,15 @@ create_share_from_snapshot_support_body: in: body required: false 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: description: | The date and time stamp when the resource was created within the service's @@ -925,9 +922,9 @@ export_location: The export location. For newer API versions it is available in separate APIs. See sections `Share export locations <#share-share-export-locations>`_ and `Share instance export - locations <#share-share-instance-export- locations>`_. + locations <#share-share-instance-export-locations>`_. in: body - required: false + required: true type: string max_version: 2.8 export_location_availability_zone: @@ -991,18 +988,19 @@ export_locations: locations. For newer API versions it is available in separate APIs. See sections `Share export locations <#share-share-export-locations>`_ and `Share instance export locations <#share-share-instance- - export- locations>`_. + export-locations>`_. in: body - required: false + required: true type: array max_version: 2.8 export_path: description: | The share export path in the format appropriate - for the protocol: - NFS protocol. ``10.0.0.1:/foo_path``. For - example, ``10.254.0.5:/shares/share-42033c24-0261-424f-abda- - 4fef2f6dbfd5``. - CIFS protocol. - ``\\10.0.0.1\foo_name_of_cifs_share``. + for the protocol: + + - NFS protocol. ``10.0.0.1:/foo_path``. For example, ``10.254.0 + .5:/shares/share-42033c24-0261-424f-abda-4fef2f6dbfd5``. + - CIFS protocol. For example, ``\\10.0.0.1\foo_name_of_cifs_share``. in: body required: true type: string @@ -1147,34 +1145,14 @@ host: in: body required: true type: string -host_1: +host_resource_response: 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 required: true 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: description: | The share server host name or IP address. @@ -1187,12 +1165,6 @@ id_13: in: body required: true type: string -id_4: - description: | - The UUID of the share. - in: body - required: true - type: string identifier: description: | The identifier of the share server in the back-end storage system. @@ -1243,26 +1215,42 @@ is_group_type_default: required: true type: boolean min_version: 2.46 -is_public: +is_public_manage_request: description: | The level of visibility for the share. Set to ``true`` to make - share public. Set to ``false`` to make it private. Default value - is ``false``. + 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 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: description: | - The share links + Pagination and bookmark links for the resource. in: body required: true type: array manage_host: description: | 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 required: true type: string @@ -1421,7 +1409,7 @@ metadata: One or more metadata key and value pairs as a dictionary of strings. in: body - required: false + required: true type: object metadata_2: description: | @@ -1495,6 +1483,15 @@ mount_snapshot_support_body: in: body required: false 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: description: | The user defined name of the resource. @@ -1952,17 +1949,31 @@ replica_state: min_version: 2.11 replication_type: 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 required: false 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 -replication_type_body: - description: | - The share replication type. - in: body - required: false - type: string request_id_body: description: | The UUID of the request during which the message was created. @@ -2009,6 +2020,15 @@ revert_to_snapshot_support_body: in: body required: false 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: description: | The DNS IP address that is used inside the project network. @@ -2184,9 +2204,11 @@ service_enable_host_response: service_host: description: | The manage-share service host 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. + ``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 @@ -2316,10 +2338,15 @@ share_group_type_name_request: in: body required: false type: string -share_id_2: +share_id_response: description: | - The UUID of the share from which the share - instance was created. + The UUID of the share. + 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 required: true type: string @@ -2354,34 +2381,31 @@ share_network_gateway: max_version: 2.50 share_network_id: description: | - The share network ID. + The share network ID where the resource is exported to. in: body required: true type: string -share_network_id_1: +share_network_id_manage_server_request: description: | - The ID of a share network. 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_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. + The UUID of the share network that the share server will pertain to. in: body required: true 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: | The UUID of a share network that is associated with the share server. @@ -2524,7 +2548,7 @@ share_network_subnet_share_network_name: type: string share_new_size: description: | - New size of the share, in GBs. + New size of the share, in GiBs. in: body required: true type: integer @@ -2650,29 +2674,19 @@ share_share_type_name: required: true type: string min_version: 2.6 -share_type: +share_status_request: description: | - The share type name. 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. - 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. + The share or share instance status to be set. Possible values are listed in + the `section above <#shares>`_. in: body required: true type: string - min_version: 2.6 -share_type_2: +share_status_response: description: | - The share type name. + The share or share instance status. Possible values are listed in + the `section above <#shares>`_. in: body - required: false + required: true type: string share_type_access:is_public: description: | @@ -2743,6 +2757,24 @@ share_type_name_request: in: body required: false 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: description: | A list of one or more share type IDs. @@ -2774,17 +2806,17 @@ shrink: in: body required: true type: object -size: +size_request: description: | - The share size, in GBs. The requested share size - cannot be greater than the allowed GB quota. To view the allowed - quota, issue a get limits request. + The share size, in GiBs. The requested share size cannot be greater than + the allowed GiB quota. To view the allowed quota, issue a get limits + request. in: body required: true type: integer -size_2: +size_response: description: | - The share size, in GBs. + The share size, in GiBs. in: body required: true type: integer @@ -2808,7 +2840,7 @@ snapshot_id_request: in: body required: false type: string -snapshot_id_share_response: +snapshot_id_shares_response: description: | The UUID of the snapshot that was used to create the share. @@ -2895,13 +2927,13 @@ snapshot_share_protocol: type: string snapshot_share_size: description: | - The share snapshot size, in GBs. + The share snapshot size, in GiBs. in: body required: true type: integer snapshot_size: description: | - The snapshot size, in GBs. + The snapshot size, in GiBs. in: body required: true type: integer @@ -2931,13 +2963,14 @@ snapshot_support: required: true type: boolean min_version: 2.2 -snapshot_support_1: +snapshot_support_share_capability: description: | - An extra specification that filters back ends by - whether they do or do not support share snapshots. + Whether or not this share supports snapshots. Snapshots are point in + time backups of the share. in: body - required: false + required: true type: boolean + min_version: 2.2 snapshot_unmanage: description: | To unmanage a share snapshot, include this parameter and set its value to @@ -2966,6 +2999,13 @@ source_share_group_snapshot_id_response: in: body required: true 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: description: | Prior to versions 2.28, the state of all access rules of a given share @@ -2978,68 +3018,6 @@ state: in: body required: true 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: description: | The share server status, which is ``active``, @@ -3053,8 +3031,7 @@ task_state: value is ``null``, ``migration_starting``, ``migration_error``, ``migration_success``, ``migration_completing``, or ``migrating``. The ``task_state`` is ``null`` unless the share is migrated from - one back-end to another. For details, see ``os-migrate_share`` - extension request. + one back-end to another. in: body required: true type: string @@ -3278,6 +3255,14 @@ volume_type: in: body required: false 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: description: | Specifies whether migration should only be performed diff --git a/api-ref/source/share-actions.inc b/api-ref/source/share-actions.inc index b178583205..2fbc226a2a 100644 --- a/api-ref/source/share-actions.inc +++ b/api-ref/source/share-actions.inc @@ -271,7 +271,7 @@ Request - project_id: project_id_path - share_id: share_id - reset_status: reset_status - - status: access_status + - status: share_status_request Request example diff --git a/api-ref/source/share-groups.inc b/api-ref/source/share-groups.inc index 86df3c6d44..dbcd62c242 100644 --- a/api-ref/source/share-groups.inc +++ b/api-ref/source/share-groups.inc @@ -135,7 +135,7 @@ Response parameters - share_network_id: share_network_id - share_types: share_types_1 - links: share_group_links - - availability_zone: availability_zone_id_2 + - availability_zone: availability_zone_id_share_group - consistent_snapshot_support: consistent_snapshot_support Response example @@ -180,9 +180,9 @@ Request - description: description_request - share_types: share_types - 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 - - availability_zone: availability_zone_id_2 + - availability_zone: availability_zone_id_share_group Request example --------------- @@ -207,7 +207,7 @@ Response parameters - share_network_id: share_network_id - share_types: share_types_1 - links: share_group_links - - availability_zone: availability_zone_id_2 + - availability_zone: availability_zone_id_share_group - consistent_snapshot_support: consistent_snapshot_support Response example @@ -319,7 +319,7 @@ Response parameters - share_network_id: share_network_id - share_types: share_types_1 - links: share_group_links - - availability_zone: availability_zone_id_2 + - availability_zone: availability_zone_id_share_group - consistent_snapshot_support: consistent_snapshot_support Response example diff --git a/api-ref/source/share-instances.inc b/api-ref/source/share-instances.inc index 8001a85fcf..cdf17997e8 100644 --- a/api-ref/source/share-instances.inc +++ b/api-ref/source/share-instances.inc @@ -45,19 +45,19 @@ Response parameters .. rest_parameters:: parameters.yaml - - status: status_5 + - status: share_status_response - access_rules_status: access_rules_status - - share_id: share_id_2 + - share_id: share_id_share_instances_response - progress: progress_share_instance - - availability_zone: availability_zone_1 + - availability_zone: availability_zone - created_at: created_at - replica_state: replica_state - export_location: export_location - export_locations: export_locations - 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 - - host: host_6 + - host: host_resource_response - id: id_13 Response example @@ -103,19 +103,19 @@ Response parameters .. rest_parameters:: parameters.yaml - - status: status_5 + - status: share_status_response - access_rules_status: access_rules_status - - share_id: share_id_2 + - share_id: share_id_share_instances_response - progress: progress_share_instance - - availability_zone: availability_zone_1 + - availability_zone: availability_zone - created_at: created_at - replica_state: replica_state - export_location: export_location - export_locations: export_locations - 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 - - host: host_6 + - host: host_resource_response - id: id_13 Response example @@ -158,7 +158,7 @@ Request - project_id: project_id_path - share_instance_id: share_instance_id - - status: status_5 + - status: share_status_request Request example --------------- diff --git a/api-ref/source/share-network-subnets.inc b/api-ref/source/share-network-subnets.inc index 74edb0d4b2..8462103815 100644 --- a/api-ref/source/share-network-subnets.inc +++ b/api-ref/source/share-network-subnets.inc @@ -202,7 +202,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_subnet_id - neutron_net_id: share_network_subnet_neutron_net_id - neutron_subnet_id: share_network_subnet_neutron_subnet_id - network_type: share_network_subnet_network_type diff --git a/api-ref/source/share-networks.inc b/api-ref/source/share-networks.inc index d5818da19c..9ffc3953e0 100644 --- a/api-ref/source/share-networks.inc +++ b/api-ref/source/share-networks.inc @@ -76,7 +76,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_id_share_networks_response - name: name Response example @@ -122,7 +122,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_id_share_networks_response - project_id: project_id - neutron_net_id: neutron_net_id - neutron_subnet_id: neutron_subnet_id @@ -184,7 +184,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_id_share_networks_response - project_id: project_id - neutron_net_id: neutron_net_id - neutron_subnet_id: neutron_subnet_id @@ -268,7 +268,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_id_share_networks_response - project_id: project_id - neutron_net_id: neutron_net_id - neutron_subnet_id: neutron_subnet_id @@ -342,7 +342,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_id_share_networks_response - project_id: project_id - neutron_net_id: neutron_net_id - neutron_subnet_id: neutron_subnet_id @@ -413,7 +413,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_id_share_networks_response - project_id: project_id - neutron_net_id: neutron_net_id - neutron_subnet_id: neutron_subnet_id @@ -492,7 +492,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: share_network_id + - id: share_network_id_share_networks_response - project_id: project_id - neutron_net_id: neutron_net_id - neutron_subnet_id: neutron_subnet_id diff --git a/api-ref/source/share-servers.inc b/api-ref/source/share-servers.inc index e106a4ed5e..da5d838332 100644 --- a/api-ref/source/share-servers.inc +++ b/api-ref/source/share-servers.inc @@ -75,7 +75,7 @@ Response parameters - id: share_server_id - project_id: project_id - 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 - host: host_share_server_body - updated_at: updated_at @@ -126,7 +126,7 @@ Response parameters - project_id: project_id - status: status_share_server_body - 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 - host: host_share_server_body - created_at: created_at @@ -252,7 +252,7 @@ Request - project_id: project_id_path - host: manage_host - identifier: identifier - - share_network: share_network_id + - share_network: share_network_id_manage_server_request - driver_options: driver_options - share_network_subnet_id: share_network_subnet_id_manage_server_request @@ -273,7 +273,7 @@ Response parameters - status: share_server_status - host: manage_host - 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 - backend_details: backend_details - is_auto_deletable: is_auto_deletable diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index 0a0d6397c7..783149b8b2 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -124,7 +124,7 @@ Response parameters - extra_specs: extra_specs - driver_handles_share_servers: driver_handles_share_servers - replication_type: replication_type - - snapshot_support: snapshot_support_1 + - snapshot_support: snapshot_support - mount_snapshot_support: mount_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support - share_type_access:is_public: share_type_access:is_public @@ -176,7 +176,7 @@ Response parameters - required_extra_specs: required_extra_specs - extra_specs: extra_specs - 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 - name: share_type_name - description: share_type_description @@ -227,7 +227,7 @@ Response Parameters - required_extra_specs: required_extra_specs - extra_specs: extra_specs - driver_handles_share_servers: driver_handles_share_servers - - snapshot_support: snapshot_support_1 + - snapshot_support: snapshot_support - replication_type: replication_type - mount_snapshot_support: mount_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support @@ -280,7 +280,7 @@ Response parameters - extra_specs: extra_specs - driver_handles_share_servers: driver_handles_share_servers - - snapshot_support: snapshot_support_1 + - snapshot_support: snapshot_support - replication_type: replication_type - mount_snapshot_support: mount_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support @@ -324,7 +324,7 @@ Request - project_id: project_id_path - extra_specs: extra_specs - 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 - name: share_type_name_request - replication_type: replication_type @@ -348,7 +348,7 @@ Response parameters - required_extra_specs: required_extra_specs - extra_specs: extra_specs - 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 - share_type_access:is_public: share_type_access:is_public - name: share_type_name @@ -663,10 +663,10 @@ Response parameters - required_extra_specs: required_extra_specs - extra_specs: extra_specs - 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 - name: share_type_name - - replication_type: replication_type_body + - replication_type: replication_type - mount_snapshot_support: mount_snapshot_support_body - revert_to_snapshot_support: revert_to_snapshot_support_body - create_share_from_snapshot_support: create_share_from_snapshot_support_body diff --git a/api-ref/source/shares.inc b/api-ref/source/shares.inc index 4b0cd83881..33e907814e 100644 --- a/api-ref/source/shares.inc +++ b/api-ref/source/shares.inc @@ -140,7 +140,7 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: id_4 + - id: share_id_response - links: links - name: name - count: count @@ -208,36 +208,41 @@ Response parameters .. rest_parameters:: parameters.yaml - - share_type_name: share_type_name - - links: links + - id: share_id_response + - size: size_response - 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 + - 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 - - volume_type: volume_type - - count: count + - 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_locations: export_locations + Response example ---------------- @@ -281,35 +286,40 @@ Response parameters .. rest_parameters:: parameters.yaml - - share_type_name: share_type_name - - links: links - - availability_zone: availability_zone_1 - - 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 + - id: share_id_response + - size: size_response + - availability_zone: availability_zone - 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 - - 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 + - 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 ---------------- @@ -348,19 +358,18 @@ Request - project_id: project_id_path - share_proto: share_proto - - size: size + - size: size_request - name: name_request - description: description_request - display_name: display_name_request - display_description: display_description_request - - share_type: share_type - - volume_type: volume_type + - share_type: share_type_request - snapshot_id: snapshot_id_request - - is_public: is_public + - is_public: is_public_request - share_group_id: share_group_id_request - metadata: metadata - - share_network_id: share_network_id_2 - - availability_zone: availability_zone + - share_network_id: share_network_id_request + - availability_zone: availability_zone_request Request example --------------- @@ -373,34 +382,40 @@ Response parameters .. rest_parameters:: parameters.yaml - - id: id_4 - - status: status_3 - - progress: progress_share_instance - - links: links - - project_id: project_id - - share_proto: share_proto - - size: size + - id: share_id_response + - size: size_response + - availability_zone: availability_zone + - created_at: created_at + - status: share_status_response - name: name - description: description - - share_type: share_type_1 - - share_type_name: share_share_type_name - - 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 + - project_id: project_id + - snapshot_id: snapshot_id_shares_response - 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_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 ---------------- @@ -453,12 +468,12 @@ Request - share: share - protocol: protocol - name: name_request - - share_type: share_type_2 + - share_type: share_type_request - driver_options: driver_options - export_path: export_path - service_host: service_host - share_server_id: manage_share_server_id - - is_public: is_public + - is_public: is_public_manage_request - description: description_request Request example @@ -472,34 +487,40 @@ Response parameters .. rest_parameters:: parameters.yaml - - share: share - - links: links - - availability_zone: availability_zone_1 - - 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 + - id: share_id_response + - size: size_response + - availability_zone: availability_zone - 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 - - 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 + - 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 ---------------- @@ -549,7 +570,7 @@ Request - project_id: project_id_path - share_id: share_id - - is_public: is_public + - is_public: is_public_request - display_name: display_name_request - display_description: display_description_request @@ -564,34 +585,40 @@ Response parameters .. rest_parameters:: parameters.yaml - - share_type_name: share_share_type_name - - links: links - - availability_zone: availability_zone_1 - - 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 + - id: share_id_response + - size: size_response + - availability_zone: availability_zone - 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 - - 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 + - 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 ----------------