Merge "v2 api: add missing /roles in role CRUD APIs"

2016-07-16 18:40:11 +00:00 · 2016-07-16 18:40:11 +00:00 · 49c0ac58e1
parent a0a05168cd eb27807b03
commit 49c0ac58e1
1 changed files with 102 additions and 102 deletions
--- a/api-ref/source/v2-ext/ksadm-admin.inc
+++ b/api-ref/source/v2-ext/ksadm-admin.inc
@ -140,34 +140,6 @@ Response Example
   :language: javascript


-List roles (admin extension)
-============================
-
-.. rest_method::  GET /v2.0/OS-KSADM/
-
-Lists all roles.
-
-Normal response codes: 200,203
-Error response codes: 413,405,404,403,401,400,503
-
-Response Parameters
-------------------
-
-.. rest_parameters:: parameters.yaml
-
-   - roles_links: roles_links
-   - roles: roles
-   - description: description
-   - name: name
-   - id: id
-
-Response Example
----------------
-
-.. literalinclude:: samples/OS-KSADM/roles-list-response.json
-   :language: javascript
-
-
 Create user (admin extension)
 =============================

@ -207,71 +179,6 @@ Response Parameters
   - id: id


-Show role information by name
-=============================
-
-.. rest_method::  GET /v2.0/OS-KSADM/roles/{role_name}
-
-Shows information for a role, by name.
-
-Normal response codes: 200,203
-Error response codes: 413,415,405,404,403,401,400,503,409
-
-Response Parameters
-------------------
-
-.. rest_parameters:: parameters.yaml
-
-   - Location: Location
-   - description: description
-   - name: name
-   - id: id
-
-Response Example
----------------
-
-.. literalinclude:: samples/OS-KSADM/role-show-response.json
-   :language: javascript
-
-
-Grant global role to user
-=========================
-
-.. rest_method::  PUT /v2.0/users/{userId}/roles/OS-KSADM/{roleId}
-
-Grants a global role to a user.
-
-Normal response codes: 201
-Error response codes: 413,415,405,404,403,401,400,503,409
-
-Request
-------
-
-.. rest_parameters:: parameters.yaml
-
-   - userId: userId
-   - roleId: roleId
-
-
-Delete global role from user
-============================
-
-.. rest_method::  DELETE /v2.0/users/{userId}/roles/OS-KSADM/{roleId}
-
-Deletes a global role from a user.
-
-Normal response codes: 204
-Error response codes: 413,415,405,404,403,401,400,503,409
-
-Request
-------
-
-.. rest_parameters:: parameters.yaml
-
-   - userId: userId
-   - roleId: roleId
-
-
 List services (admin extension)
 ===============================

@ -354,10 +261,10 @@ Response Example
   :language: javascript


-Create role (admin extension)
-=============================
+Create a role
+=============

-.. rest_method::  POST /v2.0/OS-KSADM
+.. rest_method::  POST /v2.0/OS-KSADM/roles

 Creates a role.

@ -378,12 +285,40 @@ Response Parameters
   - Location: Location


-Show role details, by ID
-========================
+List all roles
+==============

-.. rest_method::  GET /v2.0/OS-KSADM/{roleId}
+.. rest_method::  GET /v2.0/OS-KSADM/roles

-Shows details for a role, by ID.
+Lists all roles.
+
+Normal response codes: 200,203
+Error response codes: 413,405,404,403,401,400,503
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+   - roles_links: roles_links
+   - roles: roles
+   - description: description
+   - name: name
+   - id: id
+
+Response Example
+----------------
+
+.. literalinclude:: samples/OS-KSADM/roles-list-response.json
+   :language: javascript
+
+
+Show a role
+===========
+
+.. rest_method::  GET /v2.0/OS-KSADM/roles/{roleId}
+
+Shows details for a role.

 Normal response codes: 200,203
 Error response codes: 413,415,405,404,403,401,400,503,409
@ -412,10 +347,75 @@ Response Example
   :language: javascript


-Delete role (admin extension)
+Show role information by name
 =============================

-.. rest_method::  DELETE /v2.0/OS-KSADM/{roleId}
+.. rest_method::  GET /v2.0/OS-KSADM/roles/{role_name}
+
+Shows information for a role, by name.
+
+Normal response codes: 200,203
+Error response codes: 413,415,405,404,403,401,400,503,409
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+   - Location: Location
+   - description: description
+   - name: name
+   - id: id
+
+Response Example
+----------------
+
+.. literalinclude:: samples/OS-KSADM/role-show-response.json
+   :language: javascript
+
+
+Grant global role to user
+=========================
+
+.. rest_method::  PUT /v2.0/users/{userId}/roles/OS-KSADM/{roleId}
+
+Grants a global role to a user.
+
+Normal response codes: 201
+Error response codes: 413,415,405,404,403,401,400,503,409
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - userId: userId
+   - roleId: roleId
+
+
+Delete global role from user
+============================
+
+.. rest_method::  DELETE /v2.0/users/{userId}/roles/OS-KSADM/{roleId}
+
+Deletes a global role from a user.
+
+Normal response codes: 204
+Error response codes: 413,415,405,404,403,401,400,503,409
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - userId: userId
+   - roleId: roleId
+
+
+Delete a role
+=============
+
+.. rest_method::  DELETE /v2.0/OS-KSADM/roles/{roleId}

 Deletes a role.