From 044860303e781d4c6217fdf1ac5415d3c32ae641 Mon Sep 17 00:00:00 2001 From: Eric Wittmann Date: Thu, 21 Mar 2024 15:19:03 -0400 Subject: [PATCH] Add studioAvailableSince to @Info --- .../auth/authn/AppAuthenticationMechanism.java | 18 +++++++++--------- .../io/apicurio/common/apps/config/Info.java | 3 +++ .../apps/storage/sql/DatasourceProducer.java | 14 +++++++------- 3 files changed, 19 insertions(+), 16 deletions(-) diff --git a/auth/src/main/java/io/apicurio/common/apps/auth/authn/AppAuthenticationMechanism.java b/auth/src/main/java/io/apicurio/common/apps/auth/authn/AppAuthenticationMechanism.java index 05ff2d9..5c3e92b 100644 --- a/auth/src/main/java/io/apicurio/common/apps/auth/authn/AppAuthenticationMechanism.java +++ b/auth/src/main/java/io/apicurio/common/apps/auth/authn/AppAuthenticationMechanism.java @@ -74,41 +74,41 @@ public class AppAuthenticationMechanism implements HttpAuthenticationMechanism { @ConfigProperty(name = "quarkus.oidc.tenant-enabled", defaultValue = "false") - @Info(category = "auth", description = "Enable auth", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.0.0.Final") + @Info(category = "auth", description = "Enable auth", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.0.0.Final", studioAvailableSince = "1.0.0") boolean authEnabled; @Dynamic(label = "HTTP basic authentication", description = "When selected, users are permitted to authenticate using HTTP basic authentication (in addition to OAuth).", requires = "apicurio.authn.enabled=true") @ConfigProperty(name = "apicurio.authn.basic-client-credentials.enabled", defaultValue = "false") - @Info(category = "auth", description = "Enable basic auth client credentials", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.1.0.Final") + @Info(category = "auth", description = "Enable basic auth client credentials", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.1.0.Final", studioAvailableSince = "1.0.0") Supplier fakeBasicAuthEnabled; @ConfigProperty(name = "apicurio.authn.basic-client-credentials.cache-expiration", defaultValue = "10") - @Info(category = "auth", description = "Default client credentials token expiration time.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.2.6.Final") + @Info(category = "auth", description = "Default client credentials token expiration time.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.2.6.Final", studioAvailableSince = "1.0.0") Integer accessTokenExpiration; @ConfigProperty(name = "apicurio.authn.basic-client-credentials.cache-expiration-offset", defaultValue = "10") - @Info(category = "auth", description = "Client credentials token expiration offset from JWT expiration.", availableSince = "0.2.7", registryAvailableSince = "2.5.9.Final") + @Info(category = "auth", description = "Client credentials token expiration offset from JWT expiration.", availableSince = "0.2.7", registryAvailableSince = "2.5.9.Final", studioAvailableSince = "1.0.0") Integer accessTokenExpirationOffset; @ConfigProperty(name = "apicurio.authn.basic.scope") - @Info(category = "auth", description = "Client credentials scope.", availableSince = "0.1.21-SNAPSHOT", registryAvailableSince = "2.5.0.Final") + @Info(category = "auth", description = "Client credentials scope.", availableSince = "0.1.21-SNAPSHOT", registryAvailableSince = "2.5.0.Final", studioAvailableSince = "1.0.0") Optional scope; @ConfigProperty(name = "apicurio.authn.audit.log.prefix", defaultValue = "audit") - @Info(category = "auth", description = "Prefix used for application audit logging.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.2.6") + @Info(category = "auth", description = "Prefix used for application audit logging.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.2.6", studioAvailableSince = "1.0.0") String auditLogPrefix; @ConfigProperty(name = "quarkus.oidc.token-path", defaultValue = "") - @Info(category = "auth", description = "Authentication server token endpoint.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.1.0.Final") + @Info(category = "auth", description = "Authentication server token endpoint.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.1.0.Final", studioAvailableSince = "1.0.0") String authServerUrl; @ConfigProperty(name = "quarkus.oidc.client-secret") - @Info(category = "auth", description = "Client secret used by the server for authentication.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.1.0.Final") + @Info(category = "auth", description = "Client secret used by the server for authentication.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.1.0.Final", studioAvailableSince = "1.0.0") Optional clientSecret; @ConfigProperty(name = "quarkus.oidc.client-id", defaultValue = "") - @Info(category = "auth", description = "Client identifier used by the server for authentication.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.0.0.Final") + @Info(category = "auth", description = "Client identifier used by the server for authentication.", availableSince = "0.1.18-SNAPSHOT", registryAvailableSince = "2.0.0.Final", studioAvailableSince = "1.0.0") String clientId; @Inject diff --git a/config/definitions/src/main/java/io/apicurio/common/apps/config/Info.java b/config/definitions/src/main/java/io/apicurio/common/apps/config/Info.java index bd89e27..ecb3bc9 100644 --- a/config/definitions/src/main/java/io/apicurio/common/apps/config/Info.java +++ b/config/definitions/src/main/java/io/apicurio/common/apps/config/Info.java @@ -42,6 +42,9 @@ @Nonbinding String registryAvailableSince() default ""; + @Nonbinding + String studioAvailableSince() default ""; + /** * Lists related configuration properties. * TODO: Not used in docs yet diff --git a/storage/src/main/java/io/apicurio/common/apps/storage/sql/DatasourceProducer.java b/storage/src/main/java/io/apicurio/common/apps/storage/sql/DatasourceProducer.java index 369fb70..11bce6d 100644 --- a/storage/src/main/java/io/apicurio/common/apps/storage/sql/DatasourceProducer.java +++ b/storage/src/main/java/io/apicurio/common/apps/storage/sql/DatasourceProducer.java @@ -19,31 +19,31 @@ public class DatasourceProducer { Logger log; @ConfigProperty(name = "apicurio.storage.db-kind", defaultValue = "h2") - @Info(category = "storage", description = "Application datasource database type", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0.Final") + @Info(category = "storage", description = "Application datasource database type", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0", studioAvailableSince = "1.0.0") String databaseType; @ConfigProperty(name = "apicurio.datasource.url", defaultValue = "jdbc:h2:mem:registry_db") - @Info(category = "storage", description = "Application datasource jdbc url", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0.Final") + @Info(category = "storage", description = "Application datasource jdbc url", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0", studioAvailableSince = "1.0.0") String jdbcUrl; @ConfigProperty(name = "apicurio.datasource.username", defaultValue = "sa") - @Info(category = "storage", description = "Application datasource username", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0.Final") + @Info(category = "storage", description = "Application datasource username", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0", studioAvailableSince = "1.0.0") String username; @ConfigProperty(name = "apicurio.datasource.password", defaultValue = "sa") - @Info(category = "storage", description = "Application datasource password", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0.Final") + @Info(category = "storage", description = "Application datasource password", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0", studioAvailableSince = "1.0.0") String password; @ConfigProperty(name = "apicurio.datasource.jdbc.initial-size", defaultValue = "20") - @Info(category = "storage", description = "Application datasource pool initial size", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0.Final") + @Info(category = "storage", description = "Application datasource pool initial size", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0", studioAvailableSince = "1.0.0") String initialSize; @ConfigProperty(name = "apicurio.datasource.jdbc.min-size", defaultValue = "20") - @Info(category = "storage", description = "Application datasource pool minimum size", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0.Final") + @Info(category = "storage", description = "Application datasource pool minimum size", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0", studioAvailableSince = "1.0.0") String minSize; @ConfigProperty(name = "apicurio.datasource.jdbc.max-size", defaultValue = "100") - @Info(category = "storage", description = "Application datasource pool maximum size", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0.Final") + @Info(category = "storage", description = "Application datasource pool maximum size", availableSince = "0.2.5.Final", registryAvailableSince = "3.0.0", studioAvailableSince = "1.0.0") String maxSize; @ApplicationScoped