Skip to content

[feat] [protobuf] Improve protobuf generator with switch useSimplifiedEnumNames #21052

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

Merged
merged 6 commits into from
Apr 16, 2025

Conversation

andrewwilsonnew
Copy link
Contributor

@andrewwilsonnew andrewwilsonnew commented Apr 8, 2025

#21054

@wing328 we generate wire classes with our protos so we'd like the enum names to be FOO rather than TEST_STRING_ENUM_FOO. I've added a switch useSimplifiedEnumNames (default old value). Any chance we could get this into the patch?

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.

}

private void testEnumValues(boolean simpleEnumValue) {
final Schema model = new Schema()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Modelled this test on this one

@@ -84,6 +86,8 @@ public class ProtobufSchemaCodegen extends DefaultCodegen implements CodegenConf

private boolean wrapComplexType = true;

private boolean simpleEnumName = false;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you want to look at the output flip this flag and run the generator, but this is covered by unit tests

Copy link
Contributor

Choose a reason for hiding this comment

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

We could also test the output by adding the flag in bin/configs/protobuf-schema-config.yaml .

Copy link
Contributor Author

@andrewwilsonnew andrewwilsonnew Apr 9, 2025

Choose a reason for hiding this comment

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

Done. Good to go @wing328

@wing328
Copy link
Member

wing328 commented Apr 8, 2025

thanks for the PR

cc @lucy66hw as well

@andrewwilsonnew
Copy link
Contributor Author

@wing328 ready to go

@andrewwilsonnew andrewwilsonnew changed the title improving protobuf generator with simple enum names improving protobuf generator with switch useSimplifiedEnumNames Apr 10, 2025
@andrewwilsonnew andrewwilsonnew changed the title improving protobuf generator with switch useSimplifiedEnumNames [feat] [protobuf] Improve protobuf generator with switch useSimplifiedEnumNames Apr 11, 2025
@wing328 wing328 merged commit 1136872 into OpenAPITools:master Apr 16, 2025
18 checks passed
@wing328 wing328 added this to the 7.13.0 milestone Apr 16, 2025
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.

3 participants