refactor(enum-utils): move normalization logic for enum handling to EnumUtils - #24382
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 2 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Mattias-Sehlstedt
force-pushed
the
enum-utils
branch
from
July 21, 2026 17:43
f031d6f to
0861724
Compare
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 moves the remaining logic for enum processing in the
OpenAPINormalizerto theEnumUtils.This is done to centralize the logic for Enum processing, with the goal of being able to introduce a more explicit
CodegenEnummodel to carry the reoccurring Enum logic.After this PR the
OpenAPI representation -> Normalized OpenAPI representationstep of the overall generator processhas been handled.
This should mean that we can now investigate
Normalized OpenAPI representation -> Codegen model, which is the step that would containCodegenEnum.Note that this intentionally removes the protected method
Schema createSimplifiedEnumSchema(...)from theOpenAPINormalizer.This is done since I do not believe it is a logical extension point for a user, and that it rather only is a helper for the main rule method (
Schema simplifyComposedSchemaWithEnums(...)). Thus that it belongs entirely in theUtilsclass. This is also based around the reasoning that the Normalizer mainly has one protected method per rules, so that if the user wants to adjust a rule, then they mainly override the entire rule-method.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.
Summary by cubic
Centralizes enum normalization in
EnumUtils, moving logic out ofOpenAPINormalizer. UnifiesoneOf/anyOf(including OAS 3.1const) into a single enum while preserving type and enum metadata.Refactors
EnumUtils.simplifyComposedSchemaWithEnums(schema, subSchemas, composedType, openAPI)to resolve$refs and merge enum/const sub-schemas, preservingtype,x-enum-descriptions, andx-enum-deprecated.OpenAPINormalizer.simplifyComposedSchemaWithEnums(...)now delegates toEnumUtilsand logs a standardized debug message when simplification occurs.EnumUtils(now private), and introducedEnumUtils.ONE_OF/EnumUtils.ANY_OFconstants for consistency.Migration
OpenAPINormalizer.createSimplifiedEnumSchema(...). If you customized it, overridesimplifyComposedSchemaWithEnums(...)instead.Written for commit 0861724. Summary will update on new commits.