fix path with : in the middle #3517 issue #3532
Open
Conversation
This file contains 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
arthaali
reviewed
Aug 23, 2023
| @@ -3918,6 +3918,7 @@ func TestTemplateToOpenAPIPath(t *testing.T) { | |||
| {"/{user.name=prefix/*}:customMethod", "/{user.name}:customMethod"}, | |||
| {"/{user.name=prefix1/*/prefix2/*}:customMethod", "/{user.name}:customMethod"}, | |||
| {"/{parent=prefix/*}/children:customMethod", "/{parent}/children:customMethod"}, | |||
| {"/item/search:items/{item_no_query}", "/item/search:items/{item_no_query}"}, | |||
There was a problem hiding this comment.
it should be camel case here.. "/item/search:items/{itemNoQuery}"
Maybe you need to add a test to TestTemplateWithJsonCamelCase https://github.com/grpc-ecosystem/grpc-gateway/blob/main/protoc-gen-openapiv2/internal/genopenapi/template_test.go#L3843C6-L3843C35
There was a problem hiding this comment.
Yes, thanks. This is the proper place for the test. Also corrected the fix in the actual function, deleted the wrong if depth == 0 branch...
This should also reproduce the issue and at least fixes the case mentioned in the issue.
| parts = append(parts, buffer) | ||
| buffer = path[i:] | ||
| break pathLoop | ||
| } |
There was a problem hiding this comment.
I'm worried about just removing this, are all the tests still passing?
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.
References to other Issues or PRs
Fixes #3517
Brief description of what is fixed or changed
The assumption that a colon can only appear on the end of a path seems to wrong. Removing the special case code that exploits this assumption seems to fix the issue. However I'm not sure about the full impact on other parts of the code.
Other comments