Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Java] [Microprofile] Add Json-B polymorphism type info annotations #20164

Merged
merged 9 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 2 additions & 1 deletion bin/configs/java-microprofile-rest-client-3.0-jackson.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
generatorName: java
outputDir: samples/client/petstore/java/microprofile-rest-client-3.0-jackson
library: microprofile
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
serializationLibrary: jackson
Expand All @@ -10,3 +10,4 @@ additionalProperties:
microprofileRestClientVersion: "3.0"
hideGenerationTimestamp: true
useReflectionEqualsHashCode: true
openApiNullable: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be removed now, since openApiNullable is being disabled for microprofile. Same comment applies to bin/configs/java-microprofile-rest-client-3.0.yaml.

3 changes: 2 additions & 1 deletion bin/configs/java-microprofile-rest-client-3.0.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
generatorName: java
outputDir: samples/client/petstore/java/microprofile-rest-client-3.0
library: microprofile
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
artifactId: microprofile-rest-client-3
configKey: petstore
microprofileRestClientVersion: "3.0"
openApiNullable: false
2 changes: 1 addition & 1 deletion bin/configs/java-microprofile-rest-client.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
generatorName: java
outputDir: samples/client/petstore/java/microprofile-rest-client
library: microprofile
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
templateDir: modules/openapi-generator/src/main/resources/Java
additionalProperties:
artifactId: microprofile-rest-client
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,10 @@ public void processOpts() {
forceSerializationLibrary(SERIALIZATION_LIBRARY_JSONB);
}

// currently not supported for Microprofile (neither for Jackson nor JSON-B)
openApiNullable = false;
additionalProperties.put(OPENAPI_NULLABLE, false);

if (microprofileFramework.equals(MICROPROFILE_KUMULUZEE)) {
supportingFiles.add(new SupportingFile("kumuluzee.pom.mustache", "", "pom.xml"));
supportingFiles.add(new SupportingFile("kumuluzee.config.yaml.mustache", "src/main/resources", "config.yaml"));
Expand All @@ -636,6 +640,9 @@ public void processOpts() {

if ("3.0".equals(microprofileRestClientVersion)) {
additionalProperties.put("microprofile3", true);
if (getSerializationLibrary().equals(SERIALIZATION_LIBRARY_JSONB)) {
additionalProperties.put("jsonbPolymorphism", true);
}
}
} else if (APACHE.equals(getLibrary())) {
forceSerializationLibrary(SERIALIZATION_LIBRARY_JACKSON);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,12 @@ import {{rootJavaEEPackage}}.json.bind.serializer.SerializationContext;
import {{rootJavaEEPackage}}.json.stream.JsonGenerator;
import {{rootJavaEEPackage}}.json.stream.JsonParser;
import {{rootJavaEEPackage}}.json.bind.annotation.JsonbProperty;
{{#vendorExtensions.x-has-readonly-properties}}
{{#jsonbPolymorphism}}
import {{rootJavaEEPackage}}.json.bind.annotation.JsonbSubtype;
import {{rootJavaEEPackage}}.json.bind.annotation.JsonbTransient;
import {{rootJavaEEPackage}}.json.bind.annotation.JsonbTypeInfo;
{{/jsonbPolymorphism}}
import {{rootJavaEEPackage}}.json.bind.annotation.JsonbCreator;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JsonbCreator import was previously never included, the vendorExtensions.x-has-readonly-properties is only available in the #model context I think. For Jackson the import only work because it is added in the #imports.

{{/vendorExtensions.x-has-readonly-properties}}
{{/jsonb}}
{{#useBeanValidation}}
import {{rootJavaEEPackage}}.validation.constraints.*;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* {{{.}}}
*/
{{/description}}
{{>additionalModelTypeAnnotations}}
{{>additionalModelTypeAnnotations}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}
{{#vendorExtensions.x-class-extra-annotation}}
{{{vendorExtensions.x-class-extra-annotation}}}
{{/vendorExtensions.x-class-extra-annotation}}
Expand All @@ -45,7 +45,7 @@ public class {{classname}} {{#parent}}extends {{{.}}}{{/parent}}{{#vendorExtensi
*/
{{/description}}
{{^withXml}}
{{#jsonb}}@JsonbProperty("{{baseName}}"){{/jsonb}}
{{#jsonb}}{{^isDiscriminator}}@JsonbProperty("{{baseName}}"){{/isDiscriminator}}{{#isDiscriminator}}{{#jsonbPolymorphism}}@JsonbTransient{{/jsonbPolymorphism}}{{^jsonbPolymorphism}}@JsonbProperty("{{baseName}}"){{/jsonbPolymorphism}}{{/isDiscriminator}}{{/jsonb}}
{{/withXml}}
{{#vendorExtensions.x-field-extra-annotation}}
{{{vendorExtensions.x-field-extra-annotation}}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@
{{/jackson}}
<jakarta.activation.version>2.1.0</jakarta.activation.version>
<jakarta.annotation.version>2.0.0</jakarta.annotation.version>
<jakarta.json.bind.version>2.0.0</jakarta.json.bind.version>
<jakarta.json.bind.version>3.0.0</jakarta.json.bind.version>
<jakarta.json.version>2.0.1</jakarta.json.version>
<jakarta.ws.rs.version>3.0.0</jakarta.ws.rs.version>
<jakarta.xml.bind.version>3.0.1</jakarta.xml.bind.version>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@
{{/-last}}
{{/discriminator.mappedModels}}
{{/jackson}}
{{#jsonbPolymorphism}}
@JsonbTypeInfo(key = "{{{discriminator.propertyBaseName}}}"{{#discriminator.mappedModels}}{{#-first}}, value = {
{{/-first}}
@JsonbSubtype(alias = "{{^vendorExtensions.x-discriminator-value}}{{mappingName}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}", type = {{modelName}}.class),
{{#-last}}
}{{/-last}}{{/discriminator.mappedModels}}){{/jsonbPolymorphism}}
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@
<jackson.version>2.17.1</jackson.version>
<jakarta.activation.version>2.1.0</jakarta.activation.version>
<jakarta.annotation.version>2.0.0</jakarta.annotation.version>
<jakarta.json.bind.version>2.0.0</jakarta.json.bind.version>
<jakarta.json.bind.version>3.0.0</jakarta.json.bind.version>
<jakarta.json.version>2.0.1</jakarta.json.version>
<jakarta.ws.rs.version>3.0.0</jakarta.ws.rs.version>
<jakarta.xml.bind.version>3.0.1</jakarta.xml.bind.version>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,169 @@
README.md
docs/AdditionalPropertiesClass.md
docs/AllOfWithSingleRef.md
docs/Animal.md
docs/AnotherFakeApi.md
docs/ArrayOfArrayOfNumberOnly.md
docs/ArrayOfNumberOnly.md
docs/ArrayTest.md
docs/Capitalization.md
docs/Cat.md
docs/Category.md
docs/ChildWithNullable.md
docs/ClassModel.md
docs/Client.md
docs/DefaultApi.md
docs/DeprecatedObject.md
docs/Dog.md
docs/EnumArrays.md
docs/EnumClass.md
docs/EnumTest.md
docs/FakeApi.md
docs/FakeBigDecimalMap200Response.md
docs/FakeClassnameTags123Api.md
docs/FileSchemaTestClass.md
docs/Foo.md
docs/FooGetDefaultResponse.md
docs/FormatTest.md
docs/HasOnlyReadOnly.md
docs/HealthCheckResult.md
docs/MapTest.md
docs/MixedPropertiesAndAdditionalPropertiesClass.md
docs/Model200Response.md
docs/ModelApiResponse.md
docs/ModelFile.md
docs/ModelList.md
docs/ModelReturn.md
docs/Name.md
docs/NullableClass.md
docs/NumberOnly.md
docs/ObjectWithDeprecatedFields.md
docs/Order.md
docs/OuterComposite.md
docs/OuterEnum.md
docs/OuterEnumDefaultValue.md
docs/OuterEnumInteger.md
docs/OuterEnumIntegerDefaultValue.md
docs/OuterObjectWithEnumProperty.md
docs/ParentWithNullable.md
docs/Pet.md
docs/PetApi.md
docs/ReadOnlyFirst.md
docs/SingleRefType.md
docs/SpecialModelName.md
docs/StoreApi.md
docs/Tag.md
docs/TestInlineFreeformAdditionalPropertiesRequest.md
docs/User.md
docs/UserApi.md
pom.xml
src/main/java/org/openapitools/client/RFC3339DateFormat.java
src/main/java/org/openapitools/client/api/AnotherFakeApi.java
src/main/java/org/openapitools/client/api/ApiException.java
src/main/java/org/openapitools/client/api/ApiExceptionMapper.java
src/main/java/org/openapitools/client/api/DefaultApi.java
src/main/java/org/openapitools/client/api/FakeApi.java
src/main/java/org/openapitools/client/api/FakeClassnameTags123Api.java
src/main/java/org/openapitools/client/api/PetApi.java
src/main/java/org/openapitools/client/api/StoreApi.java
src/main/java/org/openapitools/client/api/UserApi.java
src/main/java/org/openapitools/client/model/AdditionalPropertiesClass.java
src/main/java/org/openapitools/client/model/AllOfWithSingleRef.java
src/main/java/org/openapitools/client/model/Animal.java
src/main/java/org/openapitools/client/model/ArrayOfArrayOfNumberOnly.java
src/main/java/org/openapitools/client/model/ArrayOfNumberOnly.java
src/main/java/org/openapitools/client/model/ArrayTest.java
src/main/java/org/openapitools/client/model/Capitalization.java
src/main/java/org/openapitools/client/model/Cat.java
src/main/java/org/openapitools/client/model/Category.java
src/main/java/org/openapitools/client/model/ChildWithNullable.java
src/main/java/org/openapitools/client/model/ClassModel.java
src/main/java/org/openapitools/client/model/Client.java
src/main/java/org/openapitools/client/model/DeprecatedObject.java
src/main/java/org/openapitools/client/model/Dog.java
src/main/java/org/openapitools/client/model/EnumArrays.java
src/main/java/org/openapitools/client/model/EnumClass.java
src/main/java/org/openapitools/client/model/EnumTest.java
src/main/java/org/openapitools/client/model/FakeBigDecimalMap200Response.java
src/main/java/org/openapitools/client/model/FileSchemaTestClass.java
src/main/java/org/openapitools/client/model/Foo.java
src/main/java/org/openapitools/client/model/FooGetDefaultResponse.java
src/main/java/org/openapitools/client/model/FormatTest.java
src/main/java/org/openapitools/client/model/HasOnlyReadOnly.java
src/main/java/org/openapitools/client/model/HealthCheckResult.java
src/main/java/org/openapitools/client/model/MapTest.java
src/main/java/org/openapitools/client/model/MixedPropertiesAndAdditionalPropertiesClass.java
src/main/java/org/openapitools/client/model/Model200Response.java
src/main/java/org/openapitools/client/model/ModelApiResponse.java
src/main/java/org/openapitools/client/model/ModelFile.java
src/main/java/org/openapitools/client/model/ModelList.java
src/main/java/org/openapitools/client/model/ModelReturn.java
src/main/java/org/openapitools/client/model/Name.java
src/main/java/org/openapitools/client/model/NullableClass.java
src/main/java/org/openapitools/client/model/NumberOnly.java
src/main/java/org/openapitools/client/model/ObjectWithDeprecatedFields.java
src/main/java/org/openapitools/client/model/Order.java
src/main/java/org/openapitools/client/model/OuterComposite.java
src/main/java/org/openapitools/client/model/OuterEnum.java
src/main/java/org/openapitools/client/model/OuterEnumDefaultValue.java
src/main/java/org/openapitools/client/model/OuterEnumInteger.java
src/main/java/org/openapitools/client/model/OuterEnumIntegerDefaultValue.java
src/main/java/org/openapitools/client/model/OuterObjectWithEnumProperty.java
src/main/java/org/openapitools/client/model/ParentWithNullable.java
src/main/java/org/openapitools/client/model/Pet.java
src/main/java/org/openapitools/client/model/ReadOnlyFirst.java
src/main/java/org/openapitools/client/model/SingleRefType.java
src/main/java/org/openapitools/client/model/SpecialModelName.java
src/main/java/org/openapitools/client/model/Tag.java
src/main/java/org/openapitools/client/model/TestInlineFreeformAdditionalPropertiesRequest.java
src/main/java/org/openapitools/client/model/User.java
src/test/java/org/openapitools/client/model/AdditionalPropertiesClassTest.java
src/test/java/org/openapitools/client/model/AllOfWithSingleRefTest.java
src/test/java/org/openapitools/client/model/AnimalTest.java
src/test/java/org/openapitools/client/model/ArrayOfArrayOfNumberOnlyTest.java
src/test/java/org/openapitools/client/model/ArrayOfNumberOnlyTest.java
src/test/java/org/openapitools/client/model/ArrayTestTest.java
src/test/java/org/openapitools/client/model/CapitalizationTest.java
src/test/java/org/openapitools/client/model/CatTest.java
src/test/java/org/openapitools/client/model/CategoryTest.java
src/test/java/org/openapitools/client/model/ChildWithNullableTest.java
src/test/java/org/openapitools/client/model/ClassModelTest.java
src/test/java/org/openapitools/client/model/ClientTest.java
src/test/java/org/openapitools/client/model/DeprecatedObjectTest.java
src/test/java/org/openapitools/client/model/DogTest.java
src/test/java/org/openapitools/client/model/EnumArraysTest.java
src/test/java/org/openapitools/client/model/EnumClassTest.java
src/test/java/org/openapitools/client/model/EnumTestTest.java
src/test/java/org/openapitools/client/model/FakeBigDecimalMap200ResponseTest.java
src/test/java/org/openapitools/client/model/FileSchemaTestClassTest.java
src/test/java/org/openapitools/client/model/FooGetDefaultResponseTest.java
src/test/java/org/openapitools/client/model/FooTest.java
src/test/java/org/openapitools/client/model/FormatTestTest.java
src/test/java/org/openapitools/client/model/HasOnlyReadOnlyTest.java
src/test/java/org/openapitools/client/model/HealthCheckResultTest.java
src/test/java/org/openapitools/client/model/MapTestTest.java
src/test/java/org/openapitools/client/model/MixedPropertiesAndAdditionalPropertiesClassTest.java
src/test/java/org/openapitools/client/model/Model200ResponseTest.java
src/test/java/org/openapitools/client/model/ModelApiResponseTest.java
src/test/java/org/openapitools/client/model/ModelFileTest.java
src/test/java/org/openapitools/client/model/ModelListTest.java
src/test/java/org/openapitools/client/model/ModelReturnTest.java
src/test/java/org/openapitools/client/model/NameTest.java
src/test/java/org/openapitools/client/model/NullableClassTest.java
src/test/java/org/openapitools/client/model/NumberOnlyTest.java
src/test/java/org/openapitools/client/model/ObjectWithDeprecatedFieldsTest.java
src/test/java/org/openapitools/client/model/OrderTest.java
src/test/java/org/openapitools/client/model/OuterCompositeTest.java
src/test/java/org/openapitools/client/model/OuterEnumDefaultValueTest.java
src/test/java/org/openapitools/client/model/OuterEnumIntegerDefaultValueTest.java
src/test/java/org/openapitools/client/model/OuterEnumIntegerTest.java
src/test/java/org/openapitools/client/model/OuterEnumTest.java
src/test/java/org/openapitools/client/model/OuterObjectWithEnumPropertyTest.java
src/test/java/org/openapitools/client/model/ParentWithNullableTest.java
src/test/java/org/openapitools/client/model/PetTest.java
src/test/java/org/openapitools/client/model/ReadOnlyFirstTest.java
src/test/java/org/openapitools/client/model/SingleRefTypeTest.java
src/test/java/org/openapitools/client/model/SpecialModelNameTest.java
src/test/java/org/openapitools/client/model/TagTest.java
src/test/java/org/openapitools/client/model/TestInlineFreeformAdditionalPropertiesRequestTest.java
src/test/java/org/openapitools/client/model/UserTest.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenAPI Petstore - MicroProfile Rest Client & MicroProfile Server

This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\

## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AdditionalPropertiesClass


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**mapProperty** | **Map&lt;String, String&gt;** | | [optional] |
|**mapOfMapProperty** | **Map&lt;String, Map&lt;String, String&gt;&gt;** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# AllOfWithSingleRef


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**username** | **String** | | [optional] |
|**singleRefType** | **SingleRefType** | | [optional] |



Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@


# Animal


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**className** | **String** | | |
|**color** | **String** | | [optional] |



Loading
Loading