Skip to content

Conversation

elagerho
Copy link
Contributor

@elagerho elagerho commented Apr 9, 2025

This PR honors required openapi fields when generating Jackson's @JsonProperty annotations. It will appropriately cause deserialization to throw if incoming JSON is not conforming. Adjacent @JsonBProperty annotations do already honor the required fields.

Tested by local override of the templates using the Java with Jackson generator. Issue here. It might be considered a breaking change, since Jackson deserialization will throw. For now filing against master.

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.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@elagerho
Copy link
Contributor Author

elagerho commented Apr 9, 2025

Is Circle a bit flaky maybe? Seems like all nodes do the same thing.

@elagerho elagerho marked this pull request as ready for review April 9, 2025 10:01
@elagerho
Copy link
Contributor Author

elagerho commented Apr 9, 2025

Pinging the Java committee. Would love your input on this. @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) @martin-mfg (2023/08)

@wing328
Copy link
Member

wing328 commented Apr 25, 2025

thanks for the pr.

i think we also need to handle the case in which the required field is nullable. ({{#isNullable}} ... {{/isNullable}} in mustache template)

@Binnette
Copy link

Binnette commented May 5, 2025

Hi @elagerho, thanks for this PR! 👍

To rephrase, if my field is required in my OpenApi contract (required: ["my_field"] in its parent object), then the Java property in the generated file will be annotated with @JsonProperty(required=true).

Is that correct? If so, I'm very interested in this PR! 😃

Ah! it seems the answer is yes. As stand in your issue report #21060

@wing328
Copy link
Member

wing328 commented Sep 3, 2025

merged with #21876 with support for nullable as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants