fix: Support Service doc comments for OpenApi/Swagger generation #6200
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tions When generating OpenAPI/Swagger documentation, this change adds support for using service-level doc comments from proto files as tag descriptions. Previously, tag descriptions could only be set via explicit OpenAPI options. Now, if no explicit description is provided, the generator will fall back to using the leading comments from the service definition in the proto file. Fixes grpc-ecosystem#4419 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]> Signed-off-by: majiayu000 <[email protected]>
johanbrandhorst
requested changes
Dec 31, 2025
Collaborator
johanbrandhorst
left a comment
johanbrandhorst
left a comment
There was a problem hiding this comment.
Thanks for your PR! I think you'll need to regenerate the files after a change like this. See CONTRIBUTING.md in the root of the repo for the steps involved.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes #4419
Changes
protoc-gen-openapiv2/internal/genopenapi/template.goprotoc-gen-openapiv2/internal/genopenapi/template_test.go