openstack/trove
Code Issues Proposed changes

Merge "[Doc] Refine the root enable API description"

Browse Source
This commit is contained in:
Zuul 2020-09-13 12:36:57 +00:00 committed by Gerrit Code Review
commit e6feda698f
2 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/source/samples/user-root-enable-request.json Normal file
View File

@ -0,0 +1,3 @@
{
"password": "q5BXXMUMbc8XBf5kkVToKZW4Kx3Egv5VjY0P"
}

16
api-ref/source/users.inc
View File

@ -217,12 +217,12 @@ Enable root user
Enables the root user for a database instance and returns the root password. Enables the root user for a database instance and returns the root password.
This operation generates a root password for the root user and This operation generates password for the root user if not provided and
enables the root user to log in from any host. enables the root user to log in from any host. If provided, the user should
guarantee the password complexity and change regularly.
Enabling root user should only be restricted to admin user， as with root user, Other than managing databases and users, root user can change database settings
the cloud user can change the database settings, e.g. remove users which without touching Trove API which is not recommended.
bypassing the Trove API.
Normal response codes: 200 Normal response codes: 200
@ -234,7 +234,13 @@ Request
- project_id: project_id - project_id: project_id
- instanceId: instanceId - instanceId: instanceId
- password: root_password
Request Example
---------------
.. literalinclude:: samples/user-root-enable-request.json
:language: javascript
Response Example Response Example
---------------- ----------------