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
This commit is contained in:
junboli 2017-11-17 10:28:18 +08:00
parent ca1b09967d
commit 6985c77ee5
4 changed files with 7 additions and 14 deletions

View File

@ -12,7 +12,7 @@ export_location_id_path:
description: | description: |
The UUID of the export location. The UUID of the export location.
in: path in: path
required: false required: true
type: string type: string
group_snapshot_id_path: group_snapshot_id_path:
description: | description: |
@ -30,7 +30,7 @@ security_service_id_path:
description: | description: |
The UUID of the security service. The UUID of the security service.
in: path in: path
required: false required: true
type: string type: string
share_group_id_path: share_group_id_path:
description: | description: |
@ -2709,13 +2709,6 @@ share_id_2:
in: body in: body
required: true required: true
type: string 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: share_instance_id_1:
description: | description: |
The UUID of the share instance. The UUID of the share instance.

View File

@ -65,7 +65,7 @@ Request
- share_id: share_id - share_id: share_id
- tenant_id: tenant_id_path - tenant_id: tenant_id_path
- export_location_id: export_location_id - export_location_id: export_location_id_path
Response parameters Response parameters
------------------- -------------------

View File

@ -65,8 +65,8 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- tenant_id: tenant_id_path - tenant_id: tenant_id_path
- share_instance_id: export_location_share_instance_id - share_instance_id: share_instance_id
- export_location_id: export_location_id - export_location_id: export_location_id_path
Response parameters Response parameters
------------------- -------------------

View File

@ -232,7 +232,7 @@ Request
.. rest_parameters:: parameters.yaml .. rest_parameters:: parameters.yaml
- share_id: share_id_4 - share_id: share_id
- tenant_id: tenant_id_path - tenant_id: tenant_id_path
Response parameters Response parameters
@ -458,7 +458,7 @@ Request
- is_public: is_public - is_public: is_public
- display_name: display_name_3 - display_name: display_name_3
- display_description: display_description_3 - display_description: display_description_3
- share_id: share_id_4 - share_id: share_id
- tenant_id: tenant_id_path - tenant_id: tenant_id_path
Request example Request example