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] Fix support for AllOf in protobuf-schema #7813

Conversation

OpenGuidou
Copy link
Contributor

@OpenGuidou OpenGuidou commented Oct 26, 2020

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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

Description

This fix is in 2 steps:

Fixed index for vars in generated protobuf files

To ensure the backward compatibility between two schema generations, I'm fixing the index generated for each attribute base on its name.

Correct support of AllOf

As there is no inheritance in protobuf, the use case 3_0/allOf_composition_discriminator.yaml doesn't work.
If the parent is referenced in the response, we can't use one of its children as instantiation (Dog for Pet for example).
The only way to make it work is to replicate all attributes from the children in the parents, including imports.

Before the fix, the generated Pet was:

syntax = "proto3";

package somepackage;

message Pet {

  string petType = 0;

}

After the fix:

syntax = "proto3";

package somepackage;

import public "models/lizard_all_of.proto";
import public "models/snake_all_of.proto";
import public "models/cat_all_of.proto";
import public "models/dog_all_of.proto";

message Pet {

  string petType = 140636936;

  bool hasLegs = 159828448;

  bool lovesRocks = 499337491;

  string name = 3373707;

  string bark = 3016376;

}

@OpenGuidou OpenGuidou force-pushed the Protobuf-generator-enhancements-for-AllOf branch 2 times, most recently from 276a394 to 70628e8 Compare October 26, 2020 16:00
@wing328 wing328 merged commit 4f2f807 into OpenAPITools:master Nov 2, 2020
@OpenGuidou OpenGuidou deleted the Protobuf-generator-enhancements-for-AllOf branch November 2, 2020 12:03
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.

None yet

2 participants