Support OpenAPI 3.1 enum-via-oneOf idiom#2
Merged
mromaszewicz merged 1 commit intooapi-codegen:mainfrom Apr 15, 2026
Merged
Conversation
A scalar schema whose `oneOf` branches each carry `const` + `title` is the spec-native way to express a named enum with per-value documentation (OpenAPI 3.1 / JSON Schema 2020-12). Previously such schemas generated a `json.RawMessage`-backed union; now they produce a regular Go enum with titled constants and per-value doc comments sourced from `description`. Detection is strict — every branch must carry both `const` and `title`, and the outer schema must declare a scalar `type` (`string` or `integer`) — so schemas that don't cleanly match fall through to the existing oneOf union generator unchanged. The behavior is default-on; `generation.skip-enum-via-oneof: true` restores the legacy output.
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
1 participant
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.
A scalar schema whose
oneOfbranches each carryconst+titleis the spec-native way to express a named enum with per-value documentation (OpenAPI 3.1 / JSON Schema 2020-12). Previously such schemas generated ajson.RawMessage-backed union; now they produce a regular Go enum with titled constants and per-value doc comments sourced fromdescription.Detection is strict — every branch must carry both
constandtitle, and the outer schema must declare a scalartype(stringorinteger) — so schemas that don't cleanly match fall through to the existing oneOf union generator unchanged. The behavior is default-on;generation.skip-enum-via-oneof: truerestores the legacy output.