8000 Add operationId to Admin REST API for OpenAPI spec generation by klahap · Pull Request #39011 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content

Add operationId to Admin REST API for OpenAPI spec generation - #39011

Closed
klahap wants to merge 1 commit into
keycloak:mainfrom
goquati:main
Closed

klahap wants to merge 1 commit into
keycloak:mainfrom
goquati:main

Conversation

@klahap
@klahap klahap commented Apr 16, 2025
Copy link
Copy Markdown

This PR adds operationId values 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

  • Improves developer experience when generating API clients from the OpenAPI spec.
  • Allows for better naming consistency and predictability in generated code.
  • Enables easier maintenance of custom clients or tooling relying on the OpenAPI spec.

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.

@klahap
klahap requested a review from a team as a code owner April 16, 2025 07:17
Signed-off-by: Klaus Happacher <k.happacher@gmail.com>
@KimToehler
Copy link
Copy Markdown

Great work. I've been waiting for something like this for a long time 👍

@ArieGato
Copy link
Copy Markdown

Is there any status concerning this PR. I would very much like to use it.

@ryumartinez
Copy link
Copy Markdown

Please approve this PR 🙏🙏

@shawkins
Copy link
Copy Markdown
Contributor

@klahap please create an issue for this PR. Then reopen this PR as associated with that issue and with the conflicts resolved.

This is something that is already part of the admin api v2 work, but since the v1 api will be around for quite a while this is still a nice to have improvement.

@jludvice
Copy link
Copy Markdown

Agree it would be usefull to add operationIs to the openapi. Raised issue #50253 to resume this effort.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

0