From 6985c77ee5c61268b77fe50926469263a5738e75 Mon Sep 17 00:00:00 2001
From: junboli <junbo85.li@gmail.com>
Date: Fri, 17 Nov 2017 10:28:18 +0800
Subject: [PATCH] Api ref contains incorrect parameters.

Things like following is in api-ref, need to be correct.
  1. use share_id and remove share_id_4
  2. export_location_id_path param is required
  3. security_service_id is required not optional
This patch is to fix these.

Change-Id: Ic811095b85a0460d3c6bedc9526d8ed64248de4c
Closes-bug: #1719543
---
 api-ref/source/parameters.yaml                     | 11 ++---------
 api-ref/source/share-export-locations.inc          |  2 +-
 api-ref/source/share-instance-export-locations.inc |  4 ++--
 api-ref/source/shares.inc                          |  4 ++--
 4 files changed, 7 insertions(+), 14 deletions(-)

diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 23d2266a41..cf5e47cec9 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -12,7 +12,7 @@ export_location_id_path:
   description: |
     The UUID of the export location.
   in: path
-  required: false
+  required: true
   type: string
 group_snapshot_id_path:
   description: |
@@ -30,7 +30,7 @@ security_service_id_path:
   description: |
     The UUID of the security service.
   in: path
-  required: false
+  required: true
   type: string
 share_group_id_path:
   description: |
@@ -2709,13 +2709,6 @@ share_id_2:
   in: body
   required: true
   type: string
-share_id_4:
-  description: |
-    The UUID of the share from which to create a
-    snapshot.
-  in: body
-  required: true
-  type: string
 share_instance_id_1:
   description: |
     The UUID of the share instance.
diff --git a/api-ref/source/share-export-locations.inc b/api-ref/source/share-export-locations.inc
index 35272fedba..32ab63f7f1 100644
--- a/api-ref/source/share-export-locations.inc
+++ b/api-ref/source/share-export-locations.inc
@@ -65,7 +65,7 @@ Request
 
    - share_id: share_id
    - tenant_id: tenant_id_path
-   - export_location_id: export_location_id
+   - export_location_id: export_location_id_path
 
 Response parameters
 -------------------
diff --git a/api-ref/source/share-instance-export-locations.inc b/api-ref/source/share-instance-export-locations.inc
index c9c052cf51..c2e7ca903a 100644
--- a/api-ref/source/share-instance-export-locations.inc
+++ b/api-ref/source/share-instance-export-locations.inc
@@ -65,8 +65,8 @@ Request
 .. rest_parameters:: parameters.yaml
 
    - tenant_id: tenant_id_path
-   - share_instance_id: export_location_share_instance_id
-   - export_location_id: export_location_id
+   - share_instance_id: share_instance_id
+   - export_location_id: export_location_id_path
 
 Response parameters
 -------------------
diff --git a/api-ref/source/shares.inc b/api-ref/source/shares.inc
index 579d6cf7a1..77a4b69dd8 100644
--- a/api-ref/source/shares.inc
+++ b/api-ref/source/shares.inc
@@ -232,7 +232,7 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
-   - share_id: share_id_4
+   - share_id: share_id
    - tenant_id: tenant_id_path
 
 Response parameters
@@ -458,7 +458,7 @@ Request
    - is_public: is_public
    - display_name: display_name_3
    - display_description: display_description_3
-   - share_id: share_id_4
+   - share_id: share_id
    - tenant_id: tenant_id_path
 
 Request example