From 470e76d6b3ffe205f4193ba616bf3e9941e0a527 Mon Sep 17 00:00:00 2001 From: zhongjun Date: Wed, 22 Nov 2017 17:27:13 +0800 Subject: [PATCH] Add 'description' in share type API Doc Add attr 'description' in list/create share type API Doc. Depends-On: I39705acbfca812b66d74fbd2fee228a7a85bc2d8 Change-Id: I49705acbfca812b66d74fbd2fee228a7a85bc2d7 Partial-Bug: #1724183 --- api-ref/source/parameters.yaml | 14 ++++++++++++++ .../source/samples/share-type-create-request.json | 3 ++- .../source/samples/share-type-create-response.json | 6 ++++-- .../samples/share-types-default-list-response.json | 6 ++++-- .../source/samples/share-types-list-response.json | 12 ++++++++---- api-ref/source/share-types.inc | 4 ++++ 6 files changed, 36 insertions(+), 9 deletions(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index b5c2d1a43c..1ffee76924 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -3011,6 +3011,20 @@ share_type_access:is_public: required: false type: boolean min_version: 2.7 +share_type_description: + description: | + The description of the share type. + in: body + required: true + type: string + min_version: 2.41 +share_type_description_request: + description: | + The description of the share type. + in: body + required: false + type: string + min_version: 2.41 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 e64cd0049a..1b42e51c32 100644 --- a/api-ref/source/samples/share-type-create-request.json +++ b/api-ref/source/samples/share-type-create-request.json @@ -9,6 +9,7 @@ "snapshot_support": true }, "share_type_access:is_public": true, - "name": "testing" + "name": "testing", + "description": "share type description" } } diff --git a/api-ref/source/samples/share-type-create-response.json b/api-ref/source/samples/share-type-create-response.json index 638e5d5162..a5add19450 100644 --- a/api-ref/source/samples/share-type-create-response.json +++ b/api-ref/source/samples/share-type-create-response.json @@ -13,7 +13,8 @@ "snapshot_support": "True" }, "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", - "name": "testing" + "name": "testing", + "description": "share type description" }, "volume_type": { "required_extra_specs": { @@ -29,6 +30,7 @@ "snapshot_support": "True" }, "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", - "name": "testing" + "name": "testing", + "description": "share type description" } } 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 d7094c5344..3d2773b871 100644 --- a/api-ref/source/samples/share-types-default-list-response.json +++ b/api-ref/source/samples/share-types-default-list-response.json @@ -8,7 +8,8 @@ "driver_handles_share_servers": "True" }, "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", - "name": "default" + "name": "default", + "description": "share type description" }, "volume_type": { "required_extra_specs": { @@ -19,6 +20,7 @@ "driver_handles_share_servers": "True" }, "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", - "name": "default" + "name": "default", + "description": "share type description" } } diff --git a/api-ref/source/samples/share-types-list-response.json b/api-ref/source/samples/share-types-list-response.json index 9135ea41cd..ac745a1417 100644 --- a/api-ref/source/samples/share-types-list-response.json +++ b/api-ref/source/samples/share-types-list-response.json @@ -9,7 +9,8 @@ "driver_handles_share_servers": "True" }, "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", - "name": "default" + "name": "default", + "description": "share type description" }, { "required_extra_specs": { @@ -25,7 +26,8 @@ "snapshot_support": "True" }, "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", - "name": "testing" + "name": "testing", + "description": "share type description" } ], "share_types": [ @@ -38,7 +40,8 @@ "driver_handles_share_servers": "True" }, "id": "420e6a31-3f3d-4ed7-9d11-59450372182a", - "name": "default" + "name": "default", + "description": "share type description" }, { "required_extra_specs": { @@ -54,7 +57,8 @@ "snapshot_support": "True" }, "id": "7fa1342b-de9d-4d89-bdc8-af67795c0e52", - "name": "testing" + "name": "testing", + "description": "share type description" } ] } diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index d44d4fa006..cc2b0d42ab 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -117,6 +117,7 @@ Response parameters - 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 + - description: share_type_description Response example ---------------- @@ -155,6 +156,7 @@ Response parameters - snapshot_support: snapshot_support_1 - share_type_access:is_public: share_type_access:is_public - name: share_type_name + - description: share_type_description Response example ---------------- @@ -229,6 +231,7 @@ Request - mount_snapshot_support: mount_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support - create_share_from_snapshot_support: create_share_from_snapshot_support + - description: share_type_description_request Request example --------------- @@ -253,6 +256,7 @@ Response parameters - mount_snapshot_support: mount_snapshot_support - revert_to_snapshot_support: revert_to_snapshot_support - create_share_from_snapshot_support: create_share_from_snapshot_support + - description: share_type_description Response example ----------------