Update backups(v2) api-ref

Revising some wrongs of backups(v2) in api-ref docs

Change-Id: Ic04b60bcf32df5f33899fae6610785533edbfa6c
This commit is contained in:
Cai Hui 2018-10-29 02:04:46 -04:00
parent d79df98a34
commit 113089683d
2 changed files with 72 additions and 0 deletions

View File

@ -53,3 +53,73 @@ Response Example
.. literalinclude:: samples/backup-list-response.json
:language: javascript
Show backups(v2)
================
.. rest_method:: GET /v2/{project_id}/backups/{backup_id}
Shows a backups.
This operation shows a certain backup. The backup details.
Normal response codes: 200
Error response codes:
- Unauthorized (401)
- Forbidden (403)
Query Parameters
-----------------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- backup_id: backup_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- project_id: project_id
- user_id: user_id
- backup_id: backup_id
- username: username
- backup_metadata: backup_metadata
Response Example
----------------
.. literalinclude:: samples/backup-get-response.json
:language: javascript
Delete backups(v2)
==================
.. rest_method:: DELETE /v2/{project_id}/actions/{backup_id}
Delete backups in a project.
This operation deletes a certain backup.
Normal response codes: 204
Error response codes:
- Unauthorized (401)
- Forbidden (403)
Query Parameters
-----------------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- backup_id: backup_id_path
There is no response for this operation.

View File

@ -1,6 +1,7 @@
{
"backups": [
{
"project_id": "752d8bd43d654e7a840bbfda77ce41af",
"backup_id": "96a5946a6e994a38a3d1008fbc6f3406",
"user_id": "a387de3311484ce58c4560486bc153f1",
"job_id": "df96800d16fc4d28af75c8451daf0a92",
@ -37,6 +38,7 @@
"user_name": "os_backup"
},
{
"project_id": "752d8bd43d654e7a840bbfda77ce41af",
"backup_id": "0cd44caf6db5486b94a04b33256a5ff4",
"user_id": "a387de3311484ce58c4560486bc153f1",
"job_id": "b30efac3ef744c45bf3062775ea3525b",