[Bug #3829] [protoc-gen-openapiv2] consider openapiv2_tag.name attribute when generating ope…

[omrikiei]

…napi docs

This PR adds code that references the name attribute in the openapiv2 tag attribute.

References to other Issues or PRs

Fixes #3829

Have you read the Contributing Guidelines?

Brief description of what is fixed or changed

Other comments

Summary by CodeRabbit

• New Features

  • Enhanced the API service by adding a new name field to improve service identification.

• Refactor

  • Improved internal logic to dynamically assign service tag names based on configuration.

[coderabbitai]

Walkthrough

The changes involve an update to the ABitOfEverythingService to respect a new name field for OpenAPI service tags and a tweak in the template.go to ensure the service name is correctly overridden in the generated OpenAPI specification when specified by openapiv2_tag.name. This addresses a bug where the specified name was not being used.

Changes

File Path	Change Summary
.../proto/examplepb/a_bit_of_everything.proto	Added name field to openapiv2_tag option.
protoc-gen-openapiv2/internal/genopenapi/template.go	Added conditional to set tag.Name from opts.GetName().
.../internal/genopenapi/template_test.go	Modified "Name" field of "ExampleService" struct and added new structs with "Name" and "Description" fields.

Assessment against linked issues

Objective	Addressed	Explanation
Bug fix for openapiv2_tag.name not working (#3829)	✅

Poem

In the code where tags did stray,
A rabbit hopped to save the day.
With a name now set, so clear and bright,
Swagger shines with much delight. 🌟🐇

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• You can reply to a review comment made by CodeRabbit.
• You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
• You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between de32b4f and c72cf3c.

Files ignored due to filter (14)

• examples/internal/clients/abe/api/swagger.yaml
• examples/internal/clients/echo/api/swagger.yaml
• examples/internal/clients/responsebody/api/swagger.yaml
• examples/internal/proto/examplepb/a_bit_of_everything.pb.go
• examples/internal/proto/examplepb/a_bit_of_everything.swagger.json
• examples/internal/proto/examplepb/echo_service.swagger.json
• examples/internal/proto/examplepb/flow_combination.swagger.json
• examples/internal/proto/examplepb/generated_input.swagger.json
• examples/internal/proto/examplepb/non_standard_names.swagger.json
• examples/internal/proto/examplepb/openapi_merge_a.swagger.json
• examples/internal/proto/examplepb/openapi_merge_b.swagger.json
• examples/internal/proto/examplepb/response_body_service.swagger.json
• examples/internal/proto/examplepb/stream.swagger.json
• examples/internal/proto/examplepb/wrappers.swagger.json

Files selected for processing (2)

• examples/internal/proto/examplepb/a_bit_of_everything.proto (1 hunks)
• protoc-gen-openapiv2/internal/genopenapi/template.go (1 hunks)

Additional comments: 2

examples/internal/proto/examplepb/a_bit_of_everything.proto (1)

• 495-501: The addition of the name field to the openapiv2_tag option in the ABitOfEverythingService service declaration correctly addresses the bug described in issue openapiv2_tag.name does not work #3829. This change ensures that the name attribute will override the service name in the generated OpenAPI documentation.

protoc-gen-openapiv2/internal/genopenapi/template.go (1)

• 1108-1116: The change in the renderServiceTags function correctly sets the tag.Name based on the opts.GetName() result, which should fix the issue with the openapiv2_tag.name attribute not being overridden as expected. Ensure that the rest of the codebase that relies on service tag names is also updated to handle this new logic where the tag name can be different from the service name.

[johanbrandhorst]

Great spot. I think you'll need to regenerate the files using our version of buf. The changes to the other swagger files are because of a newer version of Buf being used. See CONTRIBUTING.md for instructions.

[omrikiei]

Hi @johanbrandhorst - Indeed I followed the CONTRIBUTING.md guide.
The docker image is built for amd64 architecture (I use an M1 macbook) and I'm not able to successfully run it..
Building the image as is for my architecture also didn't work - I had to modify the Dockerfile for use the main branch for dev containers and use default JRE - once I was able to build the image I got these artifacts (with extra newlines). these artifacts are the result. Could you try to clone my forked repo and generate with your environment?

[omrikiei]

@johanbrandhorst I managed to obtain an arm64 laptop and pushed the artifacts, should work now...

[johanbrandhorst]

Looks like there are still some minor test issues, probably some test that now does the right thing?

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c72cf3c and 97f0581.

Files ignored due to filter (2)

• examples/internal/clients/abe/api/swagger.yaml
• examples/internal/proto/examplepb/a_bit_of_everything.swagger.json

Files selected for processing (1)

• protoc-gen-openapiv2/internal/genopenapi/template_test.go (2 hunks)

Additional comments: 2

protoc-gen-openapiv2/internal/genopenapi/template_test.go (2)

• 6322-6323: The change in the "Name" field to "ExampleService!" seems to be intentional and is consistent with the PR objectives. Ensure that this change is reflected in all relevant parts of the documentation and any tests that may be affected.

• 6358-6361: The addition of the new struct with "Name" as "service tag" and "Description" as "ExampleService!" is consistent with the PR objectives. Verify that this new struct is properly integrated and documented within the codebase.

[johanbrandhorst]

Thanks for your contribution! I'll be making a release once #3743 is merged.

[omrikiei]

Thank you!