Docs for Client v2: Generated API documentation from the OpenAPI specification#48001
Open
michalvavrik wants to merge 1 commit intokeycloak:mainfrom
Open
Docs for Client v2: Generated API documentation from the OpenAPI specification#48001michalvavrik wants to merge 1 commit intokeycloak:mainfrom
michalvavrik wants to merge 1 commit intokeycloak:mainfrom
Conversation
Unreported flaky test detectedIf the flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR. org.keycloak.testsuite.model.session.UserSessionProviderModelTest#testStreamsMarshallingKeycloak CI - Store Model Tests |
Member
Author
|
@keycloak/cloud-native I have put everyone in the review request, but it is your call if you have time and want to review. Thanks |
Contributor
|
Adding the hold label to not accidentally merge this. |
mabartos
reviewed
Apr 15, 2026
* Closes: keycloak#47983 Generates Admin API v2 API documentation, with examples how to use individual clients (Java, JS, CLI). Signed-off-by: Michal Vavřík <[email protected]>
f7072f6 to
708626b
Compare
Member
Author
|
Resolved merge conflicts and adapted to the current main. |
This was referenced Apr 27, 2026
Unreported flaky test detectedIf the flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR. org.keycloak.testsuite.model.session.OfflineSessionPersistenceTest#testPersistenceClientSessionsMultipleNodesKeycloak CI - Store Model Tests |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
apidirectory does not appear in the https://github.com/keycloak/keycloak-web/blob/main/guides.yaml, hence it should be safe to treat is as "first iteration" and we hold the keys to "when we want to show this documentation to users"Generates Admin API v2 API documentation, with examples how to use individual clients (Java, JS, CLI).
Example how HTML page is generated:
index.html
If you want to test it locally, you can do:
and navigate to:
keycloak/docs/guides/target/generated-docs/api/index.html