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

[OCaml] Add key to each model field #20766

Merged
merged 2 commits into from
Mar 4, 2025
Merged

Conversation

sir4ur0n
Copy link
Contributor

@sir4ur0n sir4ur0n commented Feb 28, 2025

Add a [@key "someField"] annotation to each model field, to avoid mismatches when the JSON field is not in snake_case.

Closes #20765

For steps to reproduce/validate, see the issue

@cgensoul

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.

Add a `[@key "someField"]` annotation to each model field, to avoid mismatches when the JSON field is not in snake_case.

Closes OpenAPITools#20765
@wing328
Copy link
Member

wing328 commented Mar 2, 2025

thanks for the PR.

can you please PM me via Slack to have a quick discussion on this change in the coming week?

My timezone is +0800 (Hong Kong)

https://join.slack.com/t/openapi-generator/shared_invite/zt-2wmkn4s8g-n19PJ99Y6Vei74WMUIehQA

@sir4ur0n
Copy link
Contributor Author

sir4ur0n commented Mar 4, 2025

I contacted you yesterday on Slack 👋

@wing328 wing328 added this to the 7.13.0 milestone Mar 4, 2025
@wing328 wing328 merged commit 90de8dc into OpenAPITools:master Mar 4, 2025
16 checks passed
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.

[BUG][OCaml] Incorrect support of JSON fields not in snake_case
2 participants