Skip to content

Fix invalid OpenAPI specifications#40401

Closed
maelick wants to merge 1 commit intokeycloak:mainfrom
maelick:openapi-fix-26.2.5-squashed
Closed

Fix invalid OpenAPI specifications#40401
maelick wants to merge 1 commit intokeycloak:mainfrom
maelick:openapi-fix-26.2.5-squashed

Conversation

@maelick
Copy link

@maelick maelick commented Jun 11, 2025

  • Admin REST resources: changes boolean and integer arguments with default values to basic java in order to fix openapi errors
  • fix getClientRoleComposites endpoint path param client-uuid by renaming it to child-client-uuid

Closes #40400

Note: I am unsure what is the reason behind using object types rather than primitive Java types for boolean and integer arguments. If the change has no impact on the Keycloak behavior, maybe it would be better to change them all to use the primitive types?

@maelick maelick requested a review from a team as a code owner June 11, 2025 08:31
* Admin REST resources: changes boolean and integer arguments with default values to basic java in order to fix openapi errors
* fix getClientRoleComposites endpoint path param client-uuid by renaming it to child-client-uuid

Closes keycloak#40400

Signed-off-by: Maëlick Claes <maelick.claes@epiroc.com>
@maelick maelick force-pushed the openapi-fix-26.2.5-squashed branch from 43354e0 to cd71be0 Compare June 11, 2025 08:31
@shawkins
Copy link
Contributor

Unfortunately the original issue was already closed due to lack of updates, but the concern remains valid.

@maelick and @RiRa12621 please open new / more targeted issues. Note there has been a subsequent PR opened to address just the client-uuid issue #46016

The same considerations will be present for admin api v2 - and we are actively looking at alternative client implementation there #43167 including the go client so ideally we shouldn't hit these problems moving foward.

Note: I am unsure what is the reason behind using object types rather than primitive Java types for boolean and integer arguments. If the change has no impact on the Keycloak behavior, maybe it would be better to change them all to use the primitive types?

I believe the usage of object types is to be consistent with allowing for optional parameters. It should also allow for passing an explicit null.

But as you say that doesn't mesh well with using a Default. Let's see if anyone else weighs in on whether updating the Default or changing to a primitive makes sense here.

cc @keycloak/cloud-native

@shawkins shawkins closed this Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Invalid OpenAPI spec for Admin REST

2 participants