openstack/cinder-specs
Code Issues Proposed changes

Fix descriptive issues

Browse Source 
Fix some of the remaining brief questions as described by Sean.

Change-Id: I4261e8530faca3909b58b90747611c4bc31070f9
Related-commit: https://review.openstack.org/#/c/615494
Blueprint: add-user-id-attribute-to-backup-response
This commit is contained in:
zhangbailin 2018-12-19 22:03:02 -05:00
parent 545231c4d8
commit 68925153ad
1 changed files with 24 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
specs/stein/add-user-id-attribute-to-backup-response.rst
View File

@ -15,7 +15,7 @@ the response body of list backup with detail and show backup detail APIs.
Problem description Problem description
=================== ===================
Currently, there is a ``user_id`` field in the ``backups`` table, these Currently, there is a ``user_id`` field in the ``backups`` table. These
fields are very useful for admin to manage the backup file, but this fields are very useful for admin to manage the backup file, but this
is not returned in response body. So it is difficult to manage the resources is not returned in response body. So it is difficult to manage the resources
under the project. If there are multiple users under one project, it is under the project. If there are multiple users under one project, it is
@ -26,17 +26,15 @@ Use Cases
In large scale environment, lots of backups resources were created in system, In large scale environment, lots of backups resources were created in system,
that we can only see the project to which the backup file belongs, but we that we can only see the project to which the backup file belongs, but we
cannot know which user the backup belongs to it. cannot know to which user the backup belongs.
In order to better manage the backup files, add ``user_id`` Administrators would like the ability to identify the users that have created
attribute to the response body of list backup with detail and show backup backups.
detail APIs, make the backup resources more visible to the users of the
project.
Proposed change Proposed change
=============== ===============
This spec proposes that add ``user_id`` attribute to the This spec proposes to add ``user_id`` attribute to the
response body of list backup with detail and show backup detail APIs. response body of list backup with detail and show backup detail APIs.
Add a new microverion API to add ``user_id`` attribute Add a new microverion API to add ``user_id`` attribute
@ -56,29 +54,29 @@ a very old backup file.
REST API impact REST API impact
--------------- ---------------
* Add a new microversion in Cinder API. Add a new microversion in Cinder API.
* List backups with detail:: List backups with detail::
GET /v3/{project_id}/backups/detail GET /v3/{project_id}/backups/detail
Response BODY: Response BODY:
{ {
"backups": [{ "backups": [{
... ...
"user_id": "515ba0dd59f84f25a6a084a45d8d93b2" "user_id": "515ba0dd59f84f25a6a084a45d8d93b2"
}] }]
} }
* Show backup detail:: Show backup detail::
GET /v3/{project_id}/backups/{backup_id} GET /v3/{project_id}/backups/{backup_id}
Response BODY: Response BODY:
{ {
"backups": [{ "backups": [{
... ...
"user_id": "515ba0dd59f84f25a6a084a45d8d93b2" "user_id": "515ba0dd59f84f25a6a084a45d8d93b2"
}] }]
} }
Calling this method shows a ``user_id`` for volume backup. Calling this method shows a ``user_id`` for volume backup.
It is intended for admins to use, which is used to display the user to which It is intended for admins to use, which is used to display the user to which