Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Protobuf Schema] Map Field Handling in Composed Schemas #21002

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

lucy66hw
Copy link
Contributor

@lucy66hw lucy66hw commented Mar 31, 2025

This PR addresses a corner case where a map defined within an composed schema is being ignored during Protobuf generation.
Previously, the pet map (the field defined via additionalProperties) was not being handled properly, resulting in its omission from the generated proto file. the schema like the following:

schemas:
      Dog:
         allOf:
            - $ref: '#/components/schemas/DogBase'
            - type: object
              additionalProperties:
                 title: pet
                 $ref: '#/components/schemas/Pet'
              minProperties: 1
      Pet:
        type: string
      DogBase:
         type: object
         properties:
            bark:
               type: boolean
            breed:
               type: string
               enum: [ Dingo, Husky, Retriever, Shepherd ]

With this PR, the generator now correctly detects and processes the pet map, ensuring that it is included in the generated Protobuf message.

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 Git BASH)
    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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@Override
protected void addProperties(Map<String, Schema> properties, List<String> required, Schema schema, Set<Schema> visitedSchemas){
super.addProperties(properties, required, schema, visitedSchemas);
if(schema.getAdditionalProperties() != null) {
Copy link
Member

@wing328 wing328 Apr 1, 2025

Choose a reason for hiding this comment

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

can you please add some comments explaining what the code block does (e.g. what schema(s) it tries to handle) ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@wing328 thanks for reviewing the PR. I had added explaining comment on top of the code.

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.

2 participants