Browse Source

api-ref: Renaming parameters of V3-ext APIs

Change-Id: I7f0ab81e3f8c0799bbcbbcd5a849603d7c2bde3a
Partial-Bug: #1610777
changes/55/353855/1
Anh Tran 5 years ago
parent
commit
e4a82b3da1
  1. 70
      api-ref/source/v3-ext/endpoint-policy.inc
  2. 48
      api-ref/source/v3-ext/ep-filter.inc
  3. 28
      api-ref/source/v3-ext/oauth.inc
  4. 126
      api-ref/source/v3-ext/parameters.yaml
  5. 2
      api-ref/source/v3-ext/revoke.inc
  6. 20
      api-ref/source/v3-ext/trust.inc

70
api-ref/source/v3-ext/endpoint-policy.inc

@ -49,8 +49,8 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- endpoint_id: endpoint_id
- policy_id: policy_id_path
- endpoint_id: endpoint_id_path
Verify a policy and endpoint association
@ -69,8 +69,8 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- endpoint_id: endpoint_id
- policy_id: policy_id_path
- endpoint_id: endpoint_id_path
Delete a policy and endpoint association
@ -87,8 +87,8 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- endpoint_id: endpoint_id
- policy_id: policy_id_path
- endpoint_id: endpoint_id_path
Associate policy and service-type endpoint
@ -108,8 +108,8 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- service_id: service_id
- policy_id: policy_id_path
- service_id: service_id_path
Verify a policy and service-type endpoint association
@ -128,8 +128,8 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- service_id: service_id
- policy_id: policy_id_path
- service_id: service_id_path
Delete a policy and service-type endpoint association
@ -146,8 +146,8 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- service_id: service_id
- policy_id: policy_id_path
- service_id: service_id_path
Show policy for endpoint
@ -170,7 +170,7 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- policy_id: policy_id_path
Response Parameters
-------------------
@ -178,10 +178,10 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- policy: policy
- type: type
- blob: blob
- links: links
- id: id
- type: policy_type
- blob: policy_blob
- links: policy_links
- id: policy_id
Response Example
----------------
@ -204,7 +204,7 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- policy_id: policy_id_path
Associate policy and service-type endpoint in a region
@ -224,9 +224,9 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- service_id: service_id
- region_id: region_id
- policy_id: policy_id_path
- service_id: service_id_path
- region_id: region_id_path
Verify a policy and service-type endpoint in a region association
@ -245,9 +245,9 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- service_id: service_id
- region_id: region_id
- policy_id: policy_id_path
- service_id: service_id_path
- region_id: region_id_path
Delete a policy and service-type endpoint in a region association
@ -264,9 +264,9 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- service_id: service_id
- region_id: region_id
- policy_id: policy_id_path
- service_id: service_id_path
- region_id: region_id_path
List policy and service endpoint associations
@ -283,14 +283,14 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- policy_id: policy_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- links: links
- links: policy_links
- url: url
- region: region
- next: next
@ -298,7 +298,7 @@ Response Parameters
- interface: interface
- service_id: service_id
- endpoints: endpoints
- id: id
- id: endpoint_id
- previous: previous
Response Example
@ -328,7 +328,7 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_id: endpoint_id
- endpoint_id: endpoint_id_path
Response Parameters
-------------------
@ -336,10 +336,10 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- policy: policy
- type: type
- blob: blob
- links: links
- id: id
- type: policy_type
- blob: policy_blob
- links: policy_links
- id: policy_id
Response Example
----------------

48
api-ref/source/v3-ext/ep-filter.inc

@ -47,8 +47,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
- endpoint_id: endpoint_id
- project_id: project_id_path
- endpoint_id: endpoint_id_path
Response
--------
@ -72,8 +72,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
- endpoint_id: endpoint_id
- project_id: project_id_path
- endpoint_id: endpoint_id_path
Response
--------
@ -97,8 +97,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
- endpoint_id: endpoint_id
- project_id: project_id_path
- endpoint_id: endpoint_id_path
Response
--------
@ -122,8 +122,8 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
- endpoint_id: endpoint_id
- project_id: project_id_path
- endpoint_id: endpoint_id_path
Response
--------
@ -150,7 +150,7 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_id: endpoint_id
- endpoint_id: endpoint_id_path
Response
--------
@ -210,7 +210,7 @@ Request
.. rest_parameters: parameters.yaml
- endpoint_group_id: endpoint_group_id
- endpoint_group_id: endpoint_group_id_path
Response
--------
@ -237,7 +237,7 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- endpoint_group_id: endpoint_group_id_path
Response
--------
@ -261,7 +261,7 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- endpoint_group_id: endpoint_group_id_path
- name: eg_name
- filters: eg_filters
- description: eg_description
@ -294,7 +294,7 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- endpoint_group_id: endpoint_group_id_path
Response
--------
@ -338,8 +338,8 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- project_id: project_id
- endpoint_group_id: endpoint_group_id_path
- project_id: project_id_path
Response
--------
@ -363,8 +363,8 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- project_id: project_id
- endpoint_group_id: endpoint_group_id_path
- project_id: project_id_path
Response
--------
@ -391,8 +391,8 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- project_id: project_id
- endpoint_group_id: endpoint_group_id_path
- project_id: project_id_path
Response
--------
@ -416,8 +416,8 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- project_id: project_id
- endpoint_group_id: endpoint_group_id_path
- project_id: project_id_path
Response
--------
@ -441,7 +441,7 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- endpoint_group_id: endpoint_group_id_path
Response
--------
@ -468,7 +468,7 @@ Request
.. rest_parameters:: parameters.yaml
- endpoint_group_id: endpoint_group_id
- endpoint_group_id: endpoint_group_id_path
Response
--------
@ -495,7 +495,7 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id
- project_id: project_id_path
Response
--------

28
api-ref/source/v3-ext/oauth.inc

@ -73,7 +73,7 @@ Request
.. rest_parameters:: parameters.yaml
- description: description
- description: consumer_description
Request Example
---------------
@ -115,7 +115,7 @@ Request
.. rest_parameters:: parameters.yaml
- consumer_id: consumer_id
- consumer_id: consumer_id_path
List consumers
@ -154,7 +154,7 @@ Request
.. rest_parameters:: parameters.yaml
- consumer_id: consumer_id
- consumer_id: consumer_id_path
Response Example
----------------
@ -183,7 +183,7 @@ Request
.. rest_parameters:: parameters.yaml
- consumer_id: consumer_id
- consumer_id: consumer_id_path
Request Example
---------------
@ -318,8 +318,8 @@ Request
.. rest_parameters:: parameters.yaml
- user_id: user_id
- access_token_id: access_token_id
- user_id: user_id_path
- access_token_id: access_token_id_path
Response Example
----------------
@ -347,8 +347,8 @@ Request
.. rest_parameters:: parameters.yaml
- user_id: user_id
- access_token_id: access_token_id
- user_id: user_id_path
- access_token_id: access_token_id_path
List authorized access tokens
@ -368,7 +368,7 @@ Request
.. rest_parameters:: parameters.yaml
- user_id: user_id
- user_id: user_id_path
Response Example
----------------
@ -394,8 +394,8 @@ Request
.. rest_parameters:: parameters.yaml
- user_id: user_id
- access_token_id: access_token_id
- user_id: user_id_path
- access_token_id: access_token_id_path
Show role details for an access token
@ -415,9 +415,9 @@ Request
.. rest_parameters:: parameters.yaml
- user_id: user_id
- role_id: role_id
- access_token_id: access_token_id
- user_id: user_id_path
- role_id: role_id_path
- access_token_id: access_token_id_path
Authenticate with Identity API

126
api-ref/source/v3-ext/parameters.yaml

@ -1,13 +1,13 @@
# variables in header
# variables in path
access_token_id:
access_token_id_path:
description: |
The UUID of the access token.
in: path
required: true
type: string
consumer_id:
consumer_id_path:
description: |
The UUID of the consumer.
in: path
@ -19,13 +19,13 @@ domain_id:
in: path
required: true
type: string
endpoint_group_id:
endpoint_group_id_path:
description: |
The UUID of the endpoint group.
in: path
required: false
type: string
endpoint_id:
endpoint_id_path:
description: |
The endpoint ID.
in: path
@ -43,43 +43,43 @@ name:
in: path
required: true
type: string
policy_id:
policy_id_path:
description: |
The policy ID.
in: path
required: true
type: string
project_id:
project_id_path:
description: |
The UUID of the project.
in: path
required: true
type: string
region_id:
region_id_path:
description: |
The region ID.
in: path
required: true
type: string
role_id:
role_id_path:
description: |
The UUID of the role.
in: path
required: true
type: string
service_id:
service_id_path:
description: |
The service ID.
in: path
required: true
type: string
trust_id:
trust_id_path:
description: |
The trust ID.
in: path
required: true
type: string
user_id:
user_id_path:
description: |
The UUID of the user.
in: path
@ -88,7 +88,7 @@ user_id:
# variables in query
since:
since_query:
description: |
A timestamp used to limit the list of results to events
that occurred on or after the specified time.
@ -106,23 +106,17 @@ allow_redelegation:
in: body
required: false
type: boolean
blob:
consumer_description:
description: |
The policy rule itself, as a serialized blob.
The consumer description.
in: body
required: true
type: object
consumer_id:
description: |
The ID of the consumer.
in: path
required: false
type: string
description:
consumer_id:
description: |
The consumer description.
The ID of the consumer.
in: body
required: false
required: true
type: string
eg_description:
description: |
@ -145,27 +139,27 @@ eg_name:
in: body
required: true
type: string
endpoints:
endpoint_id:
description: |
An ``endpoints`` object.
The endpoint UUID.
in: body
required: true
type: array
id:
type: string
endpoints:
description: |
The ID of the trust.
An ``endpoints`` object.
in: body
required: true
type: string
id_1:
type: array
endpoints_links:
description: |
The endpoint UUID.
The links for the ``endpoints`` resource.
in: body
required: true
type: string
id_2:
type: object
id:
description: |
The ID of the policy.
[WIP]
in: body
required: true
type: string
@ -196,18 +190,6 @@ links:
in: body
required: true
type: object
links_1:
description: |
The links for the ``endpoints`` resource.
in: body
required: true
type: object
links_2:
description: |
The links for the ``policy`` resource.
in: body
required: true
type: object
name_1:
description: |
The role name.
@ -266,6 +248,36 @@ policy:
in: body
required: true
type: object
policy_blob:
description: |
The policy rule itself, as a serialized blob.
in: body
required: true
type: object
policy_id:
description: |
The ID of the policy.
in: body
required: true
type: string
policy_links:
description: |
The links for the ``policy`` resource.
in: body
required: true
type: object
policy_type:
description: |
The MIME media type of the serialized policy
blob. From the perspective of the Identity API, a policy blob can
be based on any technology. In OpenStack, the ``policy.json`` blob
(``type="application/json"``) is the conventional solution.
However, you might want to use an alternative policy engine that
uses a different policy language type. For example,
``type="application/xacml+xml"``.
in: body
required: true
type: string
previous:
description: |
The ``previous`` relative link for the
@ -273,7 +285,7 @@ previous:
in: body
required: true
type: string
project_id_1:
project_id:
description: |
The ID of the project.
in: body
@ -455,7 +467,7 @@ self:
in: body
required: true
type: string
service_id_1:
service_id:
description: |
The UUID of the service to which the endpoint
belongs.
@ -478,6 +490,12 @@ trust_expires_at:
in: body
required: false
type: string
trust_id:
description: |
The ID of the trust.
in: body
required: true
type: string
trust_links:
description: |
A trust links object. Includes ``next``, ``previous``, and ``self`` links for trusts.
@ -523,18 +541,6 @@ trusts:
in: body
required: true
type: array
type:
description: |
The MIME media type of the serialized policy
blob. From the perspective of the Identity API, a policy blob can
be based on any technology. In OpenStack, the ``policy.json`` blob
(``type="application/json"``) is the conventional solution.
However, you might want to use an alternative policy engine that
uses a different policy language type. For example,
``type="application/xacml+xml"``.
in: body
required: true
type: string
url:
description: |
The endpoint URL.

2
api-ref/source/v3-ext/revoke.inc

@ -47,7 +47,7 @@ Request
.. rest_parameters:: parameters.yaml
- since: since
- since: since_query
Request Example
---------------

20
api-ref/source/v3-ext/trust.inc

@ -133,7 +133,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- trust: trust
- id: id
- id: trust_id
- impersonation: impersonation
- trustee_user_id: trustee_user_id
- trustor_user_id: trustor_user_id
@ -194,7 +194,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- trust: trust
- id: id
- id: trust_id
- impersonation: impersonation
- trustee_user_id: trustee_user_id
- trustor_user_id: trustor_user_id
@ -234,7 +234,7 @@ Request
.. rest_parameters:: parameters.yaml
- trust_id: trust_id
- trust_id: trust_id_path
Response Parameters
-------------------
@ -242,7 +242,7 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- trust: trust
- id: id
- id: trust_id
- impersonation: impersonation
- trustee_user_id: trustee_user_id
- trustor_user_id: trustor_user_id
@ -282,7 +282,7 @@ Request
.. rest_parameters:: parameters.yaml
- trust_id: trust_id
- trust_id: trust_id_path
Response Example
----------------
@ -307,7 +307,7 @@ Request
.. rest_parameters:: parameters.yaml
- trust_id: trust_id
- trust_id: trust_id_path
Response Example
----------------
@ -335,8 +335,8 @@ Request
.. rest_parameters:: parameters.yaml
- trust_id: trust_id
- role_id: role_id
- trust_id: trust_id_path
- role_id: role_id_path
Response Example
----------------
@ -361,8 +361,8 @@ Request
.. rest_parameters:: parameters.yaml
- trust_id: trust_id
- role_id: role_id
- trust_id: trust_id_path
- role_id: role_id_path
Response Example
----------------

Loading…
Cancel
Save