Api-ref: add show details for share type

Add missing show details for a specified share type
in api ref.

Change-Id: Iffa5cdcb86d9d9d34950fd7e7365b1608f8716bf
This commit is contained in:
junboli 2017-12-31 16:12:06 +08:00
parent 098546fbf4
commit ee11996bf9
3 changed files with 76 additions and 12 deletions

View File

@ -1523,12 +1523,6 @@ host_9:
in: body
required: false
type: string
id_11:
description: |
The UUID of the share type.
in: body
required: true
type: string
id_12:
description: |
The service ID.
@ -2988,9 +2982,9 @@ share_type_description_request:
required: false
type: string
min_version: 2.41
share_type_id_1:
share_type_id_body:
description: |
The share type ID of the member.
The UUID of the share type.
in: body
required: true
type: string

View File

@ -0,0 +1,26 @@
{
"share_type": {
"required_extra_specs": {
"driver_handles_share_servers": "True"
},
"share_type_access:is_public": true,
"extra_specs": {
"driver_handles_share_servers": "True"
},
"id": "2780fc88-526b-464a-a72c-ecb83f0e3929",
"name": "default-share-type",
"description": "manila share type"
},
"volume_type": {
"required_extra_specs": {
"driver_handles_share_servers": "True"
},
"share_type_access:is_public": true,
"extra_specs": {
"driver_handles_share_servers": "True"
},
"id": "2780fc88-526b-464a-a72c-ecb83f0e3929",
"name": "default-share-type",
"description": "manila share type"
}
}

View File

@ -106,7 +106,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id_11
- id: share_type_id_body
- name: share_type_name
- required_extra_specs: required_extra_specs
- extra_specs: extra_specs
@ -149,7 +149,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id_11
- id: share_type_id_body
- required_extra_specs: required_extra_specs
- extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers
@ -165,6 +165,50 @@ Response example
:language: javascript
Show share type detail
======================
.. rest_method:: GET /v2/{tenant_id}/types/{share_type_id}
Shows details for a specified share type.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- share_type_id: share_type_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- id: share_type_id_body
- required_extra_specs: required_extra_specs
- extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers
- snapshot_support: snapshot_support_1
- replication_type: replication_type
- mount_snapshot_support: mount_snapshot_support
- revert_to_snapshot_support: revert_to_snapshot_support
- create_share_from_snapshot_support: create_share_from_snapshot_support
- share_type_access:is_public: share_type_access:is_public
- name: share_type_name
- description: share_type_description
Response Example
----------------
.. literalinclude:: ./samples/share-type-show-response.json
:language: javascript
List extra specs
================
@ -244,7 +288,7 @@ Response parameters
.. rest_parameters:: parameters.yaml
- id: id_11
- id: share_type_id_body
- required_extra_specs: required_extra_specs
- extra_specs: extra_specs
- driver_handles_share_servers: driver_handles_share_servers
@ -291,8 +335,8 @@ Response parameters
.. rest_parameters:: parameters.yaml
- share_type_id: share_type_id_1
- project_id: project_id_9
- share_type_id: share_type_id_body
Response example
----------------