Skip to content

[OCaml][Fix] Unreferenced enum + Direct recursive types#23005

Open
sir4ur0n wants to merge 7 commits intoOpenAPITools:masterfrom
sir4ur0n:fix/ocaml-unreferenced-enum
Open

[OCaml][Fix] Unreferenced enum + Direct recursive types#23005
sir4ur0n wants to merge 7 commits intoOpenAPITools:masterfrom
sir4ur0n:fix/ocaml-unreferenced-enum

Conversation

@sir4ur0n
Copy link
Contributor

@sir4ur0n sir4ur0n commented Feb 18, 2026

  • Add support for directly recursive types (e.g., A -> A)
    • Mutually recursive types are not supported because this is MUCH more complex to implement in OCaml and I don't have the time to do the huge refactor needed for them
  • Fix a bug where empty string enums broke generation
  • Fix a bug where enums inside anyOf/oneOf/allOf were not correctly detected

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.

@cgensoul @wing328

CI fails for seemingly unrelated reasons but I can't manually restart it.


Summary by cubic

Fixes OCaml generator crashes with enums inside anyOf/allOf/oneOf and adds first-class support for direct self-recursive models across fields, arrays, and maps. Adds tests and samples, updates CI to OCaml 5.3, and improves generated README titles.

  • Bug Fixes

    • Traverse composed schemas to collect enums (including branch-level and nested $ref) and prefix their types with Enums.
    • Use order‑independent enum hashing with Set, fixing “unreferenced enum” and supporting empty‑string enum values.
  • New Features

    • Normalize self-references to t for direct recursion in properties, arrays, and maps; support required recursive fields and multiple recursive properties.
    • Add 3.0 test specs and samples for composed-schema enums and recursion; remove “(beta)” from OCaml generator help and title READMEs as “OCaml API client for ”.

Written for commit df59629. Summary will update on new commits.

Problem: The OCaml client generator threw IllegalArgumentException: Unreferenced enum when encountering enums inside composed schemas
  (anyOf/allOf/oneOf).

Root Causes:
1. The enum collection logic didn't traverse into composed schemas
2. The enum hashing used order-dependent string concatenation, causing lookups to fail when enum values appeared in different orders
3. Enums directly within composed schema branches (not in properties) weren't collected

Solution:

1. Added composed schema support:
  - New `collectEnumSchemasFromComposed()` method handles `anyOf/allOf/oneOf`
  - New `collectEnumSchemasFromList()` method recursively processes composed schema branches
  - Enums directly in composed schemas (not just in properties) are now collected
2. Refactored enum hashing to use Set:
  - Changed from comma-joined strings to `TreeSet<String>` for order-independent, collision-free hashing
  - Handles edge cases like empty string enums `""`
3. Added test case:
  - Tests enums in nested composed schemas
  - Tests enum with empty string value in anyOf
@sir4ur0n sir4ur0n force-pushed the fix/ocaml-unreferenced-enum branch from 42aac2b to 067bd6b Compare February 18, 2026 13:30
@sir4ur0n sir4ur0n changed the title [OCaml][Fix] Unreferenced enum [OCaml][Fix] Unreferenced enum + Direct recursive types Feb 18, 2026
@sir4ur0n sir4ur0n force-pushed the fix/ocaml-unreferenced-enum branch from 834c084 to 47680b2 Compare February 18, 2026 14:20
@sir4ur0n sir4ur0n marked this pull request as ready for review February 19, 2026 16:00
@sir4ur0n
Copy link
Contributor Author

@cgensoul @wing328 this is ready for review 🙏

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 issues found across 49 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="samples/client/petstore/ocaml-recursion-test/README.md">

<violation number="1" location="samples/client/petstore/ocaml-recursion-test/README.md:1">
P2: Malformed Markdown header - title text should be on the same line as the `#` marker</violation>
</file>

<file name="samples/client/petstore/ocaml-recursion-test/src/models/required_recursion.ml">

<violation number="1" location="samples/client/petstore/ocaml-recursion-test/src/models/required_recursion.ml:18">
P1: Syntax error in generated OCaml record: `[@key]` attributes are misplaced after field separators (`;`). Attributes must be placed after the field type and BEFORE the semicolon, e.g., `value: string [@key "value"];`. The current placement will cause compilation failure and break JSON serialization.</violation>
</file>

<file name="samples/client/petstore/ocaml-enum-in-composed-schema/src/models/test_model.ml">

<violation number="1" location="samples/client/petstore/ocaml-enum-in-composed-schema/src/models/test_model.ml:17">
P0: Incorrect placement of `[@key]` attributes breaks JSON serialization mappings</violation>
</file>

Since this is your first cubic review, here's how it works:

  • cubic automatically reviews your code and comments on bugs and improvements
  • Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
  • Add one-off context when rerunning by tagging @cubic-dev-ai with guidance or docs links (including llms.txt)
  • Ask questions if you need clarification on any suggestion

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

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

Comments