The support of updating project or deleting project cascadely has
not yet implemented in the controller [1] and no routed is defined
yet for this feature.
So, remove they from the public doc and can be added back when this
feature is fully implemented in order not to mislead readers.
[1] https://review.openstack.org/#/c/243585/
bp project-tree-deletion
Change-Id: I22b2cb41d44975bca6bc96ba2e3daa61d5029cce
This patch adds the status code table into the api-ref doc for projects.
It brings in a 'status.yaml' file that could be shared by other *.inc
files.
Change-Id: Ic536a4dd686cf9bde70b91f5575e8f3053fd1295
Currently, 'Normal response codes' and 'Error response codes' are
in the same line. We should split them.
Change-Id: Iecfa8849a57dc895f639ab2e7d910a2a8763f83a
Nearly all the "relationship" links are missing in v3 APIs.
Added relationship links to v3 API pages.
Change-Id: If519692a5b48e563719e8cde5c694edad6e01ef8
Partial-Bug: #1609159
Add the following query options to the api-ref:
* parents_as_list (key-only, no value expected)
* subtree_as_list (key-only, no value expected)
* parents_as_ids (key-only, no value expected)
* subtree_as_ids (key-only, no value expected)
Change-Id: Ie9362885d57112c81c7141c4238e9e3d5d3e0431
Closes-Bug: #1609175
The "is_domain" query parameter is missing from GET/UPDATE /v3/projects
documentation in the API site.
Change-Id: I059f7e2ac689ec799dbdcc30c071de26d1603c47
Closes-bug: #1609174
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
This patch fixes up the intro to projects as well as where
we have text for a given API. A follow on patch will fix up
the paramaters, many of which are wrong.
Change-Id: Ia34a9a1c2460f95886d9d9ea0c560fdf94435012
The project documentation was listing 20X http status codes as Error response
codes. This commit corrects the documentation to list 20X status codes as
Normal response codes.
Change-Id: I278d7380d2253b36ee4a4c9ad093f1103d6da256
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
