keystone

Commit Graph

Author	SHA1	Message	Date
Gage Hugo	6db31c8590	api-ref: Add missing parameter tables to tenant This adds response tables to multiple tenant API calls within the identity admin API. Change-Id: I78ff3d981ed0a1d4dc42d0a81b0369e7275d4d85 Closes-Bug: #1572168	7 years ago
Dave Chen	f8231b8daf	Variables in URL path should be required These inline parameters are not optional, they are required to call the API, this patch change all of them from optional to required. Change-Id: I6b1c8893b12e5e88f887c884b9812eb1005dcbdd	7 years ago
Samuel de Medeiros Queiroz	11d6b32fd4	Migrate identity /v2-admin 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 v2 admin docs to our repository under 'api-ref/source' directory. Missing parameters definitions were added. It also removes admin-extensions.inc as it did not contain any information. The operation of listing roles for user had it title renamed so there is not a duplicate label warning when running the api-ref job. The API examples were moved into '/v2-admin/samples'. 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. [1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3 [2] https://github.com/russell/fairy-slipper Change-Id: I39d6c6197a939d77fc462c091051760d6b626d80	7 years ago

Author

SHA1

Message

Date

Gage Hugo

6db31c8590

api-ref: Add missing parameter tables to tenant

This adds response tables to multiple tenant API calls within
the identity admin API.

Change-Id: I78ff3d981ed0a1d4dc42d0a81b0369e7275d4d85
Closes-Bug: #1572168

Dave Chen

f8231b8daf

Variables in URL path should be required

These inline parameters are not optional, they are required to call the
API, this patch change all of them from optional to required.

Change-Id: I6b1c8893b12e5e88f887c884b9812eb1005dcbdd

Samuel de Medeiros Queiroz

11d6b32fd4

Migrate identity /v2-admin 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 v2
admin docs to our repository under 'api-ref/source' directory. Missing
parameters definitions were added. It also removes admin-extensions.inc
as it did not contain any information.

The operation of listing roles for user had it title renamed so there
is not a duplicate label warning when running the api-ref job.

The API examples were moved into '/v2-admin/samples'.

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.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: I39d6c6197a939d77fc462c091051760d6b626d80

3 Commits (2ca0db2d62017ccf101f92d03ae5afe7db07c6f8)