From d88ab3cfa2ecf8125f93e4d0aedc516c30d87636 Mon Sep 17 00:00:00 2001 From: junboli Date: Wed, 22 Nov 2017 13:28:37 +0800 Subject: [PATCH] [Api-ref] update parameters for share types api 1. update share types params 2. correct sample json datas Closes-bug: #1733753 Change-Id: I804b657cf7b189c25f09864e79a74f76a99252bb --- api-ref/source/parameters.yaml | 42 ++++++++++++++--- .../samples/share-type-create-request.json | 10 ++-- .../samples/share-type-create-response.json | 42 ++++++++++------- .../share-types-default-list-response.json | 32 +++++++------ ...share-types-extra-specs-list-response.json | 8 +++- .../samples/share-types-list-response.json | 46 +++++++++++-------- api-ref/source/share-types.inc | 30 +++++++++--- 7 files changed, 141 insertions(+), 69 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index cf5e47cec9..b5c2d1a43c 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -940,6 +940,14 @@ consistent_snapshot_support: required: true type: string min_version: 2.34 +create_share_from_snapshot_support: + description: | + Boolean extra spec used for filtering of back ends by + their capability to create shares from snapshots. + in: body + required: false + type: boolean + min_version: 2.24 created_at_11: description: | The date and time stamp when the share server was created. @@ -1768,6 +1776,14 @@ migration_complete: in: body required: true type: object +mount_snapshot_support: + description: | + Boolean extra spec used for filtering of back ends + by their capability to mount share snapshots. + in: body + required: false + type: boolean + min_version: 2.32 name: description: | The share network name. @@ -1827,12 +1843,6 @@ name_5: in: body required: false type: string -name_9: - description: | - The share type name. - in: body - required: true - type: string network_type: description: | The network type. A valid value is ``VLAN``, @@ -1925,6 +1935,7 @@ os-share-type-access:is_public: in: body required: false type: boolean + max_version: 2.6 path: description: | The export location path that should be used for mout operation. @@ -2218,10 +2229,11 @@ replica_state: type: string replication_type: description: | - (Since API v2.11) The share replication type. + The share replication type. in: body required: false type: string + min_version: 2.11 request_id_body: description: | The UUID of the request during which the message was created. @@ -2260,6 +2272,14 @@ resource_type_body: in: body required: true type: string +revert_to_snapshot_support: + description: | + Boolean extra spec used for filtering of back ends by their + capability to revert shares to snapshots. + in: body + required: false + type: boolean + min_version: 2.27 security_service_created_at: description: | The date and time stamp when the security service was created. @@ -2983,6 +3003,14 @@ share_type_2: in: body required: false type: string +share_type_access:is_public: + description: | + Indicates whether a share type is publicly + accessible. Default is ``true``, or publicly accessible. + in: body + required: false + type: boolean + min_version: 2.7 share_type_id_1: description: | The share type ID of the member. diff --git a/api-ref/source/samples/share-type-create-request.json b/api-ref/source/samples/share-type-create-request.json index de6af3a618..e64cd0049a 100644 --- a/api-ref/source/samples/share-type-create-request.json +++ b/api-ref/source/samples/share-type-create-request.json @@ -1,10 +1,14 @@ { - "volume_type": { - "os-share-type-access:is_public": true, + "share_type": { "extra_specs": { + "replication_type": "readable", "driver_handles_share_servers": true, + "mount_snapshot_support": false, + "revert_to_snapshot_support": false, + "create_share_from_snapshot_support": true, "snapshot_support": true }, - "name": "my_new_volume_type" + "share_type_access:is_public": true, + "name": "testing" } } diff --git a/api-ref/source/samples/share-type-create-response.json b/api-ref/source/samples/share-type-create-response.json index 12e0911042..638e5d5162 100644 --- a/api-ref/source/samples/share-type-create-response.json +++ b/api-ref/source/samples/share-type-create-response.json @@ -1,26 +1,34 @@ { - "volume_type": { - "os-share-type-access:is_public": true, - "required_extra_specs": { - "driver_handles_share_servers": true - }, - "extra_specs": { - "snapshot_support": "True", - "driver_handles_share_servers": "True" - }, - "name": "my_new_volume_type", - "id": "1d600d02-26a7-4b23-af3d-7d51860fe858" - }, "share_type": { - "os-share-type-access:is_public": true, "required_extra_specs": { "driver_handles_share_servers": true }, + "share_type_access:is_public": true, "extra_specs": { - "snapshot_support": "True", - "driver_handles_share_servers": "True" + "replication_type": "readable", + "driver_handles_share_servers": "True", + "mount_snapshot_support": "False", + "revert_to_snapshot_support": "False", + "create_share_from_snapshot_support": "True", + "snapshot_support": "True" }, - "name": "my_new_volume_type", - "id": "1d600d02-26a7-4b23-af3d-7d51860fe858" + "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", + "name": "testing" + }, + "volume_type": { + "required_extra_specs": { + "driver_handles_share_servers": true + }, + "share_type_access:is_public": true, + "extra_specs": { + "replication_type": "readable", + "driver_handles_share_servers": "True", + "mount_snapshot_support": "False", + "revert_to_snapshot_support": "False", + "create_share_from_snapshot_support": "True", + "snapshot_support": "True" + }, + "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", + "name": "testing" } } diff --git a/api-ref/source/samples/share-types-default-list-response.json b/api-ref/source/samples/share-types-default-list-response.json index bd3060ead2..d7094c5344 100644 --- a/api-ref/source/samples/share-types-default-list-response.json +++ b/api-ref/source/samples/share-types-default-list-response.json @@ -1,20 +1,24 @@ { - "volume_type": { - "required_extra_specs": null, - "extra_specs": { - "snapshot_support": "True", - "driver_handles_share_servers": "True" - }, - "name": "default", - "id": "be27425c-f807-4500-a056-d00721db45cf" - }, "share_type": { - "required_extra_specs": null, - "extra_specs": { - "snapshot_support": "True", + "required_extra_specs": { "driver_handles_share_servers": "True" }, - "name": "default", - "id": "be27425c-f807-4500-a056-d00721db45cf" + "share_type_access:is_public": true, + "extra_specs": { + "driver_handles_share_servers": "True" + }, + "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", + "name": "default" + }, + "volume_type": { + "required_extra_specs": { + "driver_handles_share_servers": "True" + }, + "share_type_access:is_public": true, + "extra_specs": { + "driver_handles_share_servers": "True" + }, + "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", + "name": "default" } } diff --git a/api-ref/source/samples/share-types-extra-specs-list-response.json b/api-ref/source/samples/share-types-extra-specs-list-response.json index 9752fe43ea..f498c05f0d 100644 --- a/api-ref/source/samples/share-types-extra-specs-list-response.json +++ b/api-ref/source/samples/share-types-extra-specs-list-response.json @@ -1,6 +1,10 @@ { "extra_specs": { - "snapshot_support": "True", - "driver_handles_share_servers": "True" + "replication_type": "readable", + "driver_handles_share_servers": "True", + "create_share_from_snapshot_support": "True", + "revert_to_snapshot_support": "False", + "mount_snapshot_support": "False", + "snapshot_support": "True" } } diff --git a/api-ref/source/samples/share-types-list-response.json b/api-ref/source/samples/share-types-list-response.json index 412e893daa..9135ea41cd 100644 --- a/api-ref/source/samples/share-types-list-response.json +++ b/api-ref/source/samples/share-types-list-response.json @@ -1,54 +1,60 @@ { "volume_types": [ { - "os-share-type-access:is_public": true, "required_extra_specs": { "driver_handles_share_servers": "True" }, + "share_type_access:is_public": true, "extra_specs": { - "snapshot_support": "True", "driver_handles_share_servers": "True" }, - "name": "default", - "id": "be27425c-f807-4500-a056-d00721db45cf" + "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", + "name": "default" }, { - "os-share-type-access:is_public": true, "required_extra_specs": { - "driver_handles_share_servers": "false" + "driver_handles_share_servers": "True" }, + "share_type_access:is_public": true, "extra_specs": { - "snapshot_support": "True", - "driver_handles_share_servers": "false" + "replication_type": "readable", + "driver_handles_share_servers": "True", + "mount_snapshot_support": "False", + "revert_to_snapshot_support": "False", + "create_share_from_snapshot_support": "True", + "snapshot_support": "True" }, - "name": "d", - "id": "f015bebe-c38b-4c49-8832-00143b10253b" + "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", + "name": "testing" } ], "share_types": [ { - "os-share-type-access:is_public": true, "required_extra_specs": { "driver_handles_share_servers": "True" }, + "share_type_access:is_public": true, "extra_specs": { - "snapshot_support": "True", "driver_handles_share_servers": "True" }, - "name": "default", - "id": "be27425c-f807-4500-a056-d00721db45cf" + "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", + "name": "default" }, { - "os-share-type-access:is_public": true, "required_extra_specs": { - "driver_handles_share_servers": "false" + "driver_handles_share_servers": "True" }, + "share_type_access:is_public": true, "extra_specs": { - "snapshot_support": "True", - "driver_handles_share_servers": "false" + "replication_type": "readable", + "driver_handles_share_servers": "True", + "mount_snapshot_support": "False", + "revert_to_snapshot_support": "False", + "create_share_from_snapshot_support": "True", + "snapshot_support": "True" }, - "name": "d", - "id": "f015bebe-c38b-4c49-8832-00143b10253b" + "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", + "name": "testing" } ] } diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index 79512004c1..d44d4fa006 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -107,12 +107,16 @@ Response parameters .. rest_parameters:: parameters.yaml - id: id_11 + - name: share_type_name - required_extra_specs: required_extra_specs - extra_specs: extra_specs - driver_handles_share_servers: driver_handles_share_servers + - replication_type: replication_type - snapshot_support: snapshot_support_1 - - os-share-type-access:is_public: os-share-type-access:is_public - - name: name_9 + - mount_snapshot_support: mount_snapshot_support + - revert_to_snapshot_support: revert_to_snapshot_support + - share_type_access:is_public: share_type_access:is_public + - create_share_from_snapshot_support: create_share_from_snapshot_support Response example ---------------- @@ -149,8 +153,8 @@ Response parameters - extra_specs: extra_specs - driver_handles_share_servers: driver_handles_share_servers - snapshot_support: snapshot_support_1 - - os-share-type-access:is_public: os-share-type-access:is_public - - name: name_9 + - share_type_access:is_public: share_type_access:is_public + - name: share_type_name Response example ---------------- @@ -186,6 +190,10 @@ Response parameters - 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 Response example ---------------- @@ -210,12 +218,17 @@ Request .. rest_parameters:: parameters.yaml + - tenant_id: tenant_id_path - extra_specs: extra_specs - driver_handles_share_servers: driver_handles_share_servers - snapshot_support: snapshot_support_1 - os-share-type-access:is_public: os-share-type-access:is_public - - name: name_9 + - name: share_type_name + - 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 Request example --------------- @@ -234,7 +247,12 @@ Response parameters - driver_handles_share_servers: driver_handles_share_servers - snapshot_support: snapshot_support_1 - os-share-type-access:is_public: os-share-type-access:is_public - - name: name_9 + - share_type_access:is_public: share_type_access:is_public + - name: share_type_name + - 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 Response example ----------------