Ruby: Add option for old path parameter behaviour #3130
Closed
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 OpenAPI standard is to percent encode special characters such as
slashes, hashes and question marks when they appear in path parameters.
The Ruby client generator was buggy. It did not encode these characters.
So a few days ago I fixed it.
#3039
Unfortunately, some projects rely on the incorrect behaviour.
In particular, they need slashes not to be escaped.
For example:
#3119
I've added an additional property to the ruby generator to undo the
escaping of slashes in path parameters. This will enable those projects
to continue to make use of the Ruby client code generator.
--additional-properties compatibilitySlashesInPathParameters
I'd suggest the long term plan for projects that need this behaviour
should be to work with the OpenAPI Specification writers to support
marking certain path parameters as allowing slashes.
PR checklist
./bin/
to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\
. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.master
,4.1.x
,5.0.x
. Default:master
.@cliffano @zlx @autopp
Description of the PR
Fix #3119
See above