Merge branch 'main' into dependabot/maven/quarkus.version-2.8.0.Final

Author: ricardozanini

.github/project.yml

@@ -1,4 +1,4 @@
 release:
-  current-version: 0.3.1
+  current-version: 0.4.1
   next-version: 1.0.0-SNAPSHOT
 

README.md

@@ -17,7 +17,7 @@ Add the following dependency to your project's `pom.xml` file:
 <dependency>
   <groupId>io.quarkiverse.openapi.generator</groupId>
   <artifactId>quarkus-openapi-generator</artifactId>
-  <version>0.3.1</version>
+  <version>0.4.0</version>
 </dependency>
 ```
 
@@ -277,21 +277,29 @@ org.acme.openapi.simple.api.DefaultApi/byeGet/CircuitBreaker/successThreshold=22
 ````
 
 ## Sending multipart/form-data
-The rest client also supports request with mime-type multipart/form-data and, if the schema of the request body is known in advance, we can also automatically generate the models of the request bodies. 
+
+The rest client also supports request with mime-type multipart/form-data and, if the schema of the request body is known in advance, we can also automatically generate the models of the request
+bodies.
 
 You need to add the following additional dependency to your `pom.xml`:
+
 ```xml
+
 <dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-resteasy-multipart</artifactId>
 </dependency>
 ```
+
 For any multipart/form-data operation a model for the request body will be generated. Each part of the multipart is a field in this model that is annotated with the following annotations:
-- `javax.ws.rs.FormParam`, where the value parameter denotes the part name, 
+
+- `javax.ws.rs.FormParam`, where the value parameter denotes the part name,
 - `org.jboss.resteasy.annotations.providers.multipart.PartType`, where the parameter is the jax-rs MediaType of the part (see below for details),
-- and, if the part contains a file, `org.jboss.resteasy.annotations.providers.multipart.PartFilename`, with a generated default parameter that will be passed as the fileName sub-header in the Content-Disposition header of the part.
+- and, if the part contains a file, `org.jboss.resteasy.annotations.providers.multipart.PartFilename`, with a generated default parameter that will be passed as the fileName sub-header in the
+  Content-Disposition header of the part.
+
+For example, the model for a request that requires a file, a string and some complex object will look like this:
 
-For example, the model for a request that requires a file, a string and some complex object will look like this: 
 ```java
 public class MultipartBody {
 
@@ -311,42 +319,57 @@ public class MultipartBody {
 ```
 
 Then in the client the `org.jboss.resteasy.annotations.providers.multipart.MultipartForm` annotation is added in front of the multipart parameter:
+
 ```java
 @Path("/echo")
 @RegisterRestClient
 public interface MultipartService {
-    
+
     @POST
     @Consumes(MediaType.MULTIPART_FORM_DATA)
     @Produces(MediaType.TEXT_PLAIN)
     String sendMultipartData(@MultipartForm MultipartBody data);
-    
+
 }
 ```
-See [Quarkus - Using the REST Client with Multipart](https://quarkus.io/guides/rest-client-multipart) and the [RESTEasy JAX-RS specifications](https://docs.jboss.org/resteasy/docs/4.7.5.Final/userguide/html_single/index.html) for more details.
 
-Importantly, if some multipart request bodies contain complex objects (i.e. non-primitives) you need to explicitly tell the Open API generator to create models for these objects by setting the `skip-form-model` property corresponding to your spec in the `application.properties` to `false`, e.g.:
+See [Quarkus - Using the REST Client with Multipart](https://quarkus.io/guides/rest-client-multipart) and
+the [RESTEasy JAX-RS specifications](https://docs.jboss.org/resteasy/docs/4.7.5.Final/userguide/html_single/index.html) for more details.
+
+Importantly, if some multipart request bodies contain complex objects (i.e. non-primitives) you need to explicitly tell the Open API generator to create models for these objects by setting
+the `skip-form-model` property corresponding to your spec in the `application.properties` to `false`, e.g.:
+
 ```properties
 quarkus.openapi-generator.codegen.spec."my-multipart-requests.yml".skip-form-model=false
 ```
 
 ### Default content-types according to OpenAPI Specification and limitations
+
 The [OAS 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#special-considerations-for-multipart-content) specifies the following default content-types for a multipart:
+
 - If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain`
 - If the property is complex, or an array of complex values, the default Content-Type is `application/json`
 - If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream`
 
-A different content-type may be defined in your api spec, but this is not yet supported in the code generation. Also, this "annotation-oriented" approach of RestEasy (i.e. using `@MultipartForm` to denote the multipart body parameter) does not seem to properly support the unmarshalling of arrays of the same type (e.g. array of files), in these cases it uses Content-Type equal to `application/json`.
-
+A different content-type may be defined in your api spec, but this is not yet supported in the code generation. Also, this "annotation-oriented" approach of RestEasy (i.e. using `@MultipartForm` to
+denote the multipart body parameter) does not seem to properly support the unmarshalling of arrays of the same type (e.g. array of files), in these cases it uses Content-Type equal
+to `application/json`.
 
 ## Generating files via InputStream
 
-Having the files in the `src/main/openapi` directory will generate the REST stubs by default. Alternatively, you can implement the `io.quarkiverse.openapi.generator.codegen.OpenApiSpecInputProvider`
+Having the files in the `src/main/openapi` directory will generate the REST stubs by default. Alternatively, you can implement the `io.quarkiverse.openapi.generator.deployment.codegen.OpenApiSpecInputProvider`
 interface to provide a list of `InputStream`s of OpenAPI specification files. This is useful in scenarios where you want to dynamically generate the client code without having the target spec file
 saved locally in your project.
 
 See the example implementation [here](test-utils/src/main/java/io/quarkiverse/openapi/generator/testutils/codegen/ClassPathPetstoreOpenApiSpecInputProvider.java)
 
+## Skip Deprecated Attributes in Model classes
+
+The domain objects are classes generated in the `model` package. These classes might have [deprecated attributes](https://spec.openapis.org/oas/v3.1.0#fixed-fields-9) in the Open API specification
+file. By default, these attributes are generated. You can fine tune this behavior if the deprecated attributes should not be generated.
+
+Use the property key `<base_package>.model.MyClass.generateDeprecated=false` to disable the deprecated attributes in the given model. For example `org.acme.weather.Country.generatedDeprecated=false`.
+
 ## Known Limitations
 
 These are the known limitations of this pre-release version:

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/GeneratedOpenApiFile.java

@@ -1,31 +1,21 @@
 package io.quarkiverse.openapi.generator.deployment;
 
-import static io.quarkiverse.openapi.generator.deployment.OpenApiGeneratorBuildTimeConfig.BUILD_TIME_CONFIG_PREFIX;
-
 import java.nio.file.Path;
 
-import io.quarkus.runtime.annotations.ConfigGroup;
-import io.quarkus.runtime.annotations.ConfigItem;
-
-@ConfigGroup
 public class SpecConfig {
+
+    private static final String BUILD_TIME_CONFIG_PREFIX = "quarkus.openapi-generator.codegen";
     public static final String API_PKG_SUFFIX = ".api";
     public static final String MODEL_PKG_SUFFIX = ".model";
     public static final String BUILD_TIME_SPEC_PREFIX_FORMAT = BUILD_TIME_CONFIG_PREFIX + ".spec.\"%s\"";
     private static final String BASE_PACKAGE_PROP_FORMAT = "%s.base-package";
     private static final String SKIP_FORM_MODEL_PROP_FORMAT = "%s.skip-form-model";
 
-    /**
-     * Defines the base package name for the generated classes.
-     */
-    @ConfigItem
-    public String basePackage;
-
-    public String getApiPackage() {
+    public static String resolveApiPackage(final String basePackage) {
         return String.format("%s%s", basePackage, API_PKG_SUFFIX);
     }
 
-    public String getModelPackage() {
+    public static String resolveModelPackage(final String basePackage) {
         return String.format("%s%s", basePackage, MODEL_PKG_SUFFIX);
     }
 

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/GeneratedOpenApiModelBuildItem.java

@@ -0,0 +1,34 @@
+package io.quarkiverse.openapi.generator.deployment.codegen;
+
+import static io.quarkiverse.openapi.generator.deployment.SpecConfig.resolveModelPackage;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
+
+import org.eclipse.microprofile.config.Config;
+
+/**
+ * Extracts the Model codegen properties from a given {@link Config} reference.
+ * These properties are then injected in the OpenAPI generator to tweak the code generation properties.
+ */
+public final class ModelCodegenConfigParser {
+
+    public static Map<String, Object> parse(final Config config, final String basePackage) {
+        final List<String> modelProperties = filterModelPropertyNames(config.getPropertyNames(),
+                resolveModelPackage(basePackage));
+        final Map<String, Object> modelConfig = new HashMap<>();
+        modelProperties.forEach(m -> {
+            modelConfig.put(m, config.getValue(m, String.class));
+        });
+        return modelConfig;
+    }
+
+    private static List<String> filterModelPropertyNames(final Iterable<String> propertyNames, final String modelPackage) {
+        return StreamSupport.stream(propertyNames.spliterator(), false)
+                .filter(propertyName -> propertyName.startsWith(modelPackage))
+                .collect(Collectors.toList());
+    }
+}

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/GeneratedOpenApiRestClientBuildItem.java

@@ -55,13 +55,16 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
     }
 
     protected void generate(CodeGenContext context, final Path openApiFilePath, final Path outDir) {
-        // TODO: do not generate with the output dir has generated files and the openapi file has the same checksum of the previous runz
+        // TODO: do not generate if the output dir has generated files and the openapi file has the same checksum of the previous run
+        final String basePackage = getResolvedBasePackageProperty(openApiFilePath);
+
         final OpenApiClientGeneratorWrapper generator = new OpenApiClientGeneratorWrapper(
                 openApiFilePath.normalize(), outDir)
+                        .withModelCodeGenConfiguration(ModelCodegenConfigParser.parse(context.config(), basePackage))
                         .withCircuitBreakerConfiguration(CircuitBreakerConfigurationParser.parse(
                                 context.config()));
         context.config()
-                .getOptionalValue(getResolvedBasePackageProperty(openApiFilePath), String.class)
+                .getOptionalValue(basePackage, String.class)
                 .ifPresent(generator::withBasePackage);
         context.config()
                 .getOptionalValue(getSkipFormModelPropertyName(openApiFilePath), String.class)