fix(docs): drop redundant HTTP verb from default 'Call ...' summary#158
Merged
Conversation
FS verb-convention routes (users/[id]/get.ts → name users/:id/get, httpMethod GET) were rendering 'Call users/:id/get' in the docs — the trailing /get duplicates the method badge already shown next to the path. Both the OpenAPI and USD generators now strip the trailing verb segment from meta.name for the default summary when it matches the route's HTTP method, so the label reads 'Call users/:id'. Procedures with a real summary/description are untouched, as are names whose last segment isn't the route verb (e.g. users.list).
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
1 participant
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.
Problem
FS verb-convention routes (
users/[id]/get.ts→ nameusers/:id/get,httpMethod: GET) rendered in the docs as:The trailing
/getduplicates the HTTP method badge shown right next to the path.Fix
Both the OpenAPI and USD generators now strip the trailing verb segment from
meta.namewhen building the defaultCall ...summary, but only when that segment is exactly the route's HTTP method (and a non-verb segment precedes it):Procedures with a real
summary/descriptionare untouched. Names whose last segment isn't the route verb (e.g.users.list) are untouched.Tests
New cases in
test/docs/openapi/generator.int.test.ts. Full docs suite (146) + tsc green.🤖 Generated with Claude Code