chore(cli): test to specify 'summary' as an option in gRPC#10552
Merged
kennyderek merged 15 commits intomainfrom Nov 14, 2025
Merged
chore(cli): test to specify 'summary' as an option in gRPC#10552kennyderek merged 15 commits intomainfrom
kennyderek merged 15 commits intomainfrom
Conversation
- Add grpc-comments fixture with proto configuration - Create comments.proto with CreateComment RPC using google.api.http annotations - Add test case to verify gRPC proto processing pipeline - Generate FDR snapshots for regression testing Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
- Add fern/options.proto defining custom summary option for RPC methods - Update grpc-comments fixture to use fern.summary option - Custom summary 'Add a Comment' now appears in FDR output - Remove unused grpc-gateway dependency from fixture This allows users to explicitly set endpoint display names in gRPC proto files using: option (fern.summary) = "Custom Name"; Requires protoc-gen-openapi to support reading the fern.summary option. Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Resolved conflict in versions.yml by bumping version to 0.122.2 Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Temporarily pin CI to use the modified protoc-gen-openapi that supports reading the custom fern.summary option. This allows the grpc-comments test to pass with the custom summary 'Add a Comment'. Once fern-api/protoc-gen-openapi#13 is merged and released, this should be updated to use @latest or a tagged release. Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
Update both ci.yml and bootstrap.sh to use the modified protoc-gen-openapi that supports reading the custom fern.summary option from proto files. This allows the grpc-comments test to pass with the custom summary 'Add a Comment' instead of the auto-generated 'Create Comment'. Once fern-api/protoc-gen-openapi#13 is merged and released, these should be updated to use @latest or a tagged release. Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
The changelog validator requires a minor version bump (0.122.1 -> 0.123.0) for 'feat' type changes per semver rules. Changed from 0.122.2 to 0.123.0. Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
kennyderek
approved these changes
Nov 14, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Refs: Session requested by kenny@buildwithfern.com (kenny@buildwithfern.com)
Session URL: https://app.devin.ai/sessions/35ba7fe604104e64afe342a676df4463
This PR adds support for custom
fern.summaryproto option to explicitly set gRPC endpoint display names in proto files. It also improves the automatic name generation for gRPC endpoints by extracting method names from request type names (e.g., "CreateCommentRequest" → "Create Comment").Changes Made
grpc-commentstest fixture demonstrating gRPC proto with custom endpoint namingconvertPackage.tsto extract method names from request type names for better display names (e.g., "CreateCommentRequest" → "Create Comment")fern.summaryproto option in test fixture (proto file includesoption (fern.summary) = "Add a Comment";)protoc-gen-openapito commit1aa7fe8in CI workflows and bootstrap.sh to support the custom option (depends on feat: add support for custom fern.summary proto option protoc-gen-openapi#13)Testing
openapi-from-flag.test.tsfor gRPC proto processingImportant Notes for Reviewers
protoc-gen-openapito a specific commit from PR #13. Once that PR is merged and released, the pin should be updated to@latestor a tagged release.Key areas to review:
Name extraction logic in
convertPackage.ts(lines 170-183): The code extracts method names from request types ending in "Request". Verify this doesn't break existing endpoints or miss edge cases.Conditional logic: The endpoint name is determined by:
displayNamefrom IRfern.summaryoption (via OpenAPI summary field)Test fixture structure: The
fern/options.protofile is copied into the test fixture for local testing. This is intentional for the test but should eventually be a proper Buf module dependency.Pinned dependency: Verify the commit hash
1aa7fe870834ed27024dc44afd95648a0d63ec57is correct and matches protoc-gen-openapi PR improvement: misc fixes to generate ir #13.