8000 Ignore OpenAPI artifacts when disabled by mabartos · Pull Request #45499 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

Ignore OpenAPI artifacts when disabled #45499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mabartos merged 1 commit into from
Jan 16, 2026
Merged

Ignore OpenAPI artifacts when disabled #45499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion ...us/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/IgnoredArtifacts.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.keycloak.common.Profile;
import org.keycloak.config.HealthOptions;
import org.keycloak.config.MetricsOptions;
import org.keycloak.config.OpenApiOptions;
import org.keycloak.config.TelemetryOptions;
import org.keycloak.config.database.Database;

Expand All @@ -43,7 +44,9 @@ public static Set<String> getDefaultIgnoredArtifacts() {
jdbcDrivers(),
health(),
metrics(),
otelMetrics()
otelMetrics(),
openApi(),
openApiSwagger()
)
.flatMap(Collection::stream)
.collect(Collectors.toUnmodifiableSet());
Expand Down Expand Up @@ -185,4 +188,28 @@ private static Set<String> otelMetrics() {
boolean isOtelMetricsEnabled = Configuration.isTrue(TelemetryOptions.TELEMETRY_METRICS_ENABLED);
return !isOtelMetricsEnabled ? OTEL_METRICS : emptySet();
}

// OpenAPI
public static Set<String> OPENAPI = Set.of(
"io.quarkus:quarkus-smallrye-openapi",
"io.quarkus:quarkus-smallrye-openapi-deployment",
"io.smallrye:smallrye-open-api-core"
);

private static Set<String> openApi() {
boolean isEnabled = Configuration.isTrue(OpenApiOptions.OPENAPI_ENABLED);
return !isEnabled ? OPENAPI : emptySet();
}

// OpenAPI UI (Swagger)
public static Set<String> OPENAPI_SWAGGER = Set.of(
"io.quarkus:quarkus-swagger-ui",
"io.quarkus:quarkus-swagger-ui-deployment",
"io.smallrye:smallrye-open-api-ui"
);

private static Set<String> openApiSwagger() {
boolean isEnabled = Configuration.isTrue(OpenApiOptions.OPENAPI_UI_ENABLED);
return !isEnabled ? OPENAPI_SWAGGER : emptySet();
}
}
11 changes: 11 additions & 0 deletions ...untime/src/test/java/org/keycloak/quarkus/runtime/configuration/IgnoredArtifactsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import org.keycloak.config.DatabaseOptions;
import org.keycloak.config.HealthOptions;
import org.keycloak.config.MetricsOptions;
import org.keycloak.config.OpenApiOptions;
import org.keycloak.config.Option;
import org.keycloak.config.TelemetryOptions;

Expand Down Expand Up @@ -161,6 +162,16 @@ public void otelMetrics(){
assertIgnoredArtifacts(IgnoredArtifacts.OTEL_METRICS, TelemetryOptions.TELEMETRY_METRICS_ENABLED);
}

@Test
public void openApi() {
assertIgnoredArtifacts(IgnoredArtifacts.OPENAPI, OpenApiOptions.OPENAPI_ENABLED);
}

@Test
public void openApiSwagger() {
assertIgnoredArtifacts(IgnoredArtifacts.OPENAPI_SWAGGER, OpenApiOptions.OPENAPI_UI_ENABLED);
}

private void assertIgnoredArtifacts(Set<String> artifactsSet, Option<Boolean> enabledOption) {
assertIgnoredArtifacts(artifactsSet, enabledOption, true);
}
Expand Down
Loading
0