From 311b89ce1fa9ff5fc32f9d15b30f495437ebe47f Mon Sep 17 00:00:00 2001
From: zhufl <zhu.fanglei@zte.com.cn>
Date: Wed, 21 Aug 2019 15:36:24 +0800
Subject: [PATCH] [api-ref]Fix response example file of update_type

The response sample of "Update a volume type" interface refers to
that of "Show volume type detail", which is not the same.
So this is to add a functional test to generate the update volume
type response sample of "Update a volume type" own.

https://docs.openstack.org/api-ref/block-storage/v3/index.html#update-a-volume-type

Change-Id: I4e5bc87c6ab20ef6b85e0511d3965e7b1f4893ca
partially-implements: blueprint volume-response-schema-validation
---
 .../volume_type/volume-type-update-response.json      | 11 +++++++++++
 api-ref/source/v3/volumes-v3-types.inc                |  2 +-
 .../volume_type/volume-type-update-request.json.tpl   |  7 +++++++
 .../volume_type/volume-type-update-response.json.tpl  | 11 +++++++++++
 .../functional/api_sample_tests/test_volume_types.py  |  8 ++++++++
 5 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 api-ref/source/v3/samples/volume_type/volume-type-update-response.json
 create mode 100644 cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-request.json.tpl
 create mode 100644 cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-response.json.tpl

diff --git a/api-ref/source/v3/samples/volume_type/volume-type-update-response.json b/api-ref/source/v3/samples/volume_type/volume-type-update-response.json
new file mode 100644
index 00000000000..9696f36261f
--- /dev/null
+++ b/api-ref/source/v3/samples/volume_type/volume-type-update-response.json
@@ -0,0 +1,11 @@
+{
+    "volume_type": {
+        "id": "6685584b-1eac-4da6-b5c3-555430cf68ff",
+        "name": "vol-type-001",
+        "description": "volume type 0001",
+        "is_public": true,
+        "extra_specs": {
+            "capabilities": "gpu"
+        }
+    }
+}
diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc
index 92d1a7a0de4..c8b1db172b4 100644
--- a/api-ref/source/v3/volumes-v3-types.inc
+++ b/api-ref/source/v3/volumes-v3-types.inc
@@ -66,7 +66,7 @@ Response Parameters
 Response Example
 ----------------
 
-.. literalinclude:: ./samples/volume_type/volume-type-show-response.json
+.. literalinclude:: ./samples/volume_type/volume-type-update-response.json
    :language: javascript
 
 
diff --git a/cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-request.json.tpl b/cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-request.json.tpl
new file mode 100644
index 00000000000..0f2bcc68dff
--- /dev/null
+++ b/cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-request.json.tpl
@@ -0,0 +1,7 @@
+{
+    "volume_type": {
+        "name": "%(name)s",
+        "description": "%(description)s",
+        "is_public": "%(bool)s"
+    }
+}
diff --git a/cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-response.json.tpl b/cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-response.json.tpl
new file mode 100644
index 00000000000..584b699ef6e
--- /dev/null
+++ b/cinder/tests/functional/api_sample_tests/samples/volume_type/volume-type-update-response.json.tpl
@@ -0,0 +1,11 @@
+{
+    "volume_type": {
+        "id":  "%(uuid)s",
+        "name": "vol-type-001",
+        "description": "volume type 0001",
+        "is_public": true,
+        "extra_specs": {
+            "capabilities": "gpu"
+        }
+    }
+}
diff --git a/cinder/tests/functional/api_sample_tests/test_volume_types.py b/cinder/tests/functional/api_sample_tests/test_volume_types.py
index 98d6fb0aa05..ef573401c5d 100644
--- a/cinder/tests/functional/api_sample_tests/test_volume_types.py
+++ b/cinder/tests/functional/api_sample_tests/test_volume_types.py
@@ -58,6 +58,14 @@ class VolumeTypesSampleJsonTest(api_samples_test_base.ApiSampleTestBase):
         self._verify_response('volume-type-show-response',
                               self.subs, response, 200)
 
+    def test_volume_type_update(self):
+        res = self._volume_type_create()
+        res = jsonutils.loads(res.content)['volume_type']
+        response = self._do_put(
+            'types/%s' % res['id'], 'volume-type-update-request', self.subs)
+        self._verify_response('volume-type-update-response',
+                              self.subs, response, 200)
+
     def test_volume_type_extra_spec_create_update(self):
 
         res = self._volume_type_create()