openstack/keystone
Code Issues Proposed changes

Reorder APIs in api-ref doc for v3 users

Browse Source 
This patch reorders the APIs listed in the api-ref doc for v3 users so
that we have APIs documented in the following order:

- list users
- create user
- show user
- update user
- delete user
- list user groups
- list user projects
- change passwd

The rationale behind the change is that we want the order of API docs
for all resources to be consistent and easy to navigate. This patch
reorders the users APIs so that:

- Plural form of resources comes always come before singlar form because
  it has a unique URI;
- APIs about a specific resource (usually with an ID) are documented
  in the order of CRUD (create, retrieve, update and delete);
- All other helper APIs are documented at the end and they are grouped
  based on resource URIs when appropriate.

Change-Id: Ie594a45a51064a5f9089e2663bd970f10707ffaa
This commit is contained in:
tengqm 2016-09-21 01:33:33 -04:00
parent 0da99e272c
commit abab343921
1 changed files with 146 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

292
api-ref/source/v3/users.inc
View File

@ -17,6 +17,115 @@ To list user roles, see `Roles <http://developer.openstack.org/api-ref/
identity/v3/index.html#roles>`_.
List users
==========
.. rest_method:: GET /v3/users
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/users``
Lists users.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- domain_id: domain_id_query
- enabled: enabled_user_query
- name: name_user_query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- links: link_collection
- users: users_object
- default_project_id: default_project_id_response_body
- domain_id: domain_id_response_body
- enabled: enabled_user_response_body
- id: id_user_body
- links: links_user
- name: user_name_response_body
- password_expires_at: password_expires_at
Response Example
----------------
.. literalinclude:: ./samples/admin/users-list-response.json
:language: javascript
Create user
===========
.. rest_method:: POST /v3/users
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/users``
Creates a user.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- user: user_object
- default_project_id: default_project_id_request_body
- domain_id: user_domain_id_request_body
- enabled: enabled_user_request_body
- name: user_name_create_request_body
- password: password_request_body
Request Example
---------------
.. literalinclude:: ./samples/admin/user-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- user: user_object
- default_project_id: default_project_id_response_body
- domain_id: domain_id_response_body
- enabled: enabled_user_response_body
- id: id_user_body
- links: links_user
- name: user_name_response_body
- password_expires_at: password_expires_at
Show user details
=================
@ -204,6 +313,43 @@ Response Example
:language: javascript
List projects for user
======================
.. rest_method:: GET /v3/users/{user_id}/projects
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user_projects``
List projects for a user.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- user_id: user_id_path
Response Example
----------------
.. literalinclude:: ./samples/admin/user-projects-list-response.json
:language: javascript
Change password for user
========================
@ -243,149 +389,3 @@ Request Example
.. literalinclude:: ./samples/admin/user-password-update-request.json
:language: javascript
Create user
===========
.. rest_method:: POST /v3/users
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/users``
Creates a user.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 409
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- user: user_object
- default_project_id: default_project_id_request_body
- domain_id: user_domain_id_request_body
- enabled: enabled_user_request_body
- name: user_name_create_request_body
- password: password_request_body
Request Example
---------------
.. literalinclude:: ./samples/admin/user-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- user: user_object
- default_project_id: default_project_id_response_body
- domain_id: domain_id_response_body
- enabled: enabled_user_response_body
- id: id_user_body
- links: links_user
- name: user_name_response_body
- password_expires_at: password_expires_at
List users
==========
.. rest_method:: GET /v3/users
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/users``
Lists users.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- domain_id: domain_id_query
- enabled: enabled_user_query
- name: name_user_query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- links: link_collection
- users: users_object
- default_project_id: default_project_id_response_body
- domain_id: domain_id_response_body
- enabled: enabled_user_response_body
- id: id_user_body
- links: links_user
- name: user_name_response_body
- password_expires_at: password_expires_at
Response Example
----------------
.. literalinclude:: ./samples/admin/users-list-response.json
:language: javascript
List projects for user
======================
.. rest_method:: GET /v3/users/{user_id}/projects
Relationship: ``http://docs.openstack.org/api/openstack-identity/3/rel/user_projects``
List projects for a user.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- user_id: user_id_path
Response Example
----------------
.. literalinclude:: ./samples/admin/user-projects-list-response.json
:language: javascript