Uh oh!
There was an error while loading. Please reload this page.
[Java][Jersey2] Add JsonTypeName annotation - #6551
Conversation
| @JsonSubTypes.Type(value = {{modelName}}.class, name = "{{^vendorExtensions.x-discriminator-value}}{{mappingName}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}"), | ||
| {{/discriminator.mappedModels}} | ||
| {{#isClassnameSanitized}} | ||
| @JsonSubTypes.Type(value = {{classname}}.class, name = "{{name}}"), |
There was a problem hiding this comment.
When the OpenAPI schema name has special characters, we need to have a mapping between the class name and the OpenAPI name.
For example, if the OpenAPI schema name is MySchemaName._-Characters, then the generated code should have a @JsonSubTypes.Type mapping as shown below.
@JsonSubTypes({
@JsonSubTypes.Type(value = MySchemaNameCharacters.class, name = "MySchemaName._-Characters"),
})
publicclassMySchemaNameCharactersextendsParent {…ersey2-subtype-annotation
| # A string is a sequence of zero or more Unicode characters [UNICODE]. | ||
| # Note that this citation references the latest version of Unicode | ||
| # rather than a specific release. Any character may be escaped. | ||
| # MySchemaNameWithUnusual#$12.3!@#%🍇🍅😀🏄🏾♂️Characters: |
There was a problem hiding this comment.
@wing328 , fyi MySchemaNameWithUnusual#$12.3!@#%🍇🍅😀🏄🏾♂️Characters is a valid JSON schema name, but OpenAPI generator does not allow this.
There are two unit tests:
To run the unit tests:
bin/generate-samples.sh bin/configs/java-jersey2-special-characters.yaml
cd samples/openapi3/client/petstore/java/jersey2-java8-special-characters/
mvn package
//@JsonSubTypes.Type(value = {{classname}}.class, name = "{{name}}"), |
This is a fix for #6462.
When a schema name includes special characters such as ".", the name of the generated Java is different from the OpenAPI schema name. For example, when the name of the schema is
_special_model.name_in the OAS doc, the name of the generated class isSpecialModelName.This PR adds a mapping in the @JsonSubTypes annotation to ensure serialization/deserialization works as expected.
Without this PR, I am getting the following error:
PR checklist
./bin/(or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).master,4.3.x,5.0.x. Default:master.