[Rust Server] fix handling of special characters in path param names #4897
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
Let's consider this as a bug fix and see if anyone has issues with backward-compatibility. |
wing328
reviewed
Jan 17, 2020
|
|
||
| pathFormatString = pathFormatString.replace(paramSearch, paramReplace); | ||
| } | ||
| op.vendorExtensions.put("pathFormatString", pathFormatString); |
There was a problem hiding this comment.
I'll rename this with x-path-format-string to conform the vendor extension naming convention (mentioned in the contributing guidelines)
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.
The rust server generator used the names of path parameters directly as the names of regex capture groups and format string substitutions. This is invalid when the path parameter is not a legal rust identifier. I couldn't find a specification of what characters OpenAPI permits in these names, and at least one other generator (python-flask, I think) was sanitizing path param names, so that's what I've done here.
Since I've changed the templates to use
{{paramName}}instead of{{baseName}}this has the side effect of changing the previously working camel-casepetIdtopet_id. This seems desirable from a rust style perspective, but I'm not sure if it could be a backwards compatibility concern.PR checklist
./bin/(or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).master,4.3.x,5.0.x. Default:master.