From 551c2963a0bdfceb39e3bfc73714b3b0abc5bc67 Mon Sep 17 00:00:00 2001
From: liuyamin <liuyamin@fiberhome.com>
Date: Mon, 22 May 2017 13:49:10 +0800
Subject: [PATCH] Add the missing parameters in the api-ref of ext-backups.inc

Add "snapshot_id" and "data_timestamp" and "volume_name" to
the response parameters and error response code in the api-ref of
ext-backups.inc.

Change-Id: I2e3a6c737a74816e5e56b5a435a73e0bf501bec8
Closes-bug: #1676693
---
 api-ref/source/v2/ext-backups.inc | 11 +++++++++++
 api-ref/source/v2/parameters.yaml | 15 +++++++++++++++
 api-ref/source/v3/ext-backups.inc |  9 +++++++++
 api-ref/source/v3/parameters.yaml | 15 +++++++++++++++
 4 files changed, 50 insertions(+)

diff --git a/api-ref/source/v2/ext-backups.inc b/api-ref/source/v2/ext-backups.inc
index 708fdb1b7e3..5c14449fc76 100644
--- a/api-ref/source/v2/ext-backups.inc
+++ b/api-ref/source/v2/ext-backups.inc
@@ -82,6 +82,8 @@ Response Parameters
    - size: size
    - id: id
    - is_incremental: is_incremental
+   - data_timestamp: data_timestamp
+   - snapshot_id: snapshot_id_2
 
 Response Example
 ----------------
@@ -132,6 +134,8 @@ Response Parameters
    - backup: backup
    - id: id
    - is_incremental: is_incremental
+   - data_timestamp: data_timestamp
+   - snapshot_id: snapshot_id_2
 
 Response Example
 ----------------
@@ -148,6 +152,9 @@ Delete backup
 Deletes a backup.
 
 Normal response codes: 202,
+Error response codes: Bad Request(400)
+
+
 
 
 Request
@@ -170,6 +177,7 @@ You must specify either the UUID or name of the volume. If you
 specify both the UUID and name, the UUID takes priority.
 
 Normal response codes: 202,
+Error response codes: Bad Request(400), Request Entity Too Large(413)
 
 
 Request
@@ -197,6 +205,7 @@ Response Parameters
    - restore: restore
    - backup_id: backup_id
    - volume_id: volume_id
+   - volume_name: volume_name
 
 Create backup
 ~~~~~~~~~~~~~
@@ -206,6 +215,7 @@ Create backup
 Creates a Block Storage backup from a volume.
 
 Normal response codes: 202,
+Error response codes: Bad Request(400), Internal Server Error(500)
 
 Request
 -------
@@ -220,6 +230,7 @@ Request
    - backup: backup
    - name: name
    - tenant_id: tenant_id
+   - snapshot_id: snapshot_id_2
 
 Request Example
 ---------------
diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml
index 928aea46a43..de9df219816 100644
--- a/api-ref/source/v2/parameters.yaml
+++ b/api-ref/source/v2/parameters.yaml
@@ -444,6 +444,15 @@ created_at_1:
   in: body
   required: true
   type: string
+data_timestamp:
+  description: |
+    The time when the data on the volume was first saved. If it is
+    a backup from volume, it will be the same as ``created_at``
+    for a backup. If it is a backup from a snapshot, it will be the
+    same as ``created_at`` for the snapshot.
+  in: body
+  required: true
+  type: string
 deleted:
   description: |
     The resource is deleted or not.
@@ -1708,6 +1717,12 @@ volume_id_6:
   in: body
   required: false
   type: string
+volume_name:
+  description: |
+    The volume name.
+  in: body
+  required: true
+  type: string
 volume_type_1:
   description: |
     A ``volume_type`` object.
diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc
index 0572e70e5c6..4949ecb7a3b 100644
--- a/api-ref/source/v3/ext-backups.inc
+++ b/api-ref/source/v3/ext-backups.inc
@@ -85,6 +85,8 @@ Response Parameters
    - size: size
    - id: id
    - is_incremental: is_incremental
+   - data_timestamp: data_timestamp
+   - snapshot_id: snapshot_id_2
 
 Response Example
 ----------------
@@ -135,6 +137,8 @@ Response Parameters
    - backup: backup
    - id: id
    - is_incremental: is_incremental
+   - data_timestamp: data_timestamp
+   - snapshot_id: snapshot_id_2
 
 Response Example
 ----------------
@@ -151,6 +155,7 @@ Delete a backup
 Deletes a backup.
 
 Normal response codes: 202,
+Error response codes: Bad Request(400)
 
 Request
 -------
@@ -172,6 +177,7 @@ You must specify either the UUID or name of the volume. If you
 specify both the UUID and name, the UUID takes priority.
 
 Normal response codes: 202,
+Error response codes: Bad Request(400), Request Entity Too Large(413)
 
 
 Request
@@ -199,6 +205,7 @@ Response Parameters
    - restore: restore
    - backup_id: backup_id
    - volume_id: volume_id
+   - volume_name: volume_name
 
 Create a backup
 ~~~~~~~~~~~~~~~
@@ -208,6 +215,7 @@ Create a backup
 Creates a Block Storage backup from a volume.
 
 Normal response codes: 202,
+Error response codes: Bad Request(400), Internal Server Error(500)
 
 Request
 -------
@@ -221,6 +229,7 @@ Request
    - force: force
    - backup: backup
    - name: name
+   - snapshot_id: snapshot_id_2
    - project_id: project_id_path
 
 Request Example
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml
index 9ca0e0e5633..0c02d1a02cf 100644
--- a/api-ref/source/v3/parameters.yaml
+++ b/api-ref/source/v3/parameters.yaml
@@ -519,6 +519,15 @@ created_at_1:
   in: body
   required: true
   type: string
+data_timestamp:
+  description: |
+    The time when the data on the volume was first saved. If it is
+    a backup from volume, it will be the same as ``created_at``
+    for a backup. If it is a backup from a snapshot, it will be the
+    same as ``created_at`` for the snapshot.
+  in: body
+  required: true
+  type: string
 delete-volumes:
   description: |
     If set to ``true``, allows deletion of a
@@ -2002,6 +2011,12 @@ volume_id_7:
   in: body
   required: true
   type: string
+volume_name:
+  description: |
+    The volume name.
+  in: body
+  required: true
+  type: string
 volume_type_1:
   description: |
     A ``volume_type`` object.