Commit Graph

87 Commits

Author SHA1 Message Date
Andreas Jaeger
6d2a7171ad Fix api-ref building with sphinx 1.5
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
2017-03-05 08:21:29 +01:00
Samuel Pilla
4f4f8a7394 Remove unused api parameters
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
2017-02-07 09:45:02 -06:00
Samuel Pilla
c90db0375e Renaming of api parameters
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
2017-02-03 15:23:40 -06:00
Eric Brown
30d9095d28 Use https for docs.openstack.org references
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
2017-01-30 16:05:08 -08:00
Lance Bragstad
d4129c239c [api-ref] Clean up OS-EP-FILTER association docs
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
2017-01-09 15:07:21 +00:00
Jenkins
74a6416136 Merge "[api-ref] Clean up OS-EP-FILTER documentation" 2017-01-08 08:07:07 +00:00
Lance Bragstad
6e71105ddc [api-ref] Clean up OS-EP-FILTER documentation
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
2017-01-08 04:55:29 +00:00
Jenkins
15f7013213 Merge "Fix region_id responses and requests to be consistent" 2017-01-07 00:48:18 +00:00
Jenkins
06238796c2 Merge "Update docs to require domain_id when registering Identity Providers" 2017-01-07 00:16:11 +00:00
Ronald De Rose
74af136478 Update docs to require domain_id when registering Identity Providers
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
2017-01-06 19:09:36 +00:00
Lance Bragstad
62ae2e4db2 Fix region_id responses and requests to be consistent
Change-Id: I6f6ad1b004f3e8c58dd941756039609f0a8bb7cf
2017-01-06 16:53:32 +00:00
Lance Bragstad
3838cff27c Remove endpoint_id parameter from EP-FILTER docs
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
2017-01-06 16:45:37 +00:00
Steve Martinelli
131c8c1f0c [api] fix ep filter example
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
2017-01-06 11:41:26 -05:00
Colleen Murphy
22233747d2 Document token header in federation auth response
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
2016-11-28 09:06:25 -03:00
Samuel Pilla
2e70ecd8ce Document OS-SIMPLE-CERT Routes
Document certificates and OS-SIMPLE-CERT routes.

Change-Id: I528c3eb27a5226a4da17a3c3aa2ca3ccc65a5a39
Closes-Bug: #1626779
2016-11-01 08:26:00 -04:00
Ronald De Rose
de8fbcf9a0 Validate mapping exists when creating/updating a protocol
This patch validates that a mapping exists when adding or updating
a federation protocol.

Change-Id: I996f94d26eb0f2c679542ba13a03bbaa4442486a
Closes-Bug: #1571878
2016-10-20 19:12:04 +00:00
Nguyen Phuong An
5c9fa41834 [api-ref] Correcting parameter's type
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
2016-09-06 04:17:38 +00:00
Jenkins
618a2f5fb4 Merge "api-ref: Splitting status lines in API v3-ext." 2016-08-29 15:40:56 +00:00
Jenkins
94fcbd5886 Merge "[api] add relationship links to v3-ext" 2016-08-29 03:52:03 +00:00
Anh Tran
17f96bb875 api-ref: Splitting status lines in API v3-ext.
Currently, 'Normal response codes' and 'Error response codes' are
in the same line. We should split them.

Change-Id: I1684ebb668a6fe8339dc428dfd70d11ae1dca97c
2016-08-25 13:21:06 +07:00
Jenkins
df26e3ae73 Merge "Fix the wrong URI for the OAuth1 extension in api-ref." 2016-08-21 11:06:25 +00:00
Dave Chen
1531b3ca06 Fix the wrong URI for the OAuth1 extension in api-ref.
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
2016-08-20 10:28:46 +00:00
gage hugo
cb51cb4037 [api] add relationship links to v3-ext
Nearly all the "relationship" links are missing in v3 APIs

Added relationship links to v3-ext API pages.

Change-Id: Ie2e71c45c85f33d3cff49d06dcdbd76f0cf1ac2e
Closes-Bug: #1609159
2016-08-17 09:01:09 -05:00
Anh Tran
b6744a6412 api-ref: Fix parameters attributes
Changing 'required' of parameters 'in path' to 'true'.

Change-Id: Ib1e46914045ea9dc7b65b7a209f0fe55cac03b5f
2016-08-17 10:46:23 +07:00
Jenkins
1f52138284 Merge "Detail Federation Service Provider APIs in api-ref" 2016-08-13 02:21:46 +00:00
Jenkins
a4be6d998c Merge "Detail Fed Projects and Domains APIs in api-ref" 2016-08-13 02:02:53 +00:00
Jenkins
d8a79d2b7e Merge "add a header for the federation APIs" 2016-08-13 02:02:46 +00:00
Jenkins
342fda486c Merge "Detail Federation Mapping APIs in api-ref docs" 2016-08-13 02:00:31 +00:00
Jenkins
39510dd6c4 Merge "Detail Federation Auth APIs in api-ref docs" 2016-08-13 01:40:05 +00:00
Jenkins
5dff33b608 Merge "Detail Federation Assertion APIs in api-ref docs" 2016-08-13 01:39:57 +00:00
Jenkins
d2d3c0c2bb Merge "Detail IdP APIs in api-ref docs" 2016-08-13 01:28:18 +00:00
Samuel de Medeiros Queiroz
963c23cd22 Detail Federation Service Provider APIs in api-ref
Change-Id: I2a784f235f3dcd7ec0a29f5d260b9ac286a5cdf8
2016-08-12 19:21:24 -03:00
Samuel de Medeiros Queiroz
5d2fd076c3 Detail Fed Projects and Domains APIs in api-ref
Change-Id: Ifab067287e67ed9a5cb5dd806221d29d240f0241
2016-08-12 18:28:21 -03:00
Steve Martinelli
46b71ef23b add a header for the federation APIs
Change-Id: I9799c7690a8baf4ab87de3ed12b1e3099ae68e22
2016-08-12 17:12:54 -04:00
Samuel de Medeiros Queiroz
30ded5078b Detail Federation Mapping APIs in api-ref docs
Change-Id: I1eec58a853a04abeed537c26a088610e40c6b42c
2016-08-12 18:11:42 -03:00
Samuel de Medeiros Queiroz
b62acaa3c0 Detail Federation Auth APIs in api-ref docs
Change-Id: Ifc30c58589fd56b67c3b8f865926e78aab5c04b8
2016-08-12 17:03:09 -03:00
Samuel de Medeiros Queiroz
ec5b0cb0d5 Detail Federation Assertion APIs in api-ref docs
Change-Id: I66b468e40aea70e6b2cb297157f8d15aeee43880
2016-08-12 16:20:12 -03:00
Samuel de Medeiros Queiroz
960967e9aa Detail IdP APIs in api-ref docs
Change-Id: Ic478a53c92d5f9fa70adb7a3aae014c1ff1df0df
2016-08-12 18:31:00 +00:00
Anh Tran
e4a82b3da1 api-ref: Renaming parameters of V3-ext APIs
Change-Id: I7f0ab81e3f8c0799bbcbbcd5a849603d7c2bde3a
Partial-Bug: #1610777
2016-08-11 13:36:30 +07:00
Samuel de Medeiros Queiroz
8eb67a9e01 Move Assertion API to its own file
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
2016-08-03 01:58:02 +00:00
Samuel de Medeiros Queiroz
62d0175ada Move Federation Auth API to its own file
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
2016-08-02 13:18:19 -03:00
Samuel de Medeiros Queiroz
edd5827199 Move List Projects and Domains API to its own file
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
2016-08-02 13:07:07 -03:00
Samuel de Medeiros Queiroz
34dd18c2c2 Move Service Provider API to its own file
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
2016-08-02 13:04:45 -03:00
Samuel de Medeiros Queiroz
fc9cfb76c5 Move Mapping API to its own file
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
2016-08-02 12:52:33 -03:00
Steve Martinelli
85570dc678 refactor idp to its own file
for comparison

Change-Id: Ia1becc2fa36f095e30f306c6436bd180fb8760a2
2016-07-30 20:35:19 -07:00
Samuel de Medeiros Queiroz
0f6fa0e3d3 Move Identity Provider API to its own file
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
2016-07-29 15:28:04 -03:00
Clenimar Filemon
ab7a7458e1 Improve os-federation docs
- add /v3/ to all routes;
- switch from 'localhost:port' and 'identity:port' endpoints to
  'example.com/identity';
- fix typo.

Change-Id: If0d90ebab78e93fc9395b0e02436853a4ecbfa73
2016-07-25 22:39:23 -03:00
Samuel de Medeiros Queiroz
53b5b99785 Migrate OS-FEDERATION from specs repo
This commit migrates OS-FEDERATION docs from the spec repo to keystone server
repo under api-ref/source/v3-ext/ directory.

Change-Id: I2423030bd0849c051d22f63bf60b6a5f41f72574
2016-07-17 03:27:18 +00:00
Steve Martinelli
64fbbeda58 clean up OAUTH API
lots of small fixes here

Change-Id: I2211d8ff06915a640b115f91ced939d764ea24e2
2016-07-15 13:43:13 +00:00
Steve Martinelli
534f57de93 Add relationship links to OAUTH APIs
These were taken directly from the specs repo

Change-Id: I227841dabd0b2e944d89d2110bc6d52dd982a884
2016-07-15 09:39:57 -04:00