Commit Graph

548 Commits

Author SHA1 Message Date
Zuul fc10ccbc8c Merge "Replace CRLF by LF" 2024-03-29 17:24:57 +00:00
Stephen Finucane 802cc846aa api-ref: Fix indentation
Additional paragraphs of a bullet list should be indented by two spaces
to align with the first paragraph, e.g.

  - A bullet list item

    Additional detail

Rather than:

  - A bullet list item

     Additional detail

The latter results in the additional paragraphs being rendered as block
quotes.

Change-Id: I18cd39e65fd8d43691c940a6e849765755c46c2e
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2024-02-27 13:13:01 +00:00
Takashi Kajinami a989cd7f0a Replace CRLF by LF
... because LF is now commonly used as newline code.

Change-Id: I1fddfcbdb06179c096b6a271350d52365ff958ca
2024-01-27 12:38:10 +09:00
Zuul f20d143a19 Merge "api-ref: Correct app credentials auth response" 2023-07-10 13:59:54 +00:00
Zuul 8304eefb97 Merge "Add doc of OAuth2.0 Client Credentials Grant Flow" 2023-06-27 16:23:30 +00:00
Yusuke Niimi b438bf1efe Add doc of OAuth2.0 Client Credentials Grant Flow
This patch provides Keystone documents for OAuth2.0 client
authorization. The specification about new API is added to API
Reference. Also OAuth2.0 client credentials grant flow is added to
admin guide.

Implement: blueprint oauth2-client-credentials-ext
Change-Id: I6ac5835fb64a4e81f34f7b8631d255b2bb7f66da
2023-04-17 08:04:36 +00:00
Stephen Finucane 434dbe1e73 api-ref: Correct app credentials auth response
In change I322a40404d8287748fe8c3a8d6dc1256d935d84a we switched from an
'auth_credential_required' field in the response to an 'auth_credential'
object. Correct the api-ref.

While we're alphabetize the response parameters.

Change-Id: Ie5dd375c4922cee895e4dfe25defb70a0b5e21a7
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2023-02-03 17:16:56 +00:00
chenwei cdeba521b6 Change error response status code in master branch
Closed bug: #1916662

Change-Id: I3ae502580588af42ac5d5f9fc6718a639b443e98
2022-06-13 11:00:58 +08:00
Sam Morrison 0cc00cf12a Fix delete a limit api doc
Incorrectly said registered limit as opposed to just limit

Change-Id: I50856cd3488e2d13a6c35d097515b87f104690e1
2022-04-14 16:05:30 +10:00
Hironori Shiina 081a675dbd Fix response code of 'Revoke Token' in api-ref
'DELETE /v3/auth/tokens' responds with 204(No content) when it succeeds.

Change-Id: Ib5c96ab890d0fd01bed96e568d7c9191cc847d55
2021-11-29 15:02:53 -05:00
Vishakha Agarwal 1b75e56a08 Improve the update description for limits in api-ref
The update registered limit updates the specified registered
limit. It will be wrong to describe it as "Update registered
limits". It should be singular. Same for updating a project
limit. This patch fixes the same.

Change-Id: Ie28f0661bd4402ebb8f9de37fff4c36b925c3b04
2020-08-13 15:50:49 +05:30
Zuul 952959fb87 Merge "Fix api-ref for list endpoints" 2020-08-05 19:22:16 +00:00
Vishakha Agarwal 311184c394 Fix api-ref for list endpoints
According to the [1], list endpoints filter also have
``region_id`` parameter which is missing from api-ref.
This patch updates the same in api-ref.

[1]https://github.com/openstack/keystone/blob/master/keystone/api/endpoints.py#L78

Change-Id: I3982c98506f945b47c056ed1c9e5eee673a3662a
2020-07-28 17:40:54 +00:00
Zuul 5feffb0319 Merge "Add ignore_user_inactivity user option" 2020-07-15 16:15:53 +00:00
Zuul 8639b38133 Merge "Add "explicit_domain_id" to api-ref" 2020-07-07 19:16:35 +00:00
Pavlo Shchelokovskyy c9c655a1e1 Add ignore_user_inactivity user option
this option allows to override the
[security_compliance]disable_user_account_days_inactive setting from
config on per-user basis.

Co-Authored-By: Vishakha Agarwal <agarwalvishakha18@gmail.com>

Change-Id: Ida360e215426184195687bee2a800877af33af04
Closes-Bug: #1827431
2020-07-07 20:40:52 +05:30
Zuul 557e3e44dc Merge "Adding note for create a project without domain info" 2020-07-06 20:50:33 +00:00
Raildo Mascena 12020a0b83 Adding note for create a project without domain info
When we create a project, using a project scoped token,
without add the domain_id or domain information in the
project creation parameters, this project will be
automatically created on the default domain.

Change-Id: Ib7a2d47c2204b0639f029c3079f4fa86ee78e3a9
2020-07-03 11:36:06 -03:00
Vishakha Agarwal ee9be2e92b Add "explicit_domain_id" to api-ref
In [1] a new parameter to domain API was added. This patch
updates the api-ref about the same.

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

Change-Id: If288c3406e2fa840f698fec83d9643cfc0584f53
Closes-Bug: #1884062
2020-06-30 17:30:14 +00:00
Zuul 704bb2b9af Merge "Switch to newer openstackdocstheme and reno versions" 2020-05-30 09:44:11 +00:00
Andreas Jaeger 7820cafffe Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_name to use project as name.
Set openstackdocs_pdf_link to link to PDF file.

Remove docs requirements from lower-constraints, they are not installed.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I320a69816b4101bb76b88448881f3177c892ea92
2020-05-21 13:43:22 +00:00
Victor Coutellier e74a61f091 Add service name filter to service list api-ref
Filter services by name is possible[1] but not documented in the
Keystone api-ref[2]. This commit add the filter in the doc.

[1] https://github.com/openstack/keystone/blob/master/keystone/api/services.py#L37
[2] https://docs.openstack.org/api-ref/identity/v3/?expanded=list-services-detail#list-services

Change-Id: I91dea69a4c30fe37a23f3697cb8511fed0bfcec7
Closes-Bug: #1877851
2020-05-15 12:02:22 +00:00
Zuul 91fa019034 Merge "Expiring Group Memberships API - Allow set idp authorization_ttl" 2020-04-10 09:37:50 +00:00
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
Zuul b3d3735138 Merge "Add expiring user group memberships on mapped authentication" 2020-04-10 00:18:37 +00:00
Zuul f5fd13f26f Merge "Expiring Group Membership Driver - Add, List Groups" 2020-04-10 00:18:35 +00:00
Kristi Nikolla c18956f198 Expiring Group Memberships API - Allow set idp authorization_ttl
This patch extends the identity provider API to receive, return
and set the authorization_ttl on an identity provider.

Change-Id: I3c58da290d52149e307280042ed20447da4687f7
Partial-Bug: 1809116
2020-04-09 01:59:58 +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
Kristi Nikolla d8938514fe Expiring Group Membership Driver - Add, List Groups
Modify the base driver and SQL driver to support expiring group
memberships.

Additions to the SQL Driver to support listing expiring groups
for user.

Change-Id: I7d52cd2003f511483619a429de57201df4990209
Partial-Bug: 1809116
Depends-On: I4294a879071dde07e5eb1da4df133de8032e1059
2020-04-07 19:25:01 -04:00
Colleen Murphy 34f6144a47 Document the "immutable" resource option
Roles, projects, and domains can accept "immutable" as a resource
option. This change explains the option in the admin guide and updates
the API reference to mention it.

Change-Id: I95926927472f6418f97a08fea0ebd56da04ce7a5
Related-bug: #1823258
2020-03-17 14:33:29 -07:00
Zuul 4cd555608c Merge "Correcting api-ref for users" 2020-03-17 20:30:24 +00:00
Vishakha Agarwal 271c09bb53 Correcting api-ref for users
The "options" is not "optional" in user api responses.
This patch removes the 'optional' from the same and also updates
string with the format to be used while creating api-ref in
keystone.

Change-Id: I848f168215800b42480d14f1f1905d8843ed3faa
2020-03-10 17:13:19 +00:00
Andreas Jaeger e715a4bbd0 Doc Cleanup
Remove unused git_cmd from api-ref.
Remove html_last_updated_fmt and latex_engine setting,
these are done by openstackdocstheme nowadays.

Change-Id: I1c63f83b3fa074f9fa136e0b89bba0586756bc56
2020-02-23 18:16:01 +01:00
Zuul db81fee635 Merge "Add name in GET API of application credentials" 2019-12-13 22:21:30 +00:00
Vishakha Agarwal 2c0623bab7 Add name in GET API of application credentials
This patch adds the missing name parameter from
api-ref of GET API application credentials [1]

[1] 30f676a1dd/keystone/api/users.py (L567)

Change-Id: Ia70e6fe5219d9f631cc8a9d4749d1c885345e327
2019-12-12 11:57:36 +05:30
Vishakha Agarwal 5d6b8cb3db Fix api-ref roles response description
This patch removes the optional infront of the description
of roles API response. Since the response APIs fields are not
optional [1].

[1]https://docs.openstack.org/api-ref/identity/v3/?expanded=list-roles-detail#roles

Change-Id: I8ada8d600bf3c096df7fe9f993f8a38b2e80bf86
2019-12-06 15:15:41 +05:30
Vishakha Agarwal c7331ccd24 Fix wrong interface description
In [1] it response parameters, it is written interface body  string
(Deprecated in v3.2) The geographic location of the service endpoint.
This patch fixes the wrong documentation.

[1] https://docs.openstack.org/api-ref/identity/v3/?expanded=list-endpoints-detail,show-endpoint-details-detail#service-catalog-and-endpoints

Change-Id: I09063dfec1afcd823f5fa190626e8719a202fc28
2019-10-09 15:36:07 +05:30
Lance Bragstad 8e67249d5b Add default roles and scope checking to project tags
This commit makes it so that project tags adhere to system-scope and
also incorporates default roles into the policy checks by default.

Change-Id: Ie36df5677a08d7d95f056f3ea00eda05e1315ea5
Closes-Bug: 1844194
Closes-Bug: 1844193
Related-Bug: 1806762
2019-09-19 02:48:39 +00: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 bca92f99b8 Merge "Add new attribute to the federation protocol API" 2019-07-30 18:49:30 +00:00
Andreas Jaeger 66cf87743c Remove broken api-ref link
There's no file identity-api-v3.md, remove link to it.

Change-Id: I9f71936c7b5416978bd119439855801145f4cd46
2019-07-26 15:30:31 +02:00
Zuul a0aa21c237 Merge "Allow to filter endpoint groups by name" 2019-07-20 14:33:11 +00:00
erus bf67b3c884 Add new attribute to the federation protocol API
Modify the FederationProtocolModel class and add the
remote_id_atributte to the federation_protocol table.
Add the respective migration and tests files. And
also modify the schema to expect a remote_id_attribute
property.

Closes-bug: #1724645

Co-authored-by: Colleen Murphy<colleen@gazlene.net>

Change-Id: I9802c8a5c187bae16de89893ca8639b01cd7cb1b
2019-07-19 10:46:23 -07:00
Jose Castro Leon 6cdb3a8374 Allow to filter endpoint groups by name
While using the openstack client command, the list on endpoint filters
cannot be filtered by name. This adds an optional parameter on the query
to allow the name to be specified as filter. This fixes the behavior on
OSC to search.

Change-Id: Ia1cbc9f4ded8f2494b1bf7ba5e953be0dfaf11f5
Closes-Bug: #1828565
2019-07-18 08:57:50 +02:00
wangxiyuan a38dcfe99d [api-ref] Fix nocatalog description for unscoped token
Unscoped token body never contains catalog, no matter the
nocatalog parameter is True or False.

This patch fixed the api-ref issue.

Change-Id: Ic3a09e3b25c20c5ac840f82631a1da1cbd1eb281
2019-06-19 17:11:35 +08:00
Zuul f7552fd6e8 Merge "Move redelegation fields out of extras" 2019-05-04 19:42:41 +00:00
wanghui de4d72c5f2 Use openstackdocstheme according to guide
This change alters the api-ref's conf.py to follow the documentation[1].
Functionally, this results in the api-ref using the api_ref theme
options, which adds a dropdown menu to the other API references instead
of to unrelated documentation, and deduplicates the headers.

[1] https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I706301130efac6b37d97ebd814d9987370d76692
2019-04-15 19:47:58 -07:00
Jorge Munoz 2b9d409f0d Move redelegation fields out of extras
The trust SQL backend uses the extras column to store the
redeletegated_trust_id and redelegation_count info. It's
better to make them first class citizens and give them
their own columns.

This change does not add redelegation_trust_id to the trust schema
because this value is set by the token context, not by the user. We also
remove it from the api-ref example to avoid confusion about this.

Co-Authored-By: David Stanek <dstanek@dstanek.com>
Co-Authored-By: Alexander Makarov <amakarov@mirantis.com>
Change-Id: If496152e40d2213a03faad5645667220fddfcf62
2019-04-12 20:27:34 -07:00
Lance Bragstad 1edb5c3bb4 trivial: fix broken link in trust API reference
Change-Id: I10e45f46085cd5575981cf32d81c2aa71f31d6c8
2019-03-13 19:45:49 +00:00