Skip to content

Conversation

@sir4ur0n
Copy link
Contributor

This MR fixes:

  • I noticed that encoding/decoding was incorrect for free-form objects, so here is the fix, together with a new test for good measure (I was surprised that the generic fake petstore did not have a required free-form object, and I did not dare add it because it would change many samples outside of OCaml)
  • the ocaml-oneOf was incorrectly named, so I cleaned this mess I created in an earlier MR 😅
  • a minor fix where record fields now use the Odoc syntax (and thus are moved after the field). OCaml documentation requires 2 stars (*) to be valid documentation. It also means that now field documentation is visible via LSP (see screenshot below)
  • remove some files in the ocaml sample that were not actually generated by the spec
image

@cgensoul @wing328

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 WSL)
    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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Member

wing328 commented Aug 26, 2025

thanks for the pr

let's give it a try

@wing328 wing328 merged commit 9c11fcf into OpenAPITools:master Aug 26, 2025
19 checks passed
@wing328
Copy link
Member

wing328 commented Aug 26, 2025

when you've time, can you please PM me via Slack?

https://join.slack.com/t/openapi-generator/shared_invite/zt-36ucx4ybl-jYrN6euoYn6zxXNZdldoZA

@sir4ur0n sir4ur0n deleted the fix/ocaml-required-additional-properties branch August 26, 2025 12:25
@wing328 wing328 added this to the 7.16.0 milestone Aug 26, 2025
Goopher pushed a commit to Goopher/openapi-generator that referenced this pull request Sep 9, 2025
…ts; Odoc for record fields (OpenAPITools#21819)

* [OCaml] Fix inconsistent oneOf primitive sample name

* [OCaml] Fix encoding/decoding for free-form required fields

* [OCaml] Change field comment to Odoc, move it after the field

As per Odoc documentation, record field documentation should be *after* the
field, not before.
See https://ocaml.github.io/odoc/odoc/odoc_for_authors.html#special_comments
type `my_record`

* [OCaml] Cleanup non-generated files for ocaml sample
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.

2 participants