Add OpenAPI and OpenAPI-UI to management interface #41853

robson90 · 2025-08-13T18:16:13Z

Replacement PR for: #39834

Adds support for OpenAPI and OpenAPI-UI(Swagger) on the management interface.

Paths are:
<KEYCLOAK_MANAGEMENT_INTERFACE>/openapi
<KEYCLOAK_MANAGEMENT_INTERFACE>/openapi-ui

mabartos · 2025-08-14T06:53:43Z

@robson90 Nice work! Just a few things:

Fix the `HelpCommandDistTest`

Execute:

KEYCLOAK_REPLACE_EXPECTED=true mvn clean install -f quarkus/tests/integration/pom.xml -Dtest=HelpCommandDistTest

Build error logs

I see there are some error logs coming from the OpenAPI. It'd be good to try to resolve it as it could show us gaps in our OpenAPI spec, but it's out of scope of this PR. I'm ok to have it like that for now.

EDIT: I see there are also present during the build/reaugmentation phase. We should ignore it.
You can add the quarkus.log.category."io.smallrye.openapi.runtime.scanner.dataobject".level=off to the application.properties in quarkus/runtime. Would be good to create a new issue for resolving these soft errors and reference the issue URL in the application.properties.

[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.admin.v2.ClientRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.admin.v2.ClientRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.util.Map<java.lang.String, java.lang.Object>>
[WARNING] [io.quarkus.deployment.steps.ReflectiveHierarchyStep] Unable to properly register the hierarchy of the following classes for reflection as they are not in the Jandex index:
        - org.keycloak.TokenCategory (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.AccessToken > org.keycloak.TokenCategory)
        - org.keycloak.partialimport.PartialImportResults (source: SmallRyeOpenApiProcessor > null > org.keycloak.partialimport.PartialImportResults)
        - org.keycloak.representations.AccessToken (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.AccessToken)
        - org.keycloak.representations.IDToken (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.IDToken)
        - org.keycloak.representations.adapters.action.GlobalRequestResult (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.adapters.action.GlobalRequestResult)
        - org.keycloak.representations.idm.AdminEventRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.AdminEventRepresentation)
        - org.keycloak.representations.idm.ClientInitialAccessCreatePresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.ClientInitialAccessCreatePresentation)
        - org.keycloak.representations.idm.ClientRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.ClientRepresentation)
        - org.keycloak.representations.idm.ClientScopeRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.ClientScopeRepresentation)
        - org.keycloak.representations.idm.CredentialRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.CredentialRepresentation)
        - org.keycloak.representations.idm.ErrorRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.ErrorRepresentation)
        - org.keycloak.representations.idm.EventRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.EventRepresentation)
        - org.keycloak.representations.idm.FederatedIdentityRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.FederatedIdentityRepresentation)
        - org.keycloak.representations.idm.GroupRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.GroupRepresentation)
        - org.keycloak.representations.idm.IdentityProviderRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.IdentityProviderRepresentation)
        - org.keycloak.representations.idm.ManagementPermissionReference (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.ManagementPermissionReference)
        - org.keycloak.representations.idm.MappingsRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.MappingsRepresentation)
        - org.keycloak.representations.idm.MemberRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.MemberRepresentation)
        - org.keycloak.representations.idm.OrganizationRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.OrganizationRepresentation)
        - org.keycloak.representations.idm.RealmEventsConfigRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.RealmEventsConfigRepresentation)
        - org.keycloak.representations.idm.RealmRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.RealmRepresentation)
        - org.keycloak.representations.idm.RoleRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.RoleRepresentation)
        - org.keycloak.representations.idm.UserProfileMetadata (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.UserProfileMetadata)
        - org.keycloak.representations.idm.UserRepresentation (sources: SmallRyeOpenApiProcessor > null > org.keycloak.admin.ui.rest.model.BruteUser, SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.UserRepresentation)
        - org.keycloak.representations.idm.UserSessionRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.UserSessionRepresentation)
        - org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.authorization.AbstractPolicyRepresentation)
        - org.keycloak.representations.idm.authorization.PolicyEvaluationResponse (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.authorization.PolicyEvaluationResponse)
        - org.keycloak.representations.idm.authorization.PolicyProviderRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.authorization.PolicyProviderRepresentation)
        - org.keycloak.representations.idm.authorization.PolicyRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.authorization.PolicyRepresentation)
        - org.keycloak.representations.idm.authorization.ResourceRepresentation (source: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.authorization.ResourceRepresentation)
        - org.keycloak.representations.idm.authorization.ScopeRepresentation (sources: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.authorization.ResourceRepresentation > java.util.Set > org.keycloak.representations.idm.authorization.ScopeRepresentation, SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.authorization.ScopeRepresentation)
        - org.keycloak.representations.userprofile.config.UPConfig (sources: SmallRyeOpenApiProcessor > null > org.keycloak.representations.idm.RealmRepresentation > org.keycloak.representations.userprofile.config.UPConfig, SmallRyeOpenApiProcessor > null > org.keycloak.representations.userprofile.config.UPConfig)
Consider adding them to the index either by creating a Jandex index for your dependency via the Maven plugin, an empty META-INF/beans.xml or quarkus.index-dependency properties.
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.IdentityProviderRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.IdentityProviderMapperRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.GroupRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.GroupRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.UserRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.lang.String>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ComponentTypeRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ComponentRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ClientRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.UserSessionRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ClientScopeRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.UserSessionRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ClientScopeRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.authorization.ScopeRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.util.Map<java.lang.String, java.lang.String>>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RoleRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ComponentTypeRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.ClientInitialAccessPresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.util.Map<java.lang.String, java.lang.String>>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.RequiredActionProviderRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.util.Map<java.lang.String, java.lang.Object>>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.util.Map<java.lang.String, java.lang.Object>>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<org.keycloak.representations.idm.AuthenticationFlowRepresentation>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.util.Map<java.lang.String, java.lang.Object>>
[ERROR] [io.smallrye.openapi.runtime.scanner.dataobject] SROAP31016: Unanticipated mismatch between type arguments and type variables declared on class
Class: io.smallrye.openapi.runtime.scanner.StreamStandin<E, S>
Type: java.util.stream.Stream<java.util.Map<java.lang.String, java.lang.Object>>

OpenApi download

When I access localhost:9000/openapi, it starts to download a file openapi with the spec. I expected to return only the text in the response body with the OpenAPI. Or did I miss something? I thought it's more like request-based without any other downloads.

quarkus/server/src/main/resources/application.properties

robson90 · 2025-08-14T08:56:47Z

OpenApi download

When I access localhost:9000/openapi, it starts to download a file openapi with the spec. I expected to return only the text in the response body with the OpenAPI. Or did I miss something? I thought it's more like request-based without any other downloads.

I think the way it is now, is the "expected". When opening localhost:9000/openapi-ui, the swagger-ui does an API call to get the openapi.yml. If you like, I can take a look, if we can provide two url´s, one for download, one for text.

mabartos · 2025-08-14T09:56:37Z

I think the way it is now, is the "expected". When opening localhost:9000/openapi-ui, the swagger-ui does an API call to get the openapi.yml. If you like, I can take a look, if we can provide two url´s, one for download, one for text.

It should actually call the endpoint with Content-Type: application/json, so the response contains OpenAPI spec in JSON format. Based on the findings:

Execute `localhost:9000/openapi`

The download starts and the downloaded file contains OpenAPI spec in YAML.

Execute `localhost:9000/openapi.yaml`

No download - response body contains the OpenAPI spec in YAML.

EDIT: yep, it starts downloading YAML as well.

Execute `localhost:9000/openapi.json`

No download - response body contains the OpenAPI spec in JSON.

I'd rather go a way that we return OpenAPI in YAML by default (as seen when executing localhost:9000/openapi.yaml) to prevent any downloads without a file suffix.

@robson90 @vmuzikar @shawkins WDYT?

quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/oas/OASModelFilter.java

vmuzikar · 2025-08-14T16:45:49Z

I'd rather go a way that we return OpenAPI in YAML by default (as seen when executing localhost:9000/openapi.yaml) to prevent any downloads without a file suffix.

@mabartos You mean that localhost:9000/openapi would just return the spec in YAML format without triggering the browser download? And localhost:9000/openapi.yaml then triggering the warning? If yes, then +1 for that. Though, I don't think it matters that much, those endpoints won't be typically accessed via browser.

mabartos · 2025-08-15T08:08:20Z

@mabartos You mean that localhost:9000/openapi would just return the spec in YAML format without triggering the browser download? And localhost:9000/openapi.yaml then triggering the warning? If yes, then +1 for that. Though, I don't think it matters that much, those endpoints won't be typically accessed via browser.

Some kind of that.. localhost:9000/openapi would return YAML (as the default), localhost:9000/openapi.yaml would return YAML (already working) as well and localhost:9000/openapi.json would return JSON (already working).

But yeah, we don't need to worry about it right now as it can be done in some follow-up tasks.

robson90 · 2025-08-15T13:40:14Z

@mabartos and @vmuzikar fyi:

Reading through here, it seems like I can already force the format: https://download.eclipse.org/microprofile/microprofile-open-api-2.0-RC3/microprofile-openapi-spec.html#_content_format

YAML

$ curl -H "Accept: application/yaml" http://localhost:9000/openapi
---
openapi: 3.1.0
tags:
- name: Clients (v2)
  x-smallrye-profile-admin: ""
components:
  schemas:
    Auth:
.........

JSON

$ curl -H "Accept: application/json" http://localhost:9000/openapi
{
  "openapi" : "3.1.0",
  "tags" : [ {
    "name" : "Clients (v2)",
    "x-smallrye-profile-admin" : ""
  } ],
  "components" : {
    "schemas" : {
      "Auth" : {
.........

Im happy to takle a more refined solution in a follow up task.

keycloak-github-bot

Unreported flaky test detected, please review

keycloak-github-bot · 2025-08-15T15:15:17Z

Unreported flaky test detected

If 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.oid4vc.issuance.signing.OID4VCIssuerWellKnownProviderTest#testMetaDataEndpointIsCorrectlySetup

Keycloak CI - Base IT (6)

java.lang.AssertionError: expected:<[RSA-OAEP, RSA-OAEP-256]> but was:<[RSA-OAEP-256, RSA-OAEP]>
	at org.junit.Assert.fail(Assert.java:89)
	at org.junit.Assert.failNotEquals(Assert.java:835)
	at org.junit.Assert.assertEquals(Assert.java:120)
	at org.junit.Assert.assertEquals(Assert.java:146)
...

Report flaky test

mabartos

@robson90 Nice work! In general, LGTM. Just added a few small comments to improve it a little bit more. Primarily, the diff between /openapi-ui and /openapi/ui.

quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/oas/OASModelFilter.java

quarkus/runtime/src/main/resources/application.properties

mabartos

@robson90 Nice work, LGTM.

@vmuzikar Do you wanna look at it as well?

keycloak-github-bot

Unreported flaky test detected, please review

keycloak-github-bot · 2025-08-18T10:24:35Z

Unreported flaky test detected

If 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.oid4vc.issuance.signing.OID4VCIssuerWellKnownProviderTest#testMetaDataEndpointIsCorrectlySetup

Keycloak CI - Base IT (6)

java.lang.AssertionError: expected:<[RSA-OAEP, RSA-OAEP-256]> but was:<[RSA-OAEP-256, RSA-OAEP]>
	at org.junit.Assert.fail(Assert.java:89)
	at org.junit.Assert.failNotEquals(Assert.java:835)
	at org.junit.Assert.assertEquals(Assert.java:120)
	at org.junit.Assert.assertEquals(Assert.java:146)
...

Report flaky test

...src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/OpenApiPropertyMappers.java

Signed-off-by: Robin Meese <[email protected]>

mabartos

LGTM

keycloak-github-bot

Unreported flaky test detected, please review

keycloak-github-bot · 2025-08-18T13:38:24Z

Unreported flaky test detected

If 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.oid4vc.issuance.signing.OID4VCIssuerWellKnownProviderTest#testMetaDataEndpointIsCorrectlySetup

Keycloak CI - Base IT (6)

java.lang.AssertionError: expected:<[RSA-OAEP, RSA-OAEP-256]> but was:<[RSA-OAEP-256, RSA-OAEP]>
	at org.junit.Assert.fail(Assert.java:89)
	at org.junit.Assert.failNotEquals(Assert.java:835)
	at org.junit.Assert.assertEquals(Assert.java:120)
	at org.junit.Assert.assertEquals(Assert.java:146)
...

java.lang.AssertionError: expected:<[RSA-OAEP, RSA-OAEP-256]> but was:<[RSA-OAEP-256, RSA-OAEP]>
	at org.junit.Assert.fail(Assert.java:89)
	at org.junit.Assert.failNotEquals(Assert.java:835)
	at org.junit.Assert.assertEquals(Assert.java:120)
	at org.junit.Assert.assertEquals(Assert.java:146)
...

Report flaky test

vmuzikar

@robson90 Thank you, LGTM!

Signed-off-by: Robin Meese <[email protected]>

Signed-off-by: Robin Meese <[email protected]> Signed-off-by: Václav Muzikář <[email protected]> # Conflicts: # quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/PropertyMappers.java # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testExportHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testImportHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityCheckHelpAll.approved.txt # quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testUpdateCompatibilityMetadataHelpAll.approved.txt

robson90 requested review from a team as code owners August 13, 2025 18:16

keycloak-github-bot bot added the team/cloud-native label Aug 13, 2025

mabartos reviewed Aug 14, 2025

View reviewed changes

quarkus/server/src/main/resources/application.properties Outdated Show resolved Hide resolved

robson90 mentioned this pull request Aug 14, 2025

[Admin API V2] Error logs for OpenApi definition. Presumably for Stream<?> #41871

Closed

2 tasks

robson90 force-pushed the feature/admin-api-v2-openapi branch from 1f816d0 to eccf1bd Compare August 14, 2025 09:32

mabartos reviewed Aug 14, 2025

View reviewed changes

quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/oas/OASModelFilter.java Show resolved Hide resolved

vmuzikar self-requested a review August 14, 2025 10:09

vmuzikar added team/admin-api-wg Admin API v2 Working Group and removed team/cloud-native labels Aug 14, 2025

robson90 force-pushed the feature/admin-api-v2-openapi branch from eccf1bd to 685aef8 Compare August 15, 2025 13:48

keycloak-github-bot bot added the flaky-test label Aug 15, 2025

keycloak-github-bot bot reviewed Aug 15, 2025

View reviewed changes

mabartos reviewed Aug 18, 2025

View reviewed changes

robson90 force-pushed the feature/admin-api-v2-openapi branch 2 times, most recently from 0a393d3 to fdea9b2 Compare August 18, 2025 09:03

mabartos approved these changes Aug 18, 2025

View reviewed changes

keycloak-github-bot bot reviewed Aug 18, 2025

View reviewed changes

vmuzikar reviewed Aug 18, 2025

View reviewed changes

...src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/OpenApiPropertyMappers.java Outdated Show resolved Hide resolved

Add OpenAPI and OpenAPI-UI to management interface

fefb631

Signed-off-by: Robin Meese <[email protected]>

robson90 force-pushed the feature/admin-api-v2-openapi branch from fdea9b2 to fefb631 Compare August 18, 2025 12:11

mabartos approved these changes Aug 18, 2025

View reviewed changes

keycloak-github-bot bot reviewed Aug 18, 2025

View reviewed changes

vmuzikar approved these changes Aug 18, 2025

View reviewed changes

vmuzikar merged commit 5b68ca1 into keycloak:feature/admin-api-v2 Aug 18, 2025
67 of 74 checks passed

mabartos pushed a commit that referenced this pull request Sep 5, 2025

Add OpenAPI and OpenAPI-UI to management interface (#41853)

4f4ed31

Signed-off-by: Robin Meese <[email protected]>

robson90 deleted the feature/admin-api-v2-openapi branch December 30, 2025 11:07

Add OpenAPI and OpenAPI-UI to management interface #41853

Add OpenAPI and OpenAPI-UI to management interface #41853

Uh oh!

Conversation

robson90 commented Aug 13, 2025

Uh oh!

mabartos commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fix the HelpCommandDistTest

Build error logs

OpenApi download

Uh oh!

Uh oh!

robson90 commented Aug 14, 2025

OpenApi download

Uh oh!

mabartos commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Execute localhost:9000/openapi

Execute localhost:9000/openapi.yaml

Execute localhost:9000/openapi.json

Uh oh!

Uh oh!

vmuzikar commented Aug 14, 2025

Uh oh!

mabartos commented Aug 15, 2025

Uh oh!

robson90 commented Aug 15, 2025

Uh oh!

keycloak-github-bot bot left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot commented Aug 15, 2025

Unreported flaky test detected

org.keycloak.testsuite.oid4vc.issuance.signing.OID4VCIssuerWellKnownProviderTest#testMetaDataEndpointIsCorrectlySetup

Uh oh!

mabartos left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mabartos left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot commented Aug 18, 2025

Unreported flaky test detected

org.keycloak.testsuite.oid4vc.issuance.signing.OID4VCIssuerWellKnownProviderTest#testMetaDataEndpointIsCorrectlySetup

Uh oh!

Uh oh!

mabartos left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot left a comment

Choose a reason for hiding this comment

Uh oh!

keycloak-github-bot bot commented Aug 18, 2025

Unreported flaky test detected

org.keycloak.testsuite.oid4vc.issuance.signing.OID4VCIssuerWellKnownProviderTest#testMetaDataEndpointIsCorrectlySetup

Uh oh!

vmuzikar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mabartos commented Aug 14, 2025 •

edited

Loading

Fix the `HelpCommandDistTest`

mabartos commented Aug 14, 2025 •

edited

Loading

Execute `localhost:9000/openapi`

Execute `localhost:9000/openapi.yaml`

Execute `localhost:9000/openapi.json`