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] Additional enum type annotations #8389

Merged

Conversation

borsch
Copy link
Member

@borsch borsch commented Jan 9, 2021

Original issue: #6055
While original issue is about adding additionalModelTypeAnnotations to enum this is wrong solution since not all model annotations makes sence for enums. That's why I have added another option - additonalEnumTypeAnnotations

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@borsch
Copy link
Member Author

borsch commented Jan 9, 2021

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @nmuesch (2021/01)

@@ -10,3 +10,4 @@ additionalProperties:
hideGenerationTimestamp: "true"
serverPort: "8002"
additionalModelTypeAnnotations: '@com.fasterxml.jackson.annotation.JsonFilter(value = "filter-name");@com.fasterxml.jackson.annotation.JsonIgnoreProperties(value = "id")'
additionalEnumTypeAnnotations: '@com.fasterxml.jackson.annotation.JsonTypeName("myName")'
Copy link
Member

Choose a reason for hiding this comment

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

Seems to me the JsonTypeName is hardcoded to "myName" for all Enum models in the auto-generated code. What if the JsonTypeName is different for each Enum model?

Copy link
Member Author

Choose a reason for hiding this comment

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

@wing328 this is just an example of usage/verify everything works. This feature is about adding common annotations to all enums

Copy link
Member Author

Choose a reason for hiding this comment

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

@wing328 changed to @com.fasterxml.jackson.annotation.JsonFormat

…rator into additional-enum-type-annotations

� Conflicts:
�	modules/openapi-generator/src/main/resources/java-undertow-server/enumOuterClass.mustache
@borsch borsch requested a review from wing328 January 28, 2021 10:36
Copy link
Contributor

@Zomzog Zomzog left a comment

Choose a reason for hiding this comment

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

LGTM

@borsch
Copy link
Member Author

borsch commented Feb 7, 2021

@Zomzog can this PR be merged?

@Zomzog
Copy link
Contributor

Zomzog commented Feb 10, 2021

@Zomzog can this PR be merged?

I can't merge PRs.

@wing328 do you think this one can be merged?

…rator into additional-enum-type-annotations

� Conflicts:
�	modules/openapi-generator/src/main/resources/Java/modelEnum.mustache
�	modules/openapi-generator/src/main/resources/Java/modelInnerEnum.mustache
@borsch borsch closed this Mar 3, 2021
@borsch borsch reopened this Mar 3, 2021
@borsch borsch closed this Mar 4, 2021
@borsch borsch reopened this Mar 4, 2021
@borsch borsch closed this Mar 4, 2021
@borsch borsch reopened this Mar 4, 2021
@wing328
Copy link
Member

wing328 commented Mar 4, 2021

I'll take a look tomorrow. Please put the restart on hold.

@wing328 wing328 merged commit 976b4aa into OpenAPITools:master Mar 4, 2021
@borsch borsch deleted the additional-enum-type-annotations branch March 4, 2021 16:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants