Browse Source

api-ref: Correcting V3 Policies APIs

Fixed in Create/List/Show/Update APIs.
http://developer.openstack.org/api-ref/identity/v3/index.html#policies

Change-Id: Ia3e4caf80c783ac2213444e9d6fecf39018187d8
Partial-Bug: #1610777
changes/36/351636/6
Anh Tran 5 years ago
parent
commit
ceaa09dcd7
  1. 92
      api-ref/source/v3/parameters.yaml
  2. 60
      api-ref/source/v3/policies.inc
  3. 10
      api-ref/source/v3/projects.inc

92
api-ref/source/v3/parameters.yaml

@ -74,18 +74,12 @@ option:
in: path
required: true
type: string
policy_id:
policy_id_path:
description: |
The policy ID.
in: path
required: true
type: string
project_id:
description: |
The project ID.
in: path
required: true
type: string
project_id_path:
description: |
The project ID.
@ -284,6 +278,13 @@ parents_as_list:
required: false
type: key-only, no value expected
min_version: 3.4
policy_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
project_enabled_query:
description: |
If set to true, then only enabled projects will be returned. Any value
@ -361,13 +362,6 @@ subtree_as_list:
required: false
type: key-only, no value expected
min_version: 3.4
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:
description: |
Filters the response by a user ID.
@ -454,18 +448,6 @@ blob:
in: body
required: true
type: string
blob_1:
description: |
The policy rule set itself, as a serialized blob.
in: body
required: true
type: string
blob_2:
description: |
The policy rule itself, as a serialized blob.
in: body
required: true
type: object
blob_3:
description: |
The credential itself, as a serialized blob.
@ -1217,12 +1199,6 @@ links_3:
in: body
required: true
type: object
links_4:
description: |
The links for the ``policy`` resource.
in: body
required: true
type: object
links_7:
description: |
The links for the ``role`` resource.
@ -1373,6 +1349,43 @@ policy:
in: body
required: true
type: object
policy_blob_obj:
description: |
The policy rule itself, as a serialized blob.
in: body
required: true
type: object
policy_blob_str:
description: |
The policy rule set itself, as a serialized blob.
in: body
required: true
type: string
policy_id:
description: |
The policy ID.
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.
in: body
required: true
type: string
policy_user_id:
description: |
The ID of the user who owns the policy.
in: body
required: true
type: string
project:
description: |
A ``project`` object, containing:
@ -1454,7 +1467,7 @@ project_enabled_update_request_body:
in: body
required: false
type: boolean
project_id_response_body:
project_id:
description: |
The ID for the project.
in: body
@ -1700,13 +1713,6 @@ type_1:
in: body
required: true
type: string
type_2:
description: |
The MIME media type of the serialized policy
blob.
in: body
required: true
type: string
type_3:
description: |
The service type, which describes the API
@ -1761,12 +1767,6 @@ user_id_2:
in: body
required: false
type: string
user_id_4:
description: |
The ID of the user who owns the policy.
in: body
required: true
type: string
user_id_5:
description: |
The ID of the user who owns the credential.

60
api-ref/source/v3/policies.inc

@ -38,10 +38,10 @@ Request
.. rest_parameters:: parameters.yaml
- policy: policy
- user_id: user_id
- user_id: policy_user_id
- project_id: project_id
- type: type
- blob: blob
- type: policy_type
- blob: policy_blob_str
Request Example
---------------
@ -54,13 +54,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- user_id: user_id
- links: links
- blob: blob
- user_id: policy_user_id
- links: policy_links
- blob: policy_blob_str
- policy: policy
- project_id: project_id
- type: type
- id: id
- type: policy_type
- id: policy_id
List policies
@ -78,20 +78,20 @@ Request
.. rest_parameters:: parameters.yaml
- type: type
- type: policy_type_query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- user_id: user_id
- links: links
- blob: blob
- user_id: policy_user_id
- links: policy_links
- blob: policy_blob_obj
- policies: policies
- project_id: project_id
- type: type
- id: id
- type: policy_type
- id: policy_id
Response Example
----------------
@ -115,20 +115,20 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- policy_id: policy_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- user_id: user_id
- links: links
- blob: blob
- user_id: policy_user_id
- links: policy_links
- blob: policy_blob_obj
- policy: policy
- project_id: project_id
- type: type
- id: id
- type: policy_type
- id: policy_id
Response Example
----------------
@ -152,12 +152,12 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id_path
- policy: policy
- user_id: user_id
- user_id: policy_user_id
- project_id: project_id
- type: type
- blob: blob
- policy_id: policy_id
- type: policy_type
- blob: policy_blob_obj
Request Example
---------------
@ -170,13 +170,13 @@ Response Parameters
.. rest_parameters:: parameters.yaml
- user_id: user_id
- links: links
- blob: blob
- user_id: policy_user_id
- links: policy_links
- blob: policy_blob_obj
- policy: policy
- project_id: project_id
- type: type
- id: id
- type: policy_type
- id: policy_id
Response Example
----------------
@ -200,4 +200,4 @@ Request
.. rest_parameters:: parameters.yaml
- policy_id: policy_id
- policy_id: policy_id_path

10
api-ref/source/v3/projects.inc

@ -59,7 +59,7 @@ Response Parameters
- description: project_description_response_body
- domain_id: project_domain_id_response_body
- enabled: project_enabled_response_body
- id: project_id_response_body
- id: project_id
- links: link_response_body
- name: project_name_response_body
- parent_id: project_parent_id_response_body
@ -113,7 +113,7 @@ Response Parameters
- description: project_description_response_body
- domain_id: project_domain_id_response_body
- enabled: project_enabled_response_body
- id: project_id_response_body
- id: project_id
- links: link_response_body
- name: project_name_response_body
- parent_id: project_parent_id_response_body
@ -150,7 +150,7 @@ Response Parameters
- description: project_description_response_body
- domain_id: project_domain_id_response_body
- enabled: project_enabled_response_body
- id: project_id_response_body
- id: project_id
- links: link_response_body
- name: project_name_response_body
- parent_id: project_parent_id_response_body
@ -213,7 +213,7 @@ Response Parameters
- description: project_description_response_body
- domain_id: project_domain_id_response_body
- enabled: project_enabled_response_body
- id: project_id_response_body
- id: project_id
- name: project_name_response_body
- links: link_response_body
- parent_id: project_parent_id_response_body
@ -289,7 +289,7 @@ Response Parameters
- description: project_description_response_body
- domain_id: project_domain_id_response_body
- enabled: project_enabled_response_body
- id: project_id_response_body
- id: project_id
- name: project_name_response_body
- links: link_response_body
- parent_id: project_parent_id_response_body

Loading…
Cancel
Save