Refactor Keystone admin-tenant API v2

This patch modifies parameters names in admin-tenant.inc

Change-Id: Ic5e4a00321d7999a060a7c6bc992f005e7aaaaeb

api-ref/source/v2-admin/admin-tenants.inc

@@ -20,7 +20,7 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
-   - tenantId: tenantId
+   - tenantId: tenant_id_path
 
 Response Parameters
 -------------------
@@ -28,10 +28,10 @@ Response Parameters
 .. rest_parameters:: parameters.yaml
 
    - tenant: tenant
-   - enabled: enabled
+   - enabled: tenant_enabled
-   - description: description
+   - description: tenant_description
-   - name: name
+   - name: tenant_name
-   - id: id
+   - id: tenant_id
 
 Response Example
 ----------------
@@ -55,19 +55,19 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
-   - tenantId: tenantId
+   - tenantId: tenant_id_path
 
 Response Parameters
 -------------------
 
 .. rest_parameters:: parameters.yaml
 
-   - users_link: users_link
    - users: users
-   - enabled: enabled
+   - users_link: users_link
-   - username: username
+   - enabled: user_enabled
-   - email: email
+   - username: user_name
-   - id: id
+   - email: user_email
+   - id: user_id
 
 Response Example
 ----------------
@@ -91,19 +91,19 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
-   - userId: userId
+   - userId: user_id_path
-   - tenantId: tenantId
+   - tenantId: tenant_id_path
 
 Response Parameters
 -------------------
 
 .. rest_parameters:: parameters.yaml
 
-   - roles_links: roles_links
    - roles: roles
-   - description: description
+   - roles_links: roles_links
-   - name: name
+   - description: role_description
-   - id: id
+   - name: role_name
+   - id: role_id
 
 Response Example
 ----------------
@@ -127,12 +127,12 @@ Response Parameters
 
 .. rest_parameters:: parameters.yaml
 
-   - tenant_links: tenant_links
    - tenants: tenants
-   - enabled: enabled
+   - tenant_links: tenant_links
-   - description: description
+   - enabled: tenant_enabled
-   - name: name
+   - description: tenant_description
-   - id: id
+   - name: tenant_name
+   - id: tenant_id
 
 Response Example
 ----------------
@@ -156,7 +156,7 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
-   - name: name
+   - name: tenant_name_query
 
 Response Parameters
 -------------------
@@ -164,10 +164,10 @@ Response Parameters
 .. rest_parameters:: parameters.yaml
 
    - tenant: tenant
-   - enabled: enabled
+   - enabled: tenant_enabled
-   - description: description
+   - description: tenant_description
-   - name: name
+   - name: tenant_name
-   - id: id
+   - id: tenant_id
 
 Response Example
 ----------------
@@ -191,7 +191,7 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
-   - tenantId: tenantId
+   - tenantId: tenant_id_path
 
 
 Update tenant
@@ -209,12 +209,11 @@ Request
 
 .. rest_parameters:: parameters.yaml
 
+   - tenantId: tenant_id_path
    - tenant: tenant
-   - enabled: enabled
+   - enabled: tenant_enabled
-   - description: description
+   - description: tenant_description
-   - name: name
+   - name: tenant_name
-   - id: id
-   - tenantId: tenantId
 
 Request Example
 ---------------
@@ -228,10 +227,10 @@ Response Parameters
 .. rest_parameters:: parameters.yaml
 
    - tenant: tenant
-   - enabled: enabled
+   - enabled: tenant_enabled
-   - description: description
+   - description: tenant_description
-   - name: name
+   - name: tenant_name
-   - id: id
+   - id: tenant_id
 
 Response Example
 ----------------
@@ -262,7 +261,7 @@ Response Parameters
 .. rest_parameters:: parameters.yaml
 
    - tenant: tenant
-   - enabled: enabled
+   - enabled: tenant_enabled
-   - description: description
+   - description: tenant_description
-   - name: name
+   - name: tenant_name
-   - id: id
+   - id: tenant_id

api-ref/source/v2-admin/parameters.yaml

@@ -14,7 +14,13 @@ endpoint_id_path:
   in: path
   required: true
   type: string
-tenantId_1:
+tenant_id_path:
+  description: |
+    The tenant ID.
+  in: path
+  required: true
+  type: string
+tenantId:
   description: |
     The tenant ID.
   in: path
@@ -27,6 +33,12 @@ tokenId:
   in: path
   required: true
   type: string
+user_id_path:
+  description: |
+    The user ID.
+  in: path
+  required: true
+  type: string
 userId:
   description: |
     The user ID.
@@ -35,11 +47,11 @@ userId:
   type: string
 
 # variables in query
-name_2:
+tenant_name_query:
   description: |
     Filters the response by a tenant name.
   in: query
-  required: true
+  required: false
   type: string
 
 # variables in body
@@ -62,12 +74,6 @@ email:
   in: body
   required: false
   type: string
-email_1:
-  description: |
-    The user email.
-  in: body
-  required: true
-  type: string
 enabled:
   description: |
     Indicates whether the tenant is enabled or
@@ -75,20 +81,6 @@ enabled:
   in: body
   required: true
   type: boolean
-enabled_1:
-  description: |
-    Indicates whether the user is enabled (``true``)
-    or disabled (``false``). Default is ``true``.
-  in: body
-  required: false
-  type: boolean
-enabled_2:
-  description: |
-    Indicates whether the user is enabled (``true``)
-    or disabled(``false``). The default value is ``true``.
-  in: body
-  required: true
-  type: boolean
 endpoint:
   description: |
     Endpoint object. Contains ``publicURL``, ``adminURL``,
@@ -190,12 +182,6 @@ id:
   in: body
   required: false
   type: string
-id_1:
-  description: |
-    The user ID.
-  in: body
-  required: true
-  type: string
 impersonation:
   description: |
     The impersonation flag.
@@ -249,6 +235,24 @@ password:
   in: body
   required: false
   type: string
+role_description:
+  description: |
+    The role description.
+  in: body
+  required: true
+  type: string
+role_id:
+  description: |
+    The role ID.
+  in: body
+  required: true
+  type: string
+role_name:
+  description: |
+    The role name.
+  in: body
+  required: true
+  type: string
 roles:
   description: |
     The collection of roles.
@@ -279,17 +283,37 @@ tenant:
   in: body
   required: true
   type: string
+tenant_description:
+  description: |
+    The description of the tenant. If not set, this
+    value is ``null``.
+  in: body
+  required: true
+  type: string
+tenant_enabled:
+  description: |
+    Indicates whether the tenant is enabled or
+    disabled.
+  in: body
+  required: true
+  type: boolean
+tenant_id:
+  description: |
+    The tenant ID.
+  in: body
+  required: true
+  type: string
 tenant_links:
   description: |
     The link to the represented tenant collection.
   in: body
   required: true
   type: array
-tenantId:
+tenant_name:
   description: |
-    The tenant ID.
+    Tenant name.
   in: body
-  required: false
+  required: true
   type: string
 tenants:
   description: |
@@ -334,13 +358,32 @@ user:
   in: body
   required: true
   type: string
-username:
+user_email:
   description: |
-    The user name of the user.
+    The user email.
   in: body
   required: true
   type: string
-username_1:
+user_enabled:
+  description: |
+    Indicates whether the user is enabled (``true``)
+    or disabled(``false``). The default value is ``true``.
+  in: body
+  required: true
+  type: boolean
+user_id:
+  description: |
+    The user ID.
+  in: body
+  required: true
+  type: string
+user_name:
+  description: |
+    The user name.
+  in: body
+  required: true
+  type: string
+username:
   description: |
     The username of user.
   in: body