renaming and javadoc

Author: Michael Sonnleitner

client/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/GAVCoordinateOpenApiSpecInputProvider.java renamed to client/deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/YamlOrJsonGAVCoordinateOpenApiSpecInputProvider.java

@@ -19,8 +19,53 @@
 import io.quarkus.maven.dependency.ResolvedDependency;
 import io.smallrye.config.common.utils.StringUtil;
 
-public class GAVCoordinateOpenApiSpecInputProvider implements OpenApiSpecInputProvider {
-    private static final Logger LOG = Logger.getLogger(GAVCoordinateOpenApiSpecInputProvider.class);
+/**
+ * Provides OpenAPI specification input from Maven GAV (GroupId:ArtifactId:Version) coordinates.
+ * <p>
+ * This provider scans the application's dependencies for YAML or JSON files that match
+ * specific criteria and provides them as input for OpenAPI code generation. It implements
+ * the {@link OpenApiSpecInputProvider} interface to integrate with the OpenAPI Generator's
+ * code generation pipeline.
+ * </p>
+ *
+ * <h2>Scanning Behavior</h2>
+ * <p>
+ * The provider performs the following steps:
+ * </p>
+ * <ol>
+ * <li>Checks if GAV scanning is enabled via configuration (enabled by default)</li>
+ * <li>Filters dependencies by artifact type (yaml/yml/json)</li>
+ * <li>Applies artifact ID filtering using a regex pattern</li>
+ * <li>Excludes specific GAVs based on configuration</li>
+ * <li>Creates {@link SpecInputModel} instances for each matching dependency</li>
+ * </ol>
+ *
+ * <h2>Configuration</h2>
+ * <p>
+ * The provider respects the following configuration properties:
+ * </p>
+ * <ul>
+ * <li>{@code quarkus.openapi-generator.codegen.gav-scanning} - Enable/disable GAV scanning</li>
+ * <li>{@code quarkus.openapi-generator.codegen.artifact-id-filter} - Regex pattern for artifact ID filtering</li>
+ * <li>{@code quarkus.openapi-generator.codegen.exclude-gavs} - List of GAV coordinates to exclude
+ * (format: groupId:artifactId:classifier)</li>
+ * </ul>
+ *
+ * <h2>Example Usage</h2>
+ *
+ * <pre>
+ * # application.properties
+ * quarkus.openapi-generator.codegen.gav-scanning=true
+ * quarkus.openapi-generator.codegen.artifact-id-filter=.*api.*
+ * quarkus.openapi-generator.codegen.exclude-gavs=com.example:old-api
+ * </pre>
+ *
+ * @see OpenApiSpecInputProvider
+ * @see SpecInputModel
+ * @see CodeGenContext
+ */
+public class YamlOrJsonGAVCoordinateOpenApiSpecInputProvider implements OpenApiSpecInputProvider {
+    private static final Logger LOG = Logger.getLogger(YamlOrJsonGAVCoordinateOpenApiSpecInputProvider.class);
 
     @Override
     public List<SpecInputModel> read(CodeGenContext context) throws CodeGenException {
@@ -37,7 +82,7 @@ public List<SpecInputModel> read(CodeGenContext context) throws CodeGenException
                 .orElse(".*openapi.*");
 
         List<ResolvedDependency> yamlDependencies = context.applicationModel().getDependencies().stream()
-                .filter(rd -> SUPPORTED_EXTENSIONS.contains(rd.getType()))
+                .filter(rd -> SUPPORTED_EXTENSIONS.contains(rd.getType().toLowerCase()))
                 .filter(rd -> rd.getArtifactId().matches(artifactIdFilter))
                 .filter(rd -> !gavsToExclude.contains(rd.getKey().toGacString()))
                 .toList();

client/deployment/src/main/resources/META-INF/services/io.quarkiverse.openapi.generator.deployment.codegen.OpenApiSpecInputProvider

@@ -1 +1 @@
-io.quarkiverse.openapi.generator.deployment.codegen.GAVCoordinateOpenApiSpecInputProvider
+io.quarkiverse.openapi.generator.deployment.codegen.YamlOrJsonGAVCoordinateOpenApiSpecInputProvider