[Fix][OCaml] Incorrect encoding/decoding for required free-form objects; Odoc for record fields#21819
Merged
wing328 merged 4 commits intoOpenAPITools:masterfrom Aug 26, 2025
Conversation
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`
Member
|
thanks for the pr let's give it a try |
Member
|
when you've time, can you please PM me via Slack? https://join.slack.com/t/openapi-generator/shared_invite/zt-36ucx4ybl-jYrN6euoYn6zxXNZdldoZA |
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This MR fixes:
ocaml-oneOfwas incorrectly named, so I cleaned this mess I created in an earlier MR 😅*) to be valid documentation. It also means that now field documentation is visible via LSP (see screenshot below)ocamlsample that were not actually generated by the spec@cgensoul @wing328
PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)