Commit Graph

6 Commits

Author SHA1 Message Date
Colleen Murphy 34f6144a47 Document the "immutable" resource option
Roles, projects, and domains can accept "immutable" as a resource
option. This change explains the option in the admin guide and updates
the API reference to mention it.

Change-Id: I95926927472f6418f97a08fea0ebd56da04ce7a5
Related-bug: #1823258
2020-03-17 14:33:29 -07:00
Gage Hugo 0579dec0b9 Add project tags api-ref documentation and reno
This change creates a new page describing the usage of project tags
as well as adds in project tag information into existing projects
refs. The added document highlights the properties of a project
tag, the new API calls created, filtering/searching uses, and examples
for each.

This change also creates a release note for the changes made
that add project tags.

Change-Id: Icff11da9412378ae59c6f392f98b05475c7c501d
Partially-Implements: bp project-tags
2017-10-17 17:56:29 -05:00
Gage Hugo c32a1723e8 Add missing comma to json sample
This change adds a missing comma to the
project-update-response sample json in order to have valid
json within the example response.

Change-Id: If4a70a5f99f2d3ac5f812272b2138f95adefe9ff
2017-07-24 17:09:20 -05:00
Henry Nash 0b49d43e5b Fix up the api-ref request/response parameters for projects
A number of the examples are also updated, since not all of
them were valid combinations of domain_id, parent_id and
is_domain.

Change-Id: Id642762cd6acfdf6142b24caf3de1d16db599065
2016-07-21 06:07:43 +01:00
Clenimar Filemon 3c47ba4118 Update identity endpoint in v3 and v3-ext samples
Change 'http://localhost:5000/v3', 'http://localhost:35357/v3' and
'http://identity:35357/v3' to 'http://example.com/identity/v3'.

Change-Id: I68d67bb35a8d411fa4535b63771780d0dda1c225
2016-07-15 04:05:04 +00:00
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