Correctly normalize rails paths with optional bound params #167
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
mercedesb
force-pushed
the
fix-regex-for-normalizing-rails-path-with-optional-params
branch
3 times, most recently
from
44b1553
to
38b3f01
Compare
mercedesb
force-pushed
the
fix-regex-for-normalizing-rails-path-with-optional-params
branch
from
38b3f01
to
cb8964b
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #167 +/- ##
=======================================
Coverage 96.80% 96.80%
=======================================
Files 15 15
Lines 470 470
Branches 102 102
=======================================
Hits 455 455
Misses 15 15 ☔ View full report in Codecov by Sentry. |
exoego
reviewed
Jan 11, 2024
| @@ -341,6 +341,48 @@ | |||
| } | |||
| } | |||
| }, | |||
| "/optional_params(/{id})": { | |||
There was a problem hiding this comment.
@mercedesb Could you check OpenAPI documentation to verify "/optional_params(/{id})" is valid format of optional path parameter?
I've looked https://swagger.io/docs/specification/paths-and-operations/
but could not find
There was a problem hiding this comment.
Ahhh good call, it does not. Here's an open issue on the OpenAPI Specification repo where people are asking for it. I'll close this. Thanks for asking this question! I didn't think to check this.
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.
Rails supports optional bound parameters.
When using optional params, the generated paths by this gem look something like:
/optional_params/(/{id)}instead of the expected/optional_params/(/{id})If you use tools like widdershins to generate docs from your OpenAPI specification, this can break the parsing.
This PR updates the regex to not include the closing parentheses in the capture group during path normalization.