openstack
/
keystone
Code Issues Proposed changes
keystone/api-ref/source/v3/samples/admin
History
Samuel de Medeiros Queiroz 9a5395f1b2 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-24 09:58:23 -03:00
..
auth-password-explicit-unscoped-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-explicit-unscoped-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-project-scoped-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-project-scoped-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-unscoped-request-with-domain.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-unscoped-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-unscoped-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-user-name-unscoped-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-password-user-name-unscoped-response-HTTP.txt Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-token-scoped-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-token-scoped-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-token-unscoped-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
auth-token-unscoped-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
credential-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
credential-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
credential-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
credential-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
credential-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
credentials-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-group-option-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-group-option-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-group-option-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-group-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-group-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-group-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-config-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-group-roles-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-group-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domain-user-roles-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
domains-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
endpoint-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
endpoint-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
endpoint-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
endpoint-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
endpoint-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
endpoints-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
group-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
group-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
group-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
group-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
group-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
group-users-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
groups-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
identity-version-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
identity-versions-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
policies-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
policy-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
policy-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
policy-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
policy-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
policy-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-enable-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-group-roles-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
project-user-roles-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
projects-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
region-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
region-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
region-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
region-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
region-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
regions-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-assignments-effective-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-assignments-effective-list-response.txt Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-assignments-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-assignments-list-response.txt Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
role-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
roles-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
service-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
service-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
service-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
service-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
service-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
services-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
token-validate-request.txt Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-create-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-create-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-groups-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-password-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-projects-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-show-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-update-request.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
user-update-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00
users-list-response.json Migrate identity /v3 docs from api-ref repo 2016-05-24 09:58:23 -03:00