feat: strip router path patterns from the OpenAPI document - #1091
Open
stareezy-1 wants to merge 1 commit into
Open
feat: strip router path patterns from the OpenAPI document#1091stareezy-1 wants to merge 1 commit into
stareezy-1 wants to merge 1 commit into
Conversation
Router-specific path parameter patterns such as chi's `{id:[0-9]+}` are
valid for routing but produce a broken OpenAPI path. Document the operation
under the normalized path (`{id}`) while leaving op.Path untouched for the
router, using a brace-aware scan so quantifiers like {3} inside the pattern
do not terminate the segment early.
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.
Summary
Fixes #922
Problem
Chi supports regex in path parameters, e.g.
/users/{id:[0-9]+}, and huma routes them fine — but the same path is used verbatim as the OpenAPIpathskey, so the generated document contains an invalid path:Reproduction: register any operation on a regex path with
humachiand inspectapi.OpenAPI().Paths.Fix
Normalize the documented path in
AddOperation—{id:[0-9]+}becomes{id}— while leavingop.Pathuntouched so the router keeps the regex. The normalization uses a brace-aware scan, so quantifiers like{3}inside the pattern do not terminate the segment early ({id:[a-z]{3}}→{id}).Tests
TestRegexPathParamNormalizedInOpenAPIinhuma_test.go:Pathscontains/users/{id}Pathsdoes not contain/users/{id:[0-9]+}GET /users/123via the chi routerAll existing tests continue to pass (
go test -race ./...).