api-ref: Correcting V3 Services APIs
Correcting all parameters of services APIs. http://developer.openstack.org/api-ref/identity/v3/index.html?expanded=#list-services Rename parameters for more easy to maintain. Change-Id: I9819c19032c93bab9a613bf94b4b95dda722ced9 Partial-Bug: #1610777
This commit is contained in:
parent
12f0db8cc9
commit
9a520bcfa8
|
@ -116,7 +116,7 @@ role_id_path:
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
service_id_2:
|
service_id_path:
|
||||||
description: |
|
description: |
|
||||||
The service ID.
|
The service ID.
|
||||||
in: path
|
in: path
|
||||||
|
@ -328,14 +328,7 @@ service_id_3:
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
type_4:
|
service_type_query:
|
||||||
description: |
|
|
||||||
Filters the response by a MIME media type for the
|
|
||||||
serialized policy blob. For example, ``application/json``.
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
type_5:
|
|
||||||
description: |
|
description: |
|
||||||
Filters the response by a service type. A valid
|
Filters the response by a service type. A valid
|
||||||
value is ``compute``, ``ec2``, ``identity``, ``image``,
|
value is ``compute``, ``ec2``, ``identity``, ``image``,
|
||||||
|
@ -343,6 +336,13 @@ type_5:
|
||||||
in: query
|
in: query
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
type_4:
|
||||||
|
description: |
|
||||||
|
Filters the response by a MIME media type for the
|
||||||
|
serialized policy blob. For example, ``application/json``.
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
user_id_query:
|
user_id_query:
|
||||||
description: |
|
description: |
|
||||||
Filters the response by a user ID.
|
Filters the response by a user ID.
|
||||||
|
@ -457,12 +457,6 @@ description_1:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
description_10:
|
|
||||||
description: |
|
|
||||||
The service description.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
description_11:
|
description_11:
|
||||||
description: |
|
description: |
|
||||||
The user description.
|
The user description.
|
||||||
|
@ -721,16 +715,6 @@ enabled_2:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: boolean
|
type: boolean
|
||||||
enabled_3:
|
|
||||||
description: |
|
|
||||||
Defines whether the service and its endpoints
|
|
||||||
appear in the service catalog: - ``false``. The service and its
|
|
||||||
endpoints do not appear in the service catalog. - ``true``. The
|
|
||||||
service and its endpoints appear in the service catalog.
|
|
||||||
Default is ``true``.
|
|
||||||
in: body
|
|
||||||
required: false
|
|
||||||
type: boolean
|
|
||||||
enabled_7:
|
enabled_7:
|
||||||
description: |
|
description: |
|
||||||
Indicates whether the endpoint appears in the
|
Indicates whether the endpoint appears in the
|
||||||
|
@ -1128,12 +1112,6 @@ links_7:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
links_8:
|
|
||||||
description: |
|
|
||||||
The links for the ``service`` resource.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: object
|
|
||||||
links_region:
|
links_region:
|
||||||
description: |
|
description: |
|
||||||
The links for the ``region`` resource.
|
The links for the ``region`` resource.
|
||||||
|
@ -1246,12 +1224,6 @@ name_6:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
name_7:
|
|
||||||
description: |
|
|
||||||
The service name.
|
|
||||||
in: body
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
original_password:
|
original_password:
|
||||||
description: |
|
description: |
|
||||||
The original password for the user.
|
The original password for the user.
|
||||||
|
@ -1595,6 +1567,22 @@ service:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
|
service_description:
|
||||||
|
description: |
|
||||||
|
The service description.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
service_enabled:
|
||||||
|
description: |
|
||||||
|
Defines whether the service and its endpoints
|
||||||
|
appear in the service catalog: - ``false``. The service and its
|
||||||
|
endpoints do not appear in the service catalog. - ``true``. The
|
||||||
|
service and its endpoints appear in the service catalog.
|
||||||
|
Default is ``true``.
|
||||||
|
in: body
|
||||||
|
required: false
|
||||||
|
type: boolean
|
||||||
service_id:
|
service_id:
|
||||||
description: |
|
description: |
|
||||||
The UUID of the service to which the endpoint
|
The UUID of the service to which the endpoint
|
||||||
|
@ -1602,15 +1590,29 @@ service_id:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
service_id_1:
|
service_links:
|
||||||
description: |
|
description: |
|
||||||
The service ID.
|
The links for the ``service`` resource.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: object
|
||||||
|
service_name:
|
||||||
|
description: |
|
||||||
|
The service name.
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
|
service_type:
|
||||||
|
description: |
|
||||||
|
The service type, which describes the API
|
||||||
|
implemented by the service. Value is ``compute``, ``ec2``,
|
||||||
|
``identity``, ``image``, ``network``, or ``volume``.
|
||||||
|
in: body
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
services:
|
services:
|
||||||
description: |
|
description: |
|
||||||
A ``services`` object.
|
A list of ``service`` object.
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: array
|
type: array
|
||||||
|
@ -1656,14 +1658,6 @@ type_3:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
type_6:
|
|
||||||
description: |
|
|
||||||
The service type, which describes the API
|
|
||||||
implemented by the service. Value is ``compute``, ``ec2``,
|
|
||||||
``identity``, ``image``, ``network``, or ``volume``.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
type_7:
|
type_7:
|
||||||
description: |
|
description: |
|
||||||
The credential type, such as ``ec2`` or ``cert``.
|
The credential type, such as ``ec2`` or ``cert``.
|
||||||
|
|
|
@ -34,20 +34,20 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- type: type
|
- type: service_type_query
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- name: name
|
- name: service_name
|
||||||
- links: links
|
- links: service_links
|
||||||
- enabled: enabled
|
- enabled: service_enabled
|
||||||
- services: services
|
- services: services
|
||||||
- type: type
|
- type: service_type
|
||||||
- id: id
|
- id: service_id
|
||||||
- description: description
|
- description: service_description
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -71,12 +71,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- description: description
|
- description: service_description
|
||||||
- service: service
|
- service: service
|
||||||
- enabled: enabled
|
- enabled: service_enabled
|
||||||
- service_id: service_id
|
- service_id: service_id
|
||||||
- type: type
|
- type: service_type
|
||||||
- name: name
|
- name: service_name
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -89,12 +89,12 @@ Response Parameters
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- name: name
|
- name: service_name
|
||||||
- service: service
|
- service: service
|
||||||
- links: links
|
- links: service_links
|
||||||
- type: type
|
- type: service_type
|
||||||
- id: id
|
- id: service_id
|
||||||
- description: description
|
- description: service_description
|
||||||
|
|
||||||
|
|
||||||
Show endpoint details
|
Show endpoint details
|
||||||
|
@ -298,19 +298,19 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- service_id: service_id
|
- service_id: service_id_path
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- name: name
|
- name: service_name
|
||||||
- service: service
|
- service: service
|
||||||
- links: links
|
- links: service_links
|
||||||
- type: type
|
- type: service_type
|
||||||
- id: id
|
- id: service_id
|
||||||
- description: description
|
- description: service_description
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -338,12 +338,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- type: type
|
- type: service_type
|
||||||
- enabled: enabled
|
- enabled: service_enabled
|
||||||
- description: description
|
- description: service_description
|
||||||
- service: service
|
- service: service
|
||||||
- name: name
|
- name: service_name
|
||||||
- service_id: service_id
|
- service_id: service_id_path
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -356,12 +356,12 @@ Response Parameters
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- name: name
|
- name: service_name
|
||||||
- service: service
|
- service: service
|
||||||
- links: links
|
- links: service_links
|
||||||
- type: type
|
- type: service_type
|
||||||
- id: id
|
- id: service_id
|
||||||
- description: description
|
- description: service_description
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -389,4 +389,4 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- service_id: service_id
|
- service_id: service_id_path
|
||||||
|
|
Loading…
Reference in New Issue