Merge pull request #50184 from MikeEdgar/smallrye-open-api-4.2.0

Bump smallrye-open-api from 4.0.12 to 4.2.0 (MP OpenAPI 4.0.2 to 4.1)

Author: phillip-kruger

bom/application/pom.xml

@@ -45,12 +45,12 @@
         <microprofile-rest-client.version>4.0</microprofile-rest-client.version>
         <microprofile-jwt.version>2.1</microprofile-jwt.version>
         <microprofile-lra.version>2.0.1</microprofile-lra.version>
-        <microprofile-openapi.version>4.0.2</microprofile-openapi.version>
+        <microprofile-openapi.version>4.1</microprofile-openapi.version>
         <smallrye-common.version>2.13.9</smallrye-common.version>
         <smallrye-config.version>3.14.0</smallrye-config.version>
         <smallrye-health.version>4.2.0</smallrye-health.version>
         <smallrye-metrics.version>4.0.0</smallrye-metrics.version>
-        <smallrye-open-api.version>4.0.12</smallrye-open-api.version>
+        <smallrye-open-api.version>4.2.0</smallrye-open-api.version>
         <smallrye-graphql.version>2.14.1</smallrye-graphql.version>
         <smallrye-fault-tolerance.version>6.9.3</smallrye-fault-tolerance.version>
         <smallrye-jwt.version>4.6.2</smallrye-jwt.version>

extensions/smallrye-openapi-common/deployment/src/main/java/io/quarkus/smallrye/openapi/common/deployment/SmallRyeOpenApiConfig.java

@@ -236,9 +236,23 @@ public interface SmallRyeOpenApiConfig {
     Optional<String> infoLicenseUrl();
 
     /**
-     * Set the strategy to automatically create an operation Id
-     */
-    Optional<OperationIdStrategy> operationIdStrategy();
+     * Set the strategy to automatically create an operation Id. The strategy may be
+     * one of the predefined values or the name of a fully-qualified class that
+     * implements the {@code io.smallrye.openapi.api.OperationIdGenerator}
+     * interface.
+     *
+     * <p>
+     * Predefined strategies:
+     * <ul>
+     * <li>{@code method}: generate an operationId with the resource method's
+     * name</li>
+     * <li>{@code class-method}: generate an operationId with the resource class's
+     * simple name and the resource method's name</li>
+     * <li>{@code package-class-method}: generate an operationId with the resource
+     * class's fully-qualified name and the resource method's name</li>
+     * </ul>
+     */
+    Optional<String> operationIdStrategy();
 
     /**
      * Set this boolean value to enable or disable the merging of the deprecated `@Schema`
@@ -258,12 +272,6 @@ public enum SecurityScheme {
         oauth2Implicit
     }
 
-    public enum OperationIdStrategy {
-        METHOD,
-        CLASS_METHOD,
-        PACKAGE_CLASS_METHOD
-    }
-
     default Map<String, String> getValidSecuritySchemeExtensions() {
         return securitySchemeExtensions()
                 .entrySet()

extensions/smallrye-openapi/deployment/src/test/java/io/quarkus/smallrye/openapi/deployment/filter/SecurityConfigFilterTest.java

@@ -258,7 +258,7 @@ public Optional<String> infoLicenseUrl() {
         }
 
         @Override
-        public Optional<OperationIdStrategy> operationIdStrategy() {
+        public Optional<String> operationIdStrategy() {
             return Optional.empty();
         }
 

extensions/smallrye-openapi/runtime/src/main/java/io/quarkus/smallrye/openapi/runtime/OpenAPIRuntimeBuilder.java

@@ -11,10 +11,10 @@
  */
 class OpenAPIRuntimeBuilder extends SmallRyeOpenAPI.Builder {
     @Override
-    public <V, A extends V, O extends V, AB, OB> SmallRyeOpenAPI build() {
+    public SmallRyeOpenAPI build(boolean unmodifiable) {
         var ctx = super.getContext();
         buildPrepare(ctx);
         buildStaticModel(ctx);
-        return buildFinalize(ctx);
+        return buildFinalize(ctx, unmodifiable);
     }
 }

extensions/smallrye-openapi/runtime/src/main/java/io/quarkus/smallrye/openapi/runtime/OpenApiConfigMapping.java

@@ -4,14 +4,13 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import org.eclipse.microprofile.config.spi.Converter;
 import org.eclipse.microprofile.openapi.OASConfig;
 
 import io.smallrye.config.ConfigSourceInterceptorContext;
 import io.smallrye.config.ConfigValue;
-import io.smallrye.config.Converters;
 import io.smallrye.config.RelocateConfigSourceInterceptor;
-import io.smallrye.openapi.api.OpenApiConfig.OperationIdStrategy;
+import io.smallrye.config.common.utils.StringUtil;
+import io.smallrye.openapi.api.OpenApiConfig;
 import io.smallrye.openapi.api.SmallRyeOASConfig;
 
 /**
@@ -20,8 +19,6 @@
 public class OpenApiConfigMapping extends RelocateConfigSourceInterceptor {
     private static final long serialVersionUID = 1L;
     private static final Map<String, String> RELOCATIONS = relocations();
-    private static final Converter<OperationIdStrategy> OPERATION_ID_STRATEGY_CONVERTER = Converters
-            .getImplicitConverter(OperationIdStrategy.class);
 
     public OpenApiConfigMapping() {
         super(RELOCATIONS);
@@ -31,15 +28,37 @@ public OpenApiConfigMapping() {
     public ConfigValue getValue(ConfigSourceInterceptorContext context, String name) {
         ConfigValue configValue = super.getValue(context, name);
 
-        // Special case for enum. The converter run after the interceptors, so we have to do this here.
+        /*
+         * Special case for operationId strategy that supports both enumerated values or a FQCN.
+         * The converter run after the interceptors, so we have to do this here.
+         */
         if (configValue != null && name.equals(SmallRyeOASConfig.OPERATION_ID_STRAGEGY)) {
-            String correctValue = OPERATION_ID_STRATEGY_CONVERTER.convert(configValue.getValue()).toString();
+            String correctValue = convertOperationIdStrategy(configValue.getValue());
             configValue = configValue.withValue(correctValue);
         }
 
         return configValue;
     }
 
+    private static String convertOperationIdStrategy(String value) {
+        final String trimmedValue = value.trim();
+
+        if (trimmedValue.isEmpty()) {
+            return null;
+        }
+
+        switch (StringUtil.skewer(trimmedValue)) {
+            case "method":
+                return OpenApiConfig.OperationIdStrategy.METHOD;
+            case "class-method":
+                return OpenApiConfig.OperationIdStrategy.CLASS_METHOD;
+            case "package-class-method":
+                return OpenApiConfig.OperationIdStrategy.PACKAGE_CLASS_METHOD;
+            default:
+                return trimmedValue;
+        }
+    }
+
     private static Map<String, String> relocations() {
         Map<String, String> relocations = new HashMap<>();
         mapKey(relocations, SmallRyeOASConfig.VERSION, QUARKUS_OPEN_API_VERSION);

tcks/microprofile-openapi/pom.xml

@@ -14,7 +14,7 @@
     <name>Quarkus - TCK - MicroProfile OpenAPI</name>
 
     <properties>
-        <microprofile-openapi-tck.version>4.0.2</microprofile-openapi-tck.version>
+        <microprofile-openapi-tck.version>4.1</microprofile-openapi-tck.version>
     </properties>
 
     <build>