Created by: ccouzens
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. https://github.com/OpenAPITools/openapi-generator/pull/3039
Unfortunately, some projects rely on the incorrect behaviour. In particular, they need slashes not to be escaped.
For example: https://github.com/OpenAPITools/openapi-generator/issues/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
-
Read the contribution guidelines. -
Ran the shell script under ./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.shif 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. -
Filed the PR against the correct branch: master,4.1.x,5.0.x. Default:master. -
Copied the technical committee to review the pull request if your PR is targeting a particular programming language.
@cliffano @zlx @autopp
Description of the PR
Fix #3119 (closed) See above