Sphinx 1.5 complains about "Could not lex literal_block as "json".
Highlighting skipped." - and fails to build.
Change the problematic code to use javascript for highlighting - it's
only a json snippet, not a full json file.
Change-Id: I65558119dcc166bd25f12568b480498cac80c653
This patch removes any unused parameters in the v2 and v3 api's.
In order to find which parameters were unused, I wrote a script
that found all the parameters used in the `parameters.yaml` files,
then is searched the same api directory (ex: v3/, v3-ext/, etc.)
for any reference to these parameters. Anything unreferenced was
flagged and then removed.
Script: http://cdn.pasteraw.com/8cdh0e76aqhtliuh874veautr7as8k7
Change-Id: I1558ac94e1041f9fbb1d6713b394c4f97f997ada
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
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 change builds on the previous one by cleaning up all the wording
around associations and makes them consistent regardless of the
associations being direct or via endpoint groups.
Change-Id: I9582c5e8dbb83c37abcb432835dd7b609bd7841c
Closes-Bug: 1654613
The OS-EP-FILTER documentation needed some work. The wording around
several of the examples didn't make a whole lot of sense. And some of
the requests were copy/pastes from other examples.
This change attempts to clarify the need for endpoint groups and how
they can be useful. This patch also moves the endpoint group CRUD
documentation to the beginning of the section, which leaves the rest
of the section to explain how to associate projects to endpoints
directly or use endpoint groups. Previously, the endpoint group CRUD
was in the middle of the section and made the flow the document jump
around a bit.
Change-Id: I1f6cbecc5c3a4c8e86a73a3cfed4b9a09e43b31f
Partial-Bug: 1654613
An Identity Provider (IdP) should be mapped to a domain. This patch
updates the documentation and creates a release note recommending the
domain_id parameter.
Depends-On: Id18b8b2fe853b97631bc990df8188ed64a6e1275
Partial-Bug: #1642687
Change-Id: I1cb749371175169662dbb5fa8feafe403fb1c39b
The ability to list endpoint associations for projects only requires
the project ID as a parameter. The documentation was advertising that
the endpoint ID was also required, which seems like a rogue
copy/paste.
Change-Id: I2101ebaab0bdcbc9347e854dbe7f522c1c6320e8
The sample request and simplified representation was incorrect.
Change the sample to match the result, the sample was used in
other spots but did not affect the other APIs.
Also fixed the sentence describing valid filters that can be
used; only `region_id` is supported, not `region` [1].
[1] e49a95ff6e/keystone/catalog/controllers.py (L484)
Change-Id: Id460b85d37acc0cba9246ace6a338a315080b10b
When reading the OS-FEDERATION API documentation, it is not clear how
to find the ID of the token when requesting either an unscoped or
scoped token. Token requests for the OS-FEDERATION API work the same
way as for the standard API, which is that the token ID is returned in
the X-Subject-Token header, so let's just mention that in the
OS-FEDERATION API documentation.
Change-Id: I6e9743d9001684f0d05ace119509f643c8b8e363
This patch validates that a mapping exists when adding or updating
a federation protocol.
Change-Id: I996f94d26eb0f2c679542ba13a03bbaa4442486a
Closes-Bug: #1571878
This patch corrects some parameter's type such as 'type: list'
to 'type: array' or 'type: array of...' to 'type: array' because we
don't have 'type: list' in 'JSON Schema primitive types' [1]
[1] http://json-schema.org/latest/json-schema-core.html#anchor8
Change-Id: Ic638ef48fcf0f60c55cec975ee20a71d1830b319
Currently, 'Normal response codes' and 'Error response codes' are
in the same line. We should split them.
Change-Id: I1684ebb668a6fe8339dc428dfd70d11ae1dca97c
Also change the "authorized access token" to "access token" in
the doc since there are only request token, authorized request token,
and access token. "access token" itself has implied it has been
authorized. "authorized access token" is ambiguous.
The route of the API is defined here:
https://github.com/openstack/keystone/blob/master/keystone/oauth1/routers.py
Change-Id: I97a588c0ff08288995b266e9346c6b47f50caef6
Nearly all the "relationship" links are missing in v3 APIs
Added relationship links to v3-ext API pages.
Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e
Closes-Bug: #1609159
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.
Moving Assertion API to its own file is one of the TODO comments left
there, which is being addressed in this change.
Change-Id: I0ad565619744eb7f7b3c2fb33971d8d8ab4e22ea
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.
Moving Auth API to its own file is one of the TODO comments left there,
which is being addressed in this change.
Change-Id: Icd0c293c1a326c9bf3fe1ca01c96e3908ac33db3
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.
Moving List Projects and Domains API to its own file is one of the TODO
comments left there, which is being addressed in this change.
Change-Id: I78572d6605c7eddd9c7b41bb2e982dc10728f46e
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.
Moving Service Provider API to its own file is one of the TODO
comments left there, which is being addressed in this change.
Change-Id: Iabe3d443f01b173024620aae629558d228c2cd10
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.
Moving Mapping API to its own file is one of the TODO comments left
there, which is being addressed in this change.
Change-Id: I070f2807dc683d470ef4e5e6d758c3998009b2be
Change I2423030bd0849c051d22f63bf60b6a5f41f72574 migrated Federation
api-ref docs into keystone repository.
Moving Identity Provider API to its own file is one of the TODO
comments left there, which is being addressed in this change.
Change-Id: I5c5b26c2d4c9920d6b9642eaf0fc47ed5bffb3cb
- add /v3/ to all routes;
- switch from 'localhost:port' and 'identity:port' endpoints to
'example.com/identity';
- fix typo.
Change-Id: If0d90ebab78e93fc9395b0e02436853a4ecbfa73
This commit migrates OS-FEDERATION docs from the spec repo to keystone server
repo under api-ref/source/v3-ext/ directory.
Change-Id: I2423030bd0849c051d22f63bf60b6a5f41f72574