Add operationId to Admin REST API for OpenAPI spec generation#39011
Open
klahap wants to merge 1 commit intokeycloak:mainfrom
Open
Add operationId to Admin REST API for OpenAPI spec generation#39011klahap wants to merge 1 commit intokeycloak:mainfrom
klahap wants to merge 1 commit intokeycloak:mainfrom
Conversation
Signed-off-by: Klaus Happacher <k.happacher@gmail.com>
|
Great work. I've been waiting for something like this for a long time 👍 |
|
Is there any status concerning this PR. I would very much like to use it. |
|
Please approve this PR 🙏🙏 |
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
4 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.
This PR adds
operationIdvalues to the Keycloak Admin REST API endpoints.These
operationIds are included in the generated OpenAPI spec, which makes it easier for client generator tools (like OpenAPI Generator or Swagger Codegen) to produce readable and consistent method names.Motivation
Let me know if you’d like the naming scheme to follow a different convention, or if you'd prefer to limit this to a subset of endpoints.