Merge 4.8.x branch

.gitattributes

@@ -1,18 +1,19 @@
 # Auto detect text files and perform LF normalization
 *        text=auto
 
-*.java   text
-*.html   text
-*.kt     text
-*.kts    text
-*.md     text diff=markdown
+*.java   text eol=lf
+*.groovy text eol=lf
+*.html   text eol=lf
+*.kt     text eol=lf
+*.kts    text eol=lf
+*.md     text diff=markdown eol=lf
 *.py     text diff=python executable
 *.pl     text diff=perl executable
 *.pm     text diff=perl
-*.css    text diff=css
-*.js     text
-*.sql    text
-*.q      text
+*.css    text diff=css eol=lf
+*.js     text eol=lf
+*.sql    text eol=lf
+*.q      text eol=lf
 
 *.sh     text eol=lf
 gradlew  text eol=lf

.github/workflows/graalvm.yml

@@ -19,14 +19,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        graalvm: [ 'latest', 'dev' ]
+        graalvm: [ 'latest']
         java: [ '17' ]
-        include:
-          - graalvm: 'dev'
-            java: '19'
-        exclude:
-          - graalvm: 'dev'
-            java: '17'
     steps:
        # https://github.com/actions/virtual-environments/issues/709
       - name: Free disk space

buildSrc/src/main/groovy/io.micronaut.build.internal.openapi-module.gradle

@@ -2,3 +2,8 @@ plugins {
     id 'io.micronaut.build.internal.openapi-base'
     id 'io.micronaut.build.internal.module'
 }
+
+repositories {
+    mavenCentral()
+    google()
+}

docs-examples/example-groovy/build.gradle

@@ -13,14 +13,17 @@ repositories {
 }
 
 dependencies {
+
+    testAnnotationProcessor(mn.micronaut.inject.groovy)
+
     testCompileOnly(mn.micronaut.inject.groovy)
+    testCompileOnly(libs.managed.swagger.annotations)
 
-    testImplementation projects.openapi
+    testImplementation projects.micronautOpenapi
     testImplementation(mn.snakeyaml)
     testImplementation(mn.micronaut.runtime)
     testImplementation(mnGroovy.micronaut.runtime.groovy)
-    testImplementation(mn.micronaut.validation)
-    testImplementation(libs.managed.swagger.annotations)
+    testImplementation(mnValidation.validation)
     testImplementation(mn.reactor)
     testImplementation(mnTest.micronaut.test.spock)
 

docs-examples/example-groovy/src/test/groovy/io/micronaut/configuration/openapi/docs/controllers/annotations/HelloController.groovy

@@ -13,7 +13,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse
 import io.swagger.v3.oas.annotations.tags.Tag
 import reactor.core.publisher.Mono
 
-import javax.validation.constraints.NotBlank
+import jakarta.validation.constraints.NotBlank
 // end::imports
 // tag::clazz[]
 @Controller("/")
@@ -38,4 +38,4 @@ class HelloController {
         return Single.just("Hello $name, How are you doing?")
     }
 }
-// end::clazz[]
+// end::clazz[]

docs-examples/example-java/build.gradle

@@ -14,17 +14,18 @@ repositories {
 
 dependencies {
 
-    testImplementation projects.openapi
+    testAnnotationProcessor(mn.micronaut.inject.java)
+
+    testCompileOnly(mn.micronaut.inject.java)
+
+    testImplementation projects.micronautOpenapi
     testImplementation(mn.snakeyaml)
     testImplementation(mn.micronaut.runtime)
-    testImplementation(mn.micronaut.inject.java)
-    testImplementation(mn.micronaut.validation)
-    testImplementation(libs.managed.swagger.annotations)
     testImplementation(mn.reactor)
+    testImplementation(mnValidation.validation)
+    testImplementation(libs.managed.swagger.annotations)
     testImplementation(mnTest.micronaut.test.junit5)
 
-    testCompileOnly(mn.micronaut.inject.java)
-
     testRuntimeOnly(libs.junit.jupiter.engine)
     testRuntimeOnly(mn.logback.classic)
 }

docs-examples/example-java/src/test/java/io/micronaut/configuration/openapi/docs/controllers/annotations/HelloController.java

@@ -11,7 +11,7 @@
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
 
-import javax.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotBlank;
 import reactor.core.publisher.Mono;
 
 // end::imports[]
@@ -38,4 +38,4 @@ public Mono<String> greetings(@Parameter(description="The name of the person") @
         return Mono.just("Hello " + name + ", How are you doing?");
     }
 }
-// end::clazz[]
+// end::clazz[]

docs-examples/example-kotlin/build.gradle

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
     alias(libs.plugins.kotlin.jvm)
     alias(libs.plugins.kotlin.kapt)
@@ -15,7 +17,7 @@ repositories {
 }
 
 dependencies {
-    kapt projects.openapi
+    kapt projects.micronautOpenapi
     kapt(mn.micronaut.inject.java)
     kapt(mnValidation.micronaut.validation)
 
@@ -25,7 +27,7 @@ dependencies {
     testImplementation(mn.reactor)
     testImplementation(mn.snakeyaml)
     testImplementation(mn.micronaut.runtime)
-    testImplementation(mn.micronaut.validation)
+    testImplementation(mnValidation.validation)
     testImplementation(libs.kotlin.stdlib.jdk8)
     testImplementation(libs.kotlin.reflect)
     testImplementation(mnTest.micronaut.test.junit5)
@@ -49,8 +51,8 @@ test {
 }
 
 compileTestKotlin {
-    kotlinOptions {
-        jvmTarget = '17'
+    compilerOptions {
+        jvmTarget = JvmTarget.JVM_17
         javaParameters = true
     }
 }

gradle.properties

@@ -1,9 +1,10 @@
 projectVersion=5.0.0-SNAPSHOT
 projectGroup=io.micronaut.openapi
+
 micronautDocsVersion=2.0.0
 micronautVersion=4.0.0-SNAPSHOT
 micronautTestVersion=4.0.0-SNAPSHOT
-groovyVersion=4.0.7
+groovyVersion=4.0.9
 spockVersion=2.3-groovy-4.0
 
 title=OpenAPI/Swagger Support

gradle/libs.versions.toml

@@ -1,12 +1,16 @@
 [versions]
 managed-swagger = "2.2.8"
 managed-javadoc-parser = "0.3.1"
-managed-jsoup = "1.15.3"
+managed-jsoup = "1.15.4"
 managed-slf4j = "2.0.6"
 managed-html2md-converter = "0.64.0"
-managed-jakarta-validation-api = "3.0.2"
 
-kotlin = "1.8.0"
+kotlin = "1.8.10"
+jspecify = "0.3.0"
+jdt-annotation = "2.2.700"
+android-annotation = "1.6.0"
+spotbugs-annotations = "4.7.3"
+
 micronaut-security = "4.0.0-SNAPSHOT"
 micronaut-serde = "2.0.0-SNAPSHOT"
 micronaut-rxjava2 = "2.0.0-SNAPSHOT"
@@ -42,7 +46,10 @@ managed-slf4j-nop = { module = "org.slf4j:slf4j-nop", version.ref = "managed-slf
 junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine" }
 jackson-datatype-jsr310 = { module = "com.fasterxml.jackson.datatype:jackson-datatype-jsr310" }
 jackson-dataformat-yaml = { module = "com.fasterxml.jackson.dataformat:jackson-dataformat-yaml" }
-jakarta-validation-api = { module = "jakarta.validation:jakarta.validation-api", version.ref = "managed-jakarta-validation-api" }
+spotbugs-annotations = { module = "com.github.spotbugs:spotbugs-annotations", version.ref = "spotbugs-annotations" }
+jspecify = { module = "org.jspecify:jspecify", version.ref = "jspecify" }
+jdt-annotation = { module = "org.eclipse.jdt:org.eclipse.jdt.annotation", version.ref = "jdt-annotation" }
+android-annotation = { module = "androidx.annotation:annotation", version.ref = "android-annotation" }
 
 kotlin-stdlib-jdk8 = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
 kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin" }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -144,15 +144,15 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

openapi-bom/build.gradle

@@ -6,5 +6,8 @@ micronautBom {
     suppressions {
         acceptedVersionRegressions.add("swagger-compat")
         acceptedLibraryRegressions.add("swagger")
+
+        acceptedVersionRegressions.add("jakarta-validation-api")
+        acceptedLibraryRegressions.add("jakarta-validation-api")
     }
 }

openapi/build.gradle

@@ -20,20 +20,21 @@ dependencies {
     // this dependency needs to be updated manually. It's used by html2md
     api(libs.managed.jsoup)
 
+    testImplementation(mn.micronaut.management)
     testImplementation(mn.micronaut.runtime)
-    testImplementation(mnSecurity.micronaut.security)
-    testImplementation(mnSerde.micronaut.serde.jackson)
-    testImplementation(mn.micronaut.inject.groovy)
     testImplementation(mn.micronaut.inject.groovy.test)
-    testImplementation(mn.micronaut.inject.java)
     testImplementation(mn.micronaut.inject.java.test)
     testImplementation(mn.snakeyaml)
+    testImplementation(mnSecurity.micronaut.security)
+    testImplementation(mnSerde.micronaut.serde.jackson)
     testImplementation(mnRxjava2.micronaut.rxjava2)
     testImplementation(mnRxjava3.micronaut.rxjava3)
     testImplementation(mnData.micronaut.data.model)
-    testImplementation(mn.micronaut.management)
     testImplementation(mnValidation.validation)
-    testImplementation(libs.jakarta.validation.api)
+    testImplementation(libs.jspecify)
+    testImplementation(libs.jdt.annotation)
+    testImplementation(libs.android.annotation)
+    testImplementation(libs.spotbugs.annotations)
 }
 
 configurations.configureEach {

openapi/openapi-schema-decorators.properties

@@ -0,0 +1,2 @@
+micronaut.openapi.schema-postfix.io.micronaut.openapi.api.v1_0_0=1_0_0
+micronaut.openapi.schema-postfix.io.micronaut.openapi.api.v2_0_1=2_0_1

openapi/src/main/java/io/micronaut/openapi/swagger/core/util/ObjectMapperFactory.java

@@ -72,6 +72,8 @@
 import io.swagger.v3.oas.models.servers.ServerVariables;
 import io.swagger.v3.oas.models.tags.Tag;
 
+import org.yaml.snakeyaml.LoaderOptions;
+
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.databind.BeanDescription;
@@ -84,6 +86,7 @@
 import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactoryBuilder;
 import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 
@@ -103,11 +106,15 @@ public static ObjectMapper createJson() {
     }
 
     public static ObjectMapper createYaml(boolean openapi31) {
-        YAMLFactory factory = new YAMLFactory();
-        factory.disable(Feature.WRITE_DOC_START_MARKER);
-        factory.enable(Feature.MINIMIZE_QUOTES);
-        factory.enable(Feature.SPLIT_LINES);
-        factory.enable(Feature.ALWAYS_QUOTE_NUMBERS_AS_STRINGS);
+        LoaderOptions loaderOptions = new LoaderOptions();
+        loaderOptions.setAllowDuplicateKeys(false);
+        YAMLFactory factory = new YAMLFactoryBuilder(new YAMLFactory())
+            .loaderOptions(loaderOptions)
+            .disable(Feature.WRITE_DOC_START_MARKER)
+            .enable(Feature.MINIMIZE_QUOTES)
+            .enable(Feature.SPLIT_LINES)
+            .enable(Feature.ALWAYS_QUOTE_NUMBERS_AS_STRINGS)
+            .build();
 
         return create(factory, openapi31);
     }

openapi/src/main/java/io/micronaut/openapi/view/AbstractViewConfig.java

@@ -37,7 +37,9 @@ abstract class AbstractViewConfig {
     protected String jsUrl = "";
     protected String finalUrlPrefix;
     protected String resourcesContextPath = "/res";
+    protected String templatePath;
     protected boolean isDefaultJsUrl = true;
+    protected boolean copyResources = true;
     protected boolean withFinalUrlPrefixCache = true;
     protected Map<String, Object> options = new HashMap<>();
 
@@ -61,6 +63,12 @@ protected AbstractViewConfig(String prefix) {
 
     protected abstract List<String> getResources();
 
+    public String getTemplatePath() {
+        return templatePath;
+    }
+
+    public abstract String render(String template, VisitorContext context);
+
     /**
      * Adds an option.
      *
@@ -132,6 +140,12 @@ protected String getFinalUrlPrefix(OpenApiViewConfig.RendererType rendererType,
      * @return A View config.
      */
     static <T extends AbstractViewConfig> T fromProperties(T cfg, Map<String, Object> defaultOptions, Map<String, String> properties) {
+
+        String copyResources = properties.get(cfg.prefix + "copy-resources");
+        if (StringUtils.isNotEmpty(copyResources) && "false".equalsIgnoreCase(copyResources)) {
+            cfg.copyResources = false;
+        }
+
         String jsUrl = properties.get(cfg.prefix + "js.url");
         if (StringUtils.isNotEmpty(jsUrl)) {
             cfg.jsUrl = jsUrl;
@@ -143,6 +157,11 @@ static <T extends AbstractViewConfig> T fromProperties(T cfg, Map<String, Object
             }
         }
 
+        String templatePath = properties.get(cfg.prefix + "template.path");
+        if (StringUtils.isNotEmpty(templatePath)) {
+            cfg.templatePath = templatePath;
+        }
+
         cfg.options.putAll(defaultOptions);
         properties.entrySet().stream().filter(entry -> entry.getKey().startsWith(cfg.prefix))
             .forEach(cfg::addAttribute);