Commit Graph

23 Commits

Author SHA1 Message Date
erus 8cc91845fb Change port and version on v3 endpoints example
On doc/source/api_curl_examples.rst the GET /v3/endpoints
example response section had http://localhost:35357/v2.0 but
API v2 was removed so it was modified to http://localhost:5000/v3.

Change-Id: Ic51c2d530296c9a92245b34b50fea5e82036d163
2018-10-27 15:56:26 -03:00
wangxiyuan 203787c37f Clean up token extra code
Originally, the "extra" in token data is generated by auth plugin
and then will be return to users within token data.

In Kilo, the "extra" in token data was deprecated[1], after that
if the auth plugin generate the "extra", a warning log will be
raised. To stop the warning, the auth plugins should stop
generating "extra" field.

After two releases, in Mitaka, the "extra" in token data was
removed[2], but the "extra" was still created by default as an
empty dict {}. Actually, "extra" should not be created any more
in Mitaka because Keystone has warned the auth plugins for two
releases.

Now in Rocky, it's safe enough to remove the "extra" from token
issue flow at all since it has never been used from Mitaka. The
only concern for the out tree plugins about the removal is that
if they still put "extra" into auth_context, Keystone will raise
KeyError. But can it be happened? Only if the out tree plugins
ignore the warning in Kilo, and still contain "extra" but never
use them from Mitaka. For most auth plugins which follow the
Keystone deprecation step, this patch is a silent change.

[1]: https://review.openstack.org/#/c/162662
[2]: https://review.openstack.org/#/c/249480

Change-Id: I828cc0ad3ac265abdfea2e1571806add128ae51e
2018-08-02 11:52:10 +08:00
Colleen Murphy 25996a8534 Add docs for application credentials
Add documentation in the User section on managing, using, and rotating
application credentials.

Since application credential support didn't make it into
python-openstackclient in the Queens release, show examples using
python-keystoneclient.

Change-Id: I24bc51d2f3741771ba321fc05d49fd111aa76c15
2018-02-14 20:33:48 +01:00
Lance Bragstad 4b172f0a05 Update curl request documentation to remove v2.0
The curl examples we keep in our documentation contain examples for
interacting with the now removed v2.0 APIs. This commit removes those
examples since we no long support v2.0, except for the ec2token API
until the T release. The curl examples didn't have any v2.0 ec2token
examples.

Change-Id: I7e16421873de1c2ebf13db971bef80a2d74e5823
2018-02-06 22:19:17 +00:00
Samriddhi Jain 8e82fc9e4d Migrated docs from devdocs to user docs
Some docs present in developer documentation section
are related to APIs and API examples. Following the
reorganisation of docs in four categories, those docs
are migrated to the user/API doc section.

Change-Id: Id7f7b5601295036a54c6840015d0f0b4b2d23a21
2017-06-27 18:28:44 +05:30
Steve Martinelli 41bb06a69e clean up developer docs
* remove online_schema_migration_examples since they overlap
  with a section in the best practices doc

* move developer docs to doc/source/devref and rename where
  appropriate

* moved content in developer.rst around, so the more often used
  functions (releasenotes, docs, sample config and tests are
  near the top).

* general clean up

Change-Id: If00b6535564644ff1f5b78e232edbac5d6e686f0
2016-11-22 23:06:38 -05:00
malei 1bb8f18680 Wrong usage of "an"
an historical anomaly -> a historical anomaly
an token -> a token

Change-Id: Id4b50e2e3e6f5a0c65107ddf6faeb7d6c45ca9ef
2015-10-17 12:14:48 +08:00
Dave Chen 9e885418f9 `api_curl_examples.rst` is out of date
Part of CURL response is not accurate anymore
- There will be no service catalog returned if we get
  a token from a existing token.
- Miss `audit_ids` in the response.

Closes-Bug: #1459532
Change-Id: I81db8db37f4ffdad01f976a16c14f45f411db76d
2015-05-29 15:58:34 +08:00
Dave Chen cf877cab9c Update Get API version Curl example
Currently, `curl http://0.0.0.0:35357` and `curl http://0.0.0.0:35357/v2.0/`
no longer have the same response, since keystone has it's V3 APIs. Update
the doc to differentiate the two Curl example.

Change-Id: I08f5e3bd502ebd78ea775ea4135b5c3ffb80e9c7
2015-04-16 22:11:39 +08:00
Lance Bragstad 2ef3cdf307 Remove unused test case
Getting a user's roles isn't going to be implemted according to bug reports
(bug 1418015 and bug 933565). This commit removes the test case from
test_content_types.py and removes documentation from example curl calls.

Change-Id: Id317cc28d961316be6a7b8278c5242382784f10f
Related-Bug: 933565
Related-Bug: 1418015
2015-02-09 21:19:25 +00:00
Steve Martinelli 5d376ba9ad Update docs to no longer show XML support
implements bp removed-as-of-kilo

Change-Id: Ib78132093cc0ab9b964013b20734ada1039f0679
2014-12-16 22:51:26 -05:00
David Stanek f15471f5fd Corrects minor spelling mistakes
Change-Id: Ib603861ad19a525c112153ac3799f2cbe453d4f7
2014-06-24 13:50:31 +00:00
Brant Knudson 6b75e2a9ea Add v3 curl examples
There were curl examples for v2 APIs, but none for V3. This change
adds some that I've found handy.

Also, added an example of getting the revocation list using the v2
API. This is handy for checking token revocations.

Partial-Bug: #1283943

Change-Id: I228dc479b29db730873ba95207e4ace85c20e1fe
2014-06-10 16:34:48 -05:00
Brant Knudson 8eadd341aa Use code-block for curl examples
The code-block directive wasn't used for literal blocks in the
curl examples document, so they weren't highlighted nicely.

Change-Id: If0165ec666003682695c06a9b4ae840016b8355b
2014-06-10 16:34:47 -05:00
Brant Knudson 17da215005 Fix curl example refs in docs
The keystone developer docs index page had two links to the same
API examples page: "Service API Examples Using Curl" and
"Admin API Examples Using Curl". This is because the API examples
document had 2 top-level sections.

Partial-Bug: #1283943

Change-Id: I8204268aa482e59f9108d515b69e9c37a12a9e08
2014-06-02 09:05:00 -05:00
Andreas Jaeger 646100b2cb Fix version links to docs.openstack.org
Remove PDF link.
Replace deep html links with links to the docs.openstack.org site.

Change-Id: Ic7c2218bf43a221e8d753a910fdfb2243851214d
Closes-Bug: #1313127
2014-05-07 21:45:17 +02:00
Krsna Widmer ae34f84f27 Update curl api example to specify tenant
In the keystone api_curl_examples document, the curl example for
"POST /tokens" did not specify a tenant. This example utilized
the default tenant, which is not commonly used. Changed the
example to include "tenantName" as part of the example to prevent
future confusion.

DocImpact

Closes-Bug: #1269739

Change-Id: Iaad8c7c5a32bc6cff38c938dd36365cddd6741cb
2014-03-03 09:29:27 -08:00
Dolph Mathews b62369fae0 Remove versionId, versionInfo, versionList from examples
I recall these attributes being discussed at one point
(pre-incubation?), but have never been supported by OpenStack and don't
appear to be defined in any v2.0 WADL/XSD specification.

Change-Id: Ia5b691972c70456e3d62750173e2bfc6e9aec55a
Closes-Bug: 1273831
2014-01-29 14:48:51 -06:00
Florent Flament 5f97336fbc Fixes the v2 GET /extensions curl example in the documentation.
Change-Id: I2bca0acd4fbc19547be6f5b872ad873938779894
2013-12-12 11:31:36 +01:00
Sean Winn 0331f8a58a Changed header from LLC to Foundation based on trademark policies
Fixes: Bug 1214176

Change-Id: Ie937081a53d377671b8b88f422642c8131002f88
2013-09-05 15:03:32 -05:00
Joe Gordon ac6ee6901c Fix spelling mistakes
git ls-files | misspellings -f -
Source: https://github.com/lyda/misspell-check

Change-Id: Icbd2412aa65bc8135e5dcd83ee69e94f5a42f7a2
2013-02-12 11:17:31 -08:00
Alan Pevec bdc8e76405 fix broken link
sections have implicit hyperlink targets
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#implicit-hyperlink-targets

bug 1027109

Change-Id: I984695c16f77e7939c5aebe65060abc13e3514ca
2012-07-27 17:08:17 +02:00
Monty Taylor f8ba5af130 Align with project configs.
* docs in doc/ rather than docs/
* write out changelog from git
* freeze requirements file

Change-Id: If28d5414f7b2747fd6835546c45e1acfac8a3563
2012-03-01 11:42:42 -08:00