Skip to content

[OCaml] Fix default optional list #20789

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

Merged
merged 2 commits into from
Mar 4, 2025

Conversation

sir4ur0n
Copy link
Contributor

@sir4ur0n sir4ur0n commented Mar 4, 2025

Add a default value for non-required lists.
Also, indent the model template to make it easier to read and maintain.

I have kept 2 commits to easily review the cleanup vs the actual fix, and its impact on the sample petstore.

Closes #20777

@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.

sir4ur0n added 2 commits March 4, 2025 14:51
* `{{^isContainer}}foobar{{/isContainer}}{{^isContainer}}` is equivalent to `{{^isContainer}}foobar`
* Add indentations to make it easier to read the template. The generated code is
uglier, but it is ok since users are encouraged to reformat anyway
@wing328
Copy link
Member

wing328 commented Mar 4, 2025

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@sir4ur0n
Copy link
Contributor Author

sir4ur0n commented Mar 4, 2025

Ah thanks, we mostly use Gitlab at Routine so I had not added my Routine email to my Github profile.

Fixed now 👍

@cgensoul
Copy link
Contributor

cgensoul commented Mar 4, 2025

I quickly reviewed both commits and everything looks good to me. It's a pity that the generated code looks uglier but I admit that writing the template on a single line to keep the output pretty was a real pain.

Thanks for your contributions to the OCaml generator ! I am glad someone uses it :)

@sir4ur0n
Copy link
Contributor Author

sir4ur0n commented Mar 4, 2025

If it were up to me I would ocamlformat on the flight each file before writing it, in the generator itself 😄
But in any case I call the formatter in my script that generates the code in my own repo so I'm not affected

@wing328 wing328 merged commit 0f13dfe into OpenAPITools:master Mar 4, 2025
16 checks passed
@wing328 wing328 added this to the 7.13.0 milestone Mar 4, 2025
@MisterDA
Copy link
Contributor

MisterDA commented Mar 4, 2025

FYI Jane Street started their own openapi 3 generator.
https://github.com/janestreet/ocaml_openapi_generator

kpy3 pushed a commit to kpy3/openapi-generator that referenced this pull request Mar 13, 2025
* Cleanup the existing model template

* `{{^isContainer}}foobar{{/isContainer}}{{^isContainer}}` is equivalent to `{{^isContainer}}foobar`
* Add indentations to make it easier to read the template. The generated code is
uglier, but it is ok since users are encouraged to reformat anyway

* Add a default value for non-required lists

Closes OpenAPITools#20777
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] Optional list fields are wrongly required
4 participants