openstack/keystone
Code Issues Proposed changes
c7e29560b7
keystone/api-ref/source/v3/policies.inc

207 lines
3.6 KiB
PHP
Raw Normal View History

Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
.. -*- rst -*-
Add missing preamble for v3 and v3-ext The api-ref site had a short blurb about the resources listed in the document, add that back. Change-Id: I2bac40a250a5b73fb70320d598a12c34c359e3c2
2016-07-04 14:35:49 -07:00
==========
Policies
==========
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
A policy is an arbitrarily serialized policy engine rule set to be
consumed by a remote service.
You encode policy rule sets into a blob that remote services can
consume. To do so, set ``type`` to ``application/json`` and specify
policy rules as JSON strings in a ``blob``. For example:
::
{
"blob":{
"foobar_user":[
"role:compute-user"
]
}
}
Create policy
=============
.. rest_method:: POST /v3/policies
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/policies``
[api] add relationship links to v3 Nearly all the "relationship" links are missing in v3 APIs. Added relationship links to v3 API pages. Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8 Partial-Bug: #1609159
2016-08-11 14:37:21 -05:00
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Creates a policy.
Correct normal response codes for policy docs The policy docs were listing 20X http status codes as being Error response codes. This commit fixes the documentation to list 20X http status codes as Normal response codes. Change-Id: Ie39e5261dd185831ea1601da23ed1aba45b1b960
2016-07-13 17:42:27 +00:00
Normal response codes: 201
api-ref: Splitting status lines in API v3. Currently, 'Normal response codes' and 'Error response codes' are in the same line. We should split them. Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
2016-08-25 13:14:34 +07:00
Correct normal response codes for policy docs The policy docs were listing 20X http status codes as being Error response codes. This commit fixes the documentation to list 20X http status codes as Normal response codes. Change-Id: Ie39e5261dd185831ea1601da23ed1aba45b1b960
2016-07-13 17:42:27 +00:00
Error response codes: 413,415,405,404,403,401,400,503,409
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Request
-------
.. rest_parameters:: parameters.yaml
- policy: policy
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
2016-08-05 17:24:26 +07:00
- type: policy_type
- blob: policy_blob_str
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Request Example
---------------
.. literalinclude:: ./samples/admin/policy-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- links: policy_links
- blob: policy_blob_str
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
- policy: policy
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
2016-08-05 17:24:26 +07:00
- type: policy_type
- id: policy_id
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
List policies
=============
.. rest_method:: GET /v3/policies
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/policies``
[api] add relationship links to v3 Nearly all the "relationship" links are missing in v3 APIs. Added relationship links to v3 API pages. Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8 Partial-Bug: #1609159
2016-08-11 14:37:21 -05:00
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Lists policies.
Normal response codes: 200
api-ref: Splitting status lines in API v3. Currently, 'Normal response codes' and 'Error response codes' are in the same line. We should split them. Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
2016-08-25 13:14:34 +07:00
Correct normal response codes for policy docs The policy docs were listing 20X http status codes as being Error response codes. This commit fixes the documentation to list 20X http status codes as Normal response codes. Change-Id: Ie39e5261dd185831ea1601da23ed1aba45b1b960
2016-07-13 17:42:27 +00:00
Error response codes: 413,405,404,403,401,400,503
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Request
-------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- type: policy_type_query
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- links: policy_links
- blob: policy_blob_obj
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
- policies: policies
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
2016-08-05 17:24:26 +07:00
- type: policy_type
- id: policy_id
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Response Example
----------------
.. literalinclude:: ./samples/admin/policies-list-response.json
:language: javascript
Show policy details
===================
.. rest_method:: GET /v3/policies/{policy_id}
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/policy``
[api] add relationship links to v3 Nearly all the "relationship" links are missing in v3 APIs. Added relationship links to v3 API pages. Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8 Partial-Bug: #1609159
2016-08-11 14:37:21 -05:00
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Shows details for a policy.
Normal response codes: 200
api-ref: Splitting status lines in API v3. Currently, 'Normal response codes' and 'Error response codes' are in the same line. We should split them. Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
2016-08-25 13:14:34 +07:00
Correct normal response codes for policy docs The policy docs were listing 20X http status codes as being Error response codes. This commit fixes the documentation to list 20X http status codes as Normal response codes. Change-Id: Ie39e5261dd185831ea1601da23ed1aba45b1b960
2016-07-13 17:42:27 +00:00
Error response codes: 413,405,404,403,401,400,503
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Request
-------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- policy_id: policy_id_path
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- links: policy_links
- blob: policy_blob_obj
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
- policy: policy
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
2016-08-05 17:24:26 +07:00
- type: policy_type
- id: policy_id
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Response Example
----------------
.. literalinclude:: ./samples/admin/policy-show-response.json
:language: javascript
Update policy
=============
.. rest_method:: PATCH /v3/policies/{policy_id}
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/policy``
[api] add relationship links to v3 Nearly all the "relationship" links are missing in v3 APIs. Added relationship links to v3 API pages. Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8 Partial-Bug: #1609159
2016-08-11 14:37:21 -05:00
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Updates a policy.
Normal response codes: 200
api-ref: Splitting status lines in API v3. Currently, 'Normal response codes' and 'Error response codes' are in the same line. We should split them. Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
2016-08-25 13:14:34 +07:00
Correct normal response codes for policy docs The policy docs were listing 20X http status codes as being Error response codes. This commit fixes the documentation to list 20X http status codes as Normal response codes. Change-Id: Ie39e5261dd185831ea1601da23ed1aba45b1b960
2016-07-13 17:42:27 +00:00
Error response codes: 413,415,405,404,403,401,400,503,409
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Request
-------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- policy_id: policy_id_path
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
- policy: policy
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
2016-08-05 17:24:26 +07:00
- type: policy_type
- blob: policy_blob_obj
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Request Example
---------------
.. literalinclude:: ./samples/admin/policy-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- links: policy_links
- blob: policy_blob_obj
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
- policy: policy
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
2016-08-05 17:24:26 +07:00
- type: policy_type
- id: policy_id
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Response Example
----------------
.. literalinclude:: ./samples/admin/policy-update-response.json
:language: javascript
Delete policy
=============
.. rest_method:: DELETE /v3/policies/{policy_id}
Use https for docs.openstack.org references The openstack.org pages now support https and our references to the site should by default be one signed by the organization. Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 13:53:09 -08:00
Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/policy``
[api] add relationship links to v3 Nearly all the "relationship" links are missing in v3 APIs. Added relationship links to v3 API pages. Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8 Partial-Bug: #1609159
2016-08-11 14:37:21 -05:00
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Deletes a policy.
Correct normal response codes for policy docs The policy docs were listing 20X http status codes as being Error response codes. This commit fixes the documentation to list 20X http status codes as Normal response codes. Change-Id: Ie39e5261dd185831ea1601da23ed1aba45b1b960
2016-07-13 17:42:27 +00:00
Normal response codes: 204
api-ref: Splitting status lines in API v3. Currently, 'Normal response codes' and 'Error response codes' are in the same line. We should split them. Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
2016-08-25 13:14:34 +07:00
Correct normal response codes for policy docs The policy docs were listing 20X http status codes as being Error response codes. This commit fixes the documentation to list 20X http status codes as Normal response codes. Change-Id: Ie39e5261dd185831ea1601da23ed1aba45b1b960
2016-07-13 17:42:27 +00:00
Error response codes: 413,415,405,404,403,401,400,503,409
Migrate identity /v3 docs from api-ref repo Docs at [1] have already been converted from WADL (SGML / XML) to RST using fairy-slipper [2]. This commit polish the results from the conversion and migrate the docs to our repository under 'api-ref/source' directory. In addition, it added missing descriptions for access_token_id and consumer_id to 'parameters.yaml'. Polishing the generated RST files include: - Removing unnecessary blank lines; - Removing empty references. Polishing the generated RST files do not include: - Modifying their content; - Modifying file names; - Wrapping lines at the maximum of 79 chars. Updating the documentation will be done after this migration step. This change also adds a tox environment to build the docs using sphinx under 'api-ref/build', which in turn is added to '.gitignore'. Lastly, 'os-api-ref' is added as a test requirement. It provides the sphinx stanzas rest_method and rest_parameter, used to define OpenStack APIs in RST docs. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-23 18:07:59 -03:00
Request
-------
.. rest_parameters:: parameters.yaml
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
2016-08-05 17:24:26 +07:00
- policy_id: policy_id_path
Copy Permalink