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] Support oneOf and AnyOf #20798

Merged
merged 2 commits into from
Mar 7, 2025

Conversation

lucy66hw
Copy link
Contributor

@lucy66hw lucy66hw commented Mar 4, 2025

ref #20472
Support oneOf and anyOf.
Expecting protobuf message as following:
spec:

 Animal:
     anyOf:
       - $ref: '#/components/schemas/Cat'
       - $ref: "#/components/schemas/Dog"
       

protobuf:

 Message Animal {
   Cat cat = 1;
   Dog dog = 2;
 }

spec:

 Animal:
     oneOf:
       - $ref: '#/components/schemas/Cat'
       - $ref: "#/components/schemas/Dog"

protobuf:

   message Animal {
         oneof animal {
           Cat cat = 1;
           Dog dog = 2;
         }
 }

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.

@wing328
Copy link
Member

wing328 commented Mar 5, 2025

thanks for the PR

what about updating modules/openapi-generator/src/test/resources/3_0/protobuf/petstore.yaml with some test schemas for oneOf and anyOf to cover the change?

@lucy66hw
Copy link
Contributor Author

lucy66hw commented Mar 7, 2025

@wing328 Thanks for reviewing.
Updated modules/openapi-generator/src/test/resources/3_0/protobuf/petstore.yaml by adding oneOf and anyOf schema for testing.

@wing328
Copy link
Member

wing328 commented Mar 7, 2025

thanks for adding more tests.

let's give it a try

@wing328 wing328 merged commit b528e4a into OpenAPITools:master Mar 7, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants