From 4f4a0256f782b4d3f9a54ea975f9f81c59c955a2 Mon Sep 17 00:00:00 2001
From: "jeremy.zhang" <zhangjun_inspur@163.com>
Date: Sat, 18 Nov 2017 16:13:37 +0800
Subject: [PATCH] Add v3 api-ref for showing encryption specs item

This patch adds v3 api-ref for showing encryption specs item for an
existing volume type.

Change-Id: I80b1853cbe2cc02a056195e967e9422617bbf850
---
 api-ref/source/v3/parameters.yaml             |  6 ++++
 ...ion-type-specific-specs-show-response.json |  3 ++
 api-ref/source/v3/volumes-v3-types.inc        | 34 ++++++++++++++++---
 3 files changed, 39 insertions(+), 4 deletions(-)
 create mode 100644 api-ref/source/v3/samples/encryption-type-specific-specs-show-response.json

diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index e96297b0b82..cd9a78a2d34 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -113,6 +113,12 @@ key_4:
   in: path
   required: true
   type: string
+key_5:
+  description: |
+    The key name of the encryption spec for a volume type.
+  in: path
+  required: true
+  type: string
 message_id:
   description: |
     The UUID of the message.
diff --git a/api-ref/source/v3/samples/encryption-type-specific-specs-show-response.json b/api-ref/source/v3/samples/encryption-type-specific-specs-show-response.json
new file mode 100644
index 00000000000..31d00483d87
--- /dev/null
+++ b/api-ref/source/v3/samples/encryption-type-specific-specs-show-response.json
@@ -0,0 +1,3 @@
+{
+    "cipher": "aes-xts-plain64"
+}
diff --git a/api-ref/source/v3/volumes-v3-types.inc b/api-ref/source/v3/volumes-v3-types.inc
index cce1c5a9c50..7d0ba080c31 100644
--- a/api-ref/source/v3/volumes-v3-types.inc
+++ b/api-ref/source/v3/volumes-v3-types.inc
@@ -385,7 +385,7 @@ Response Example
    :language: javascript
 
 Show an encryption type
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~
 
 .. rest_method::  GET /v3/{project_id}/types/{volume_type_id}/encryption
 
@@ -429,9 +429,35 @@ Response Example
    :language: javascript
 
 
-Delete an encryption type
+Show encryption specs item
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+.. rest_method::  GET /v3/{project_id}/types/{volume_type_id}/encryption/{key}
+
+To show encryption specs item for an existing volume type.
+
+Normal response codes: 200
+
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - project_id: project_id_path
+   - volume_type_id: volume_type_id
+   - key: key_5
+
+Response Example
+----------------
+
+.. literalinclude:: ./samples/encryption-type-specific-specs-show-response.json
+   :language: javascript
+
+
+Delete an encryption type
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. rest_method::  GET /v3/{project_id}/types/{volume_type_id}/encryption/{encryption_id}
 
 Delete an encryption type.
@@ -452,7 +478,7 @@ Request
 
 
 Create an encryption type
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. rest_method::  POST /v3/{project_id}/types/{volume_type_id}/encryption
 
@@ -504,7 +530,7 @@ Response Example
 
 
 Update an encryption type
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. rest_method::  POST /v3/{project_id}/types/{volume_type_id}/encryption/{encryption_id}