Skip to content
GitLab

Ruby client: escape path parameters

Merged Administrator requested to merge github/fork/ccouzens/ruby_client_escape_path_parameters into master

Created by: ccouzens

Path parameters should be escaped when encoded into the path.

In the path '/pet/{petId}' let's pretend petId is a string instead of a number.

If the user uses "Bobby" as the petId then they correctly get the path '/pet/Bobby'. But if they put 'Bobby/Tables' as the petId then they used to get the path '/pet/Bobby/Tables' which will be interpreted by the server as a different route.

Using CGI::Escape they now get '/pet/Bobby%2FTables' which is correct.

Ruby technical committee: @cliffano (2017/07) @zlx (2017/09) @autopp (2019/02)

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.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.
  • 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.

Description of the PR

See top