[BUG] FIX protobuf-schema generator wraps standalone enums in message types but does not update field references #23559#23675
Open
swapneswarsundarray wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
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.
fixes #23559
Problem
Since v7.20.0, protobuf-schema wraps enums in message containers, but field references are not updated when enums are not extracted to separate files. Fields still reference
ResourceTypeinstead ofResourceType.Enum, leading to incorrect generated code.Root Cause
The enum template was updated to always wrap enums, but ProtobufSchemaCodegen only handled extracted enums and missed the wrapped enum case.
Solution
Updated the codegen logic to set
x-protobuf-data-typecorrectly for wrapped enums whenextractEnumsToSeparateFilesis false, ensuring field references use the.Enumsuffix.Impact
Fixes incorrect enum references in generated protobuf files and aligns field types with the wrapped enum structure introduced in v7.20.0.
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)Summary by cubic
Fixes incorrect enum field references when protobuf enums are wrapped in message types but not extracted. Fields now point to the inner
.Enumtype. Fixes #23559.x-protobuf-data-typeto<Type>.Enumfor direct enums and arrays of enums whenextractEnumsToSeparateFilesis false.Written for commit b559692. Summary will update on new commits.