Merge "api-ref: Correcting V3 Policies APIs"
This commit is contained in:
commit
1f1934bfe8
|
@ -74,18 +74,12 @@ option:
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
policy_id:
|
policy_id_path:
|
||||||
description: |
|
description: |
|
||||||
The policy ID.
|
The policy ID.
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
project_id:
|
|
||||||
description: |
|
|
||||||
The project ID.
|
|
||||||
in: path
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
project_id_path:
|
project_id_path:
|
||||||
description: |
|
description: |
|
||||||
The project ID.
|
The project ID.
|
||||||
|
@ -284,6 +278,13 @@ parents_as_list:
|
||||||
required: false
|
required: false
|
||||||
type: key-only, no value expected
|
type: key-only, no value expected
|
||||||
min_version: 3.4
|
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:
|
project_enabled_query:
|
||||||
description: |
|
description: |
|
||||||
If set to true, then only enabled projects will be returned. Any value
|
If set to true, then only enabled projects will be returned. Any value
|
||||||
|
@ -361,13 +362,6 @@ subtree_as_list:
|
||||||
required: false
|
required: false
|
||||||
type: key-only, no value expected
|
type: key-only, no value expected
|
||||||
min_version: 3.4
|
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:
|
user_id_query:
|
||||||
description: |
|
description: |
|
||||||
Filters the response by a user ID.
|
Filters the response by a user ID.
|
||||||
|
@ -454,18 +448,6 @@ blob:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
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:
|
blob_3:
|
||||||
description: |
|
description: |
|
||||||
The credential itself, as a serialized blob.
|
The credential itself, as a serialized blob.
|
||||||
|
@ -1217,12 +1199,6 @@ links_3:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
type: object
|
||||||
links_4:
|
|
||||||
description: |
|
|
||||||
The links for the ``policy`` resource.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: object
|
|
||||||
links_7:
|
links_7:
|
||||||
description: |
|
description: |
|
||||||
The links for the ``role`` resource.
|
The links for the ``role`` resource.
|
||||||
|
@ -1373,6 +1349,43 @@ policy:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: object
|
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:
|
project:
|
||||||
description: |
|
description: |
|
||||||
A ``project`` object, containing:
|
A ``project`` object, containing:
|
||||||
|
@ -1454,7 +1467,7 @@ project_enabled_update_request_body:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: boolean
|
type: boolean
|
||||||
project_id_response_body:
|
project_id:
|
||||||
description: |
|
description: |
|
||||||
The ID for the project.
|
The ID for the project.
|
||||||
in: body
|
in: body
|
||||||
|
@ -1700,13 +1713,6 @@ type_1:
|
||||||
in: body
|
in: body
|
||||||
required: true
|
required: true
|
||||||
type: string
|
type: string
|
||||||
type_2:
|
|
||||||
description: |
|
|
||||||
The MIME media type of the serialized policy
|
|
||||||
blob.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
type_3:
|
type_3:
|
||||||
description: |
|
description: |
|
||||||
The service type, which describes the API
|
The service type, which describes the API
|
||||||
|
@ -1761,12 +1767,6 @@ user_id_2:
|
||||||
in: body
|
in: body
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
user_id_4:
|
|
||||||
description: |
|
|
||||||
The ID of the user who owns the policy.
|
|
||||||
in: body
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
user_id_5:
|
user_id_5:
|
||||||
description: |
|
description: |
|
||||||
The ID of the user who owns the credential.
|
The ID of the user who owns the credential.
|
||||||
|
|
|
@ -38,10 +38,10 @@ Request
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- policy: policy
|
- policy: policy
|
||||||
- user_id: user_id
|
- user_id: policy_user_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- type: type
|
- type: policy_type
|
||||||
- blob: blob
|
- blob: policy_blob_str
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -54,13 +54,13 @@ Response Parameters
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- user_id: user_id
|
- user_id: policy_user_id
|
||||||
- links: links
|
- links: policy_links
|
||||||
- blob: blob
|
- blob: policy_blob_str
|
||||||
- policy: policy
|
- policy: policy
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- type: type
|
- type: policy_type
|
||||||
- id: id
|
- id: policy_id
|
||||||
|
|
||||||
|
|
||||||
List policies
|
List policies
|
||||||
|
@ -78,20 +78,20 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- type: type
|
- type: policy_type_query
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- user_id: user_id
|
- user_id: policy_user_id
|
||||||
- links: links
|
- links: policy_links
|
||||||
- blob: blob
|
- blob: policy_blob_obj
|
||||||
- policies: policies
|
- policies: policies
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- type: type
|
- type: policy_type
|
||||||
- id: id
|
- id: policy_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -115,20 +115,20 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- policy_id: policy_id
|
- policy_id: policy_id_path
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- user_id: user_id
|
- user_id: policy_user_id
|
||||||
- links: links
|
- links: policy_links
|
||||||
- blob: blob
|
- blob: policy_blob_obj
|
||||||
- policy: policy
|
- policy: policy
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- type: type
|
- type: policy_type
|
||||||
- id: id
|
- id: policy_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -152,12 +152,12 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
|
- policy_id: policy_id_path
|
||||||
- policy: policy
|
- policy: policy
|
||||||
- user_id: user_id
|
- user_id: policy_user_id
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- type: type
|
- type: policy_type
|
||||||
- blob: blob
|
- blob: policy_blob_obj
|
||||||
- policy_id: policy_id
|
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
|
@ -170,13 +170,13 @@ Response Parameters
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- user_id: user_id
|
- user_id: policy_user_id
|
||||||
- links: links
|
- links: policy_links
|
||||||
- blob: blob
|
- blob: policy_blob_obj
|
||||||
- policy: policy
|
- policy: policy
|
||||||
- project_id: project_id
|
- project_id: project_id
|
||||||
- type: type
|
- type: policy_type
|
||||||
- id: id
|
- id: policy_id
|
||||||
|
|
||||||
Response Example
|
Response Example
|
||||||
----------------
|
----------------
|
||||||
|
@ -200,4 +200,4 @@ Request
|
||||||
|
|
||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- policy_id: policy_id
|
- policy_id: policy_id_path
|
||||||
|
|
|
@ -59,7 +59,7 @@ Response Parameters
|
||||||
- description: project_description_response_body
|
- description: project_description_response_body
|
||||||
- domain_id: project_domain_id_response_body
|
- domain_id: project_domain_id_response_body
|
||||||
- enabled: project_enabled_response_body
|
- enabled: project_enabled_response_body
|
||||||
- id: project_id_response_body
|
- id: project_id
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
@ -113,7 +113,7 @@ Response Parameters
|
||||||
- description: project_description_response_body
|
- description: project_description_response_body
|
||||||
- domain_id: project_domain_id_response_body
|
- domain_id: project_domain_id_response_body
|
||||||
- enabled: project_enabled_response_body
|
- enabled: project_enabled_response_body
|
||||||
- id: project_id_response_body
|
- id: project_id
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
@ -150,7 +150,7 @@ Response Parameters
|
||||||
- description: project_description_response_body
|
- description: project_description_response_body
|
||||||
- domain_id: project_domain_id_response_body
|
- domain_id: project_domain_id_response_body
|
||||||
- enabled: project_enabled_response_body
|
- enabled: project_enabled_response_body
|
||||||
- id: project_id_response_body
|
- id: project_id
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
@ -213,7 +213,7 @@ Response Parameters
|
||||||
- description: project_description_response_body
|
- description: project_description_response_body
|
||||||
- domain_id: project_domain_id_response_body
|
- domain_id: project_domain_id_response_body
|
||||||
- enabled: project_enabled_response_body
|
- enabled: project_enabled_response_body
|
||||||
- id: project_id_response_body
|
- id: project_id
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
@ -289,7 +289,7 @@ Response Parameters
|
||||||
- description: project_description_response_body
|
- description: project_description_response_body
|
||||||
- domain_id: project_domain_id_response_body
|
- domain_id: project_domain_id_response_body
|
||||||
- enabled: project_enabled_response_body
|
- enabled: project_enabled_response_body
|
||||||
- id: project_id_response_body
|
- id: project_id
|
||||||
- name: project_name_response_body
|
- name: project_name_response_body
|
||||||
- links: link_response_body
|
- links: link_response_body
|
||||||
- parent_id: project_parent_id_response_body
|
- parent_id: project_parent_id_response_body
|
||||||
|
|
Loading…
Reference in New Issue