Skip to content

[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
swapneswarsundarray:fix/protobuf-enum-reference
Open

[BUG] FIX protobuf-schema generator wraps standalone enums in message types but does not update field references #23559#23675
swapneswarsundarray wants to merge 1 commit intoOpenAPITools:masterfrom
swapneswarsundarray:fix/protobuf-enum-reference

Conversation

@swapneswarsundarray
Copy link
Copy Markdown

@swapneswarsundarray swapneswarsundarray commented May 2, 2026

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 ResourceType instead of ResourceType.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-type correctly for wrapped enums when extractEnumsToSeparateFiles is false, ensuring field references use the .Enum suffix.

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

  • 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.

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 .Enum type. Fixes #23559.

  • Bug Fixes
    • Set x-protobuf-data-type to <Type>.Enum for direct enums and arrays of enums when extractEnumsToSeparateFiles is false.
    • Aligns generated field types with the enum wrapping introduced in v7.20.0, preventing invalid code generation.

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

Copy link
Copy Markdown
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.

No issues found across 1 file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] protobuf-schema generator wraps standalone enums in message types but does not update field references

1 participant