Some parameters of similar name would follow the convention
such as `region_id` and `region_id_1` which gave no good
information as to the differences.
This patch changes these names to help give such information.
Change-Id: I2dec61ed06042990ff54e86c02dc3fca9d566366
As per the bug, 'name' and 'nme' are not part of the 'endpoint'
table and were being assigned to the 'extras' column. This is
why they are not being validated.
The endpoint docs also show that `region_id` is not optional, even
though it is. This updates the docs to reflect optional `region_id`.
Closes-Bug: #1579014
Change-Id: I085b75c59767eb96b3bdfe3b887e5e2639122a34
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
This patch reorders the sections about services and endpoints which were
previously interleaved randomly. After the reordering, all services APIs
appear before all endpoint APIs so browsing through the APIs would be
much easier. This patch aslo changes the representations of status codes
using the new stanza in os-api-ref.
Change-Id: I89aabd3d9a336f5f6f65aaca51353f2d23b4cb2a
This patch fixes the following problems found in the api doc:
- The 'service_id' field should not appear in a service create request;
- The 'enabled', 'description' fields should be optional when doing a
service update.
Change-Id: Iac91a9f2d29a458f1e3eb93e64fea6a508b9980c
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
`endpoint` doesn't need `name` property by default, remove
them from the doc, this change make it align with V3 API SPEC.
Change-Id: I61429b39086d15aed7d2315d7c3971727a9fa419
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