Fix api-ref for group snapshots API

This patch mainly fixes the response parameters and examples for
the show/list/create group snapshots APIs.

Change-Id: If160ffdd7301337eac9353faffb72a9f069882c4
This commit is contained in:
jeremy.zhang
2017-10-31 15:25:22 +08:00
parent b8ed8c00d0
commit ab9a8a2a6e
5 changed files with 28 additions and 18 deletions

View File

@@ -59,9 +59,10 @@ Response Parameters
- created_at: created_at - created_at: created_at
- group_id: source_group_id - group_id: source_group_id
- id: group_snapshot_id_1 - id: group_snapshot_id_1
- name: name_18 - name: name_19
- status: status_7 - status: status_7
- description: description_14 - description: description_16
- group_type_id: group_type_id_2
Response Example Response Example
---------------- ----------------
@@ -103,11 +104,12 @@ Response Parameters
- group_snapshots: group_snapshots - group_snapshots: group_snapshots
- id: group_snapshot_id_1 - id: group_snapshot_id_1
- name: name_18 - name: name_19
- status: status_7 - status: status_7
- description: description_14 - description: description_16
- created_at: created_at - created_at: created_at
- group_id: group_id_1 - group_id: group_id_1
- group_type_id: group_type_id_2
Response Example Response Example
---------------- ----------------
@@ -149,7 +151,7 @@ Response Parameters
- group_snapshots: group_snapshots - group_snapshots: group_snapshots
- id: group_snapshot_id_1 - id: group_snapshot_id_1
- name: name_18 - name: name_19
Response Example Response Example
@@ -195,11 +197,8 @@ Response Parameters
- group_snapshot: group_snapshot - group_snapshot: group_snapshot
- id: group_snapshot_id_1 - id: group_snapshot_id_1
- name: name_18 - name: name_19
- status: status_7 - group_type_id: group_type_id_2
- description: description_14
- created_at: created_at
- group_id: group_id_1
Response Example Response Example
---------------- ----------------

View File

@@ -881,6 +881,12 @@ description_15:
in: body in: body
required: false required: false
type: string type: string
description_16:
description: |
The group snapshot description.
in: body
required: true
type: string
description_2: description_2:
description: | description: |
The description of the consistency group. The description of the consistency group.
@@ -1753,6 +1759,12 @@ name_18:
in: body in: body
required: false required: false
type: string type: string
name_19:
description: |
The group snapshot name.
in: body
required: true
type: string
name_2: name_2:
description: | description: |
The consistency group snapshot name. The consistency group snapshot name.

View File

@@ -2,10 +2,6 @@
"group_snapshot": { "group_snapshot": {
"id": "6f519a48-3183-46cf-a32f-41815f816666", "id": "6f519a48-3183-46cf-a32f-41815f816666",
"name": "first_group_snapshot", "name": "first_group_snapshot",
"status": "creating", "group_type_id": "58737af7-786b-48b7-ab7c-2447e74b0ef4"
"group_type_id": "58737af7-786b-48b7-ab7c-2447e74b0ef4",
"created_at": "2017-06-20T07:44:47.000000",
"group_id": "d5577983-23be-47e3-b98b-bf604e5af421",
"description": null
} }
} }

View File

@@ -6,7 +6,8 @@
"status": "available", "status": "available",
"created_at": "2015-09-16T09:28:52.000000", "created_at": "2015-09-16T09:28:52.000000",
"name": "my_group_snapshot1", "name": "my_group_snapshot1",
"description": "my first group snapshot" "description": "my first group snapshot",
"group_type_id": "0ef094a2-d9fd-4c79-acfd-ac60a0506b7d"
}, },
{ {
"id": "aed36625-a6d7-4681-ba59-c7ba3d18c148", "id": "aed36625-a6d7-4681-ba59-c7ba3d18c148",
@@ -14,7 +15,8 @@
"status": "error", "status": "error",
"created_at": "2015-09-16T09:31:15.000000", "created_at": "2015-09-16T09:31:15.000000",
"name": "my_group_snapshot2", "name": "my_group_snapshot2",
"description": "Edited description" "description": "Edited description",
"group_type_id": "7270c56e-6354-4528-8e8b-f54dee2232c8"
} }
] ]
} }

View File

@@ -5,6 +5,7 @@
"status": "available", "status": "available",
"created_at": "2015-09-16T09:28:52.000000", "created_at": "2015-09-16T09:28:52.000000",
"name": "my_group_snapshot1", "name": "my_group_snapshot1",
"description": "my first group snapshot" "description": "my first group snapshot",
"group_type_id": "7270c56e-6354-4528-8e8b-f54dee2232c8"
} }
} }