Commit Graph

31 Commits

Author SHA1 Message Date
Kristi Nikolla d23965aaf1 Update api-ref for federated objects in user
Also includes a release note.

Change-Id: I72a5d461488b50f20b59d1288016514a2b8f71e5
Closes-Bug: 1816076
2020-04-10 00:49:35 +00:00
Kristi Nikolla 8153a9d592 Add expiring user group memberships on mapped authentication
When a federated user authenticates, they are added to their
mapped groups during shadowing.

Closes-Bug: 1809116

Change-Id: I19dc400b2a7aa46709b242cdeef82beaca975ff3
2020-04-07 19:30:57 -04:00
Colleen Murphy 131f7ddd4e Update API version for access rules
This change updates the minor API version for the new access rules
feature for application credentials, and also adds documentation for
the new feature to the API reference as well as a release note.

bp whitelist-extension-for-app-creds

Change-Id: I8a03223df63877a4f86fbe7e9fa382fdd96c5934
2019-09-14 03:14:45 -07:00
Vishakha Agarwal af7800454b Update api-ref for revocation list OS-PKI
Since PKI tokens are removed and  OS-PKI API
is deprecated, updating api-ref for it [1].

[1] https://review.opendev.org/#/c/672334

Change-Id: I06a9d07225977469341851ea604df75976b105ca
2019-08-10 13:32:05 +00:00
Zuul 462bb4dcb6 Merge "Fix wrong urls" 2019-01-23 12:10:42 +00:00
Adrian Turjak a011fb6789 bump Keystone version for Stein
Change-Id: I2c3aa095f0ceb28a97a61db27e595bc504b75bd0
2019-01-22 15:34:06 +13:00
Mike Chen def21c6991 Fix wrong urls
These urls in the docs are invalid probably because of the renaming
that happened with commit ccb3d340e4

Change-Id: Ie3dc315c8b7ff7faa2a6c24d9c074a6fc42a54a8
2019-01-18 19:27:57 +08:00
Colleen Murphy 46b12eb29a Fix api-ref v3.9 release identifier
In Pike we didn't make any significant API additions. In Queens we ended
up bumping the release version twice, once in ba61e84 for project tags
and again in a50fafd2 for system scope. Update the v3.9 identifier to
refer to Queens to avoid misinforming people.

This unfortunately might read more confusingly as now there are two
Queens additions.

Change-Id: I9a0ba7ad713a3c9eb6b0464ed30ff4e6d62d3c74
2018-10-25 11:57:47 +02:00
Colleen Murphy 0bac1d7e8a Update API version to 3.11
Co-authored-by: Lance Bragstad <lbragstad@gmail.com>

Change-Id: I62b8e05b3e347724218d044dfe73640fff9cc78c
2018-10-16 16:32:29 +02:00
Colleen Murphy 7c2a77d3cd Add release names to api-ref
Add the corresponding release cycle name to the API version number to
assist in correlating new API features with releases.

Change-Id: I24bf0d9d654436338e1ffc688278a5a93eb1e219
2018-10-05 12:33:52 +02:00
Lance Bragstad 1175a356fc Update 3.10 versioning to limits and system scope
This should have been done before the queens release. I noticed it
when looking at the API reference and only seeing application
credentials listed under 3.10 information.

Change-Id: I6f2d9551d15061dbe99e9228c097e735910a41db
2018-02-21 20:11:16 +00:00
Suramya Shah 06ab0c9c4e Reorganize api-ref: v3 os-pki
Reorganize as per the documentation session at PTG:
https://etherpad.openstack.org/p/queens-ptg-keystone-doc-cleanup

Change-Id: Ia0409c9f257b592bbca4ee33183b2a7c868291bb
2018-02-07 11:46:19 -06:00
Colleen Murphy 0462ff8001 Add api-ref for application credentials
bp application-credentials

Change-Id: I803cfb2a9bb6502dabc8fd93385dfce29bf3bea5
2018-01-27 12:00:23 +01:00
wangxiyuan a616462260 Add api-ref for unified limits
This patch added the api-ref for unified limits

bp: unified-limits
Change-Id: Iebf90c4145d34b02e125ab2fb2a2323df22e5b7c
2018-01-25 16:33:25 +08:00
Lance Bragstad eefc69e119 Add system role assignment documentation
Hot off the press! This commit contains all the API reference
documentation for using system role assignments. It is also
consistent with the api-reference conventions we established
during the Queens PTG in Denver.

bp system-scope

Change-Id: Ic49555423d7ca7415d7c8546c5dfa7368ad8fe7e
2018-01-17 22:51:17 +00:00
Suramya Shah 3c7a0f32e1 Re-organize api-ref: v3 inherit.inc
Re-organize as per the documentation session at PTG:
https://etherpad.openstack.org/p/queens-ptg-keystone-docs-cleanup

Change-Id: Ic689e78b88d91f00835361a7061bf3198c567cef
2017-12-30 16:04:16 +05:30
Gage Hugo 0579dec0b9 Add project tags api-ref documentation and reno
This change creates a new page describing the usage of project tags
as well as adds in project tag information into existing projects
refs. The added document highlights the properties of a project
tag, the new API calls created, filtering/searching uses, and examples
for each.

This change also creates a release note for the changes made
that add project tags.

Change-Id: Icff11da9412378ae59c6f392f98b05475c7c501d
Partially-Implements: bp project-tags
2017-10-17 17:56:29 -05:00
Jenkins 6621c78107 Merge "Updated URLs in docs" 2017-08-11 15:49:12 +00:00
Gage Hugo 6c8ea57210 Add description for relationship links in api-ref
This adds a section within the index file that describes what a
relationship link is and what it is used for in terms of each
operation within keystone. There will be a relationships section
in both v3 and v3-ext.

This should help clarify any confusion that may arise when a user is
viewing the api-ref about what the relationship links are.

Change-Id: I9c6b7959ed6ea682c565c515af0cf509b6a64e5d
Closes-Bug: #1674676
2017-08-09 20:59:55 +00:00
Samriddhi Jain 82785553dd Updated URLs in docs
With the docs migration and re-arrangement, some docs
have been shifted to new places, however the referenced
links are still old. Some of them give 404 error or
just point to the home page. This patch fixes those URLs.

Change-Id: Ie6b18ab3d4aa346dac8436dd426277fee4f07fcd
2017-08-09 23:46:33 +05:30
Samriddhi Jain dac0e0572e Reorganised api-ref index page
Currently in the keystone API documentation page located at,
https://developer.openstack.org/api-ref/identity/index.html
all the sections and sub-sections appear at the same depth.
This makes the ordering very untidy and confusing.

This patch reorganises the appearance of sections and
sub-sections at the index page.

Change-Id: I55ae0102236805591e653c153618dec2af510c63
2017-07-13 19:40:07 +05:30
Lance Bragstad eb274afdb4 Document and add release note for HEAD APIs
Now that all GET APIs have a corresponding HEAD API, we can add a
formal statement about support and a release note.

Change-Id: Ia5569311f91d87b40d064595ce2c8d69461fbab7
Closes-Bug: 1696574
2017-06-27 21:15:44 +00: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
Steve Martinelli b0f9237570 API Documentation for user password expires
New proposal on how we document the password_expires_at query.

bp pci-dss-query-password-expired-users

Co-Authored-By: Samuel Pilla <sp516w@att.com>

Change-Id: I81facd0a84f5c05f72294eb1a143c7632b2406e1
2016-12-12 22:07:03 +00:00
Jamie Lennox fcebc2fa8d Allow fetching an expired token
A service user from auth_token middleware should be able to fetch a
token that has expired within a certain window so that long running
operations can finish.

Implements bp: allow-expired
Change-Id: I784f719be88481048f5aa7a79d34a54907438cf3
2016-11-28 04:07:26 +00:00
Steve Martinelli f4a30aac66 [api] add changelog from 3.0 -> 3.7
This section was missed from the migration (from specs to api-ref).

Change-Id: Id7243ea0f2dbfbb4b579489fdb4f75c7a4b7b940
Closes-Bug: 1637214
2016-11-18 09:09:08 +00:00
Tin Lam 095ed9187b Add api-ref /auth/tokens/OS-PKI/revoked (v3)
The v3 endpoint documentation /v3/auth/tokens/OS-PKI/revoked is missing
in /api-ref.  This patch set adds the documentation for v3.
A separate patch set will be submitted for v2.

Change-Id: I3db3356d24cc8885012756016a90a0996fcf14f5
Partial-Bug: #1626778
2016-10-31 20:05:00 +00:00
Clenimar Filemon ab252d58dc Move OS-INHERIT api-ref from extensions to core
Move inheritance API-ref to main Identity API-ref [1]. The docs need to
be updated, though. I think it's better to move them first, then update to
match keystone-specs docs.

[1] Ia838dff1863b1b77472079b32783ae31557b1ef5

Change-Id: I6a6a59bba9c15ac7678e0b20d248dfb4c03881c7
2016-07-14 14:27:49 -03:00
Steve Martinelli ebccd23b78 Add missing preamble for v3 and v3-ext
The api-ref site had a short blurb about the resources listed
in the document, add that back.

Change-Id: I2bac40a250a5b73fb70320d598a12c34c359e3c2
2016-07-04 14:35:49 -07:00
Steve Martinelli e55dfe490c move OAUTH1 API to extensions
as part of the move, also make the extension names consistent

Change-Id: I779b948a3ba63c95bb1c4650bc76c7259f0828fe
2016-07-04 14:04:51 -07:00
Steve Martinelli 4f183727f1 generate separate index files for each api-ref
currntly, no index.html file is generated for any of the APIs,
which should be required to migrate over to the api-site.

check the generated build.

Change-Id: Ib290c7412ff426b3061c5ad7535c8cb8310500fa
2016-07-04 13:03:55 -07:00