[BUG] [Ruby] client escapes all path parameters

[dkliban]

Bug Report Checklist

• Have you provided a full/minimal spec to reproduce the issue?
• Have you validated the input using an OpenAPI validator (example)?
• What's the version of OpenAPI Generator used?
• Have you search for related issues/PRs?
• What's the actual output vs expected output?
• [Optional] Bounty to sponsor the fix (example)

Description

Our application's OpenAPI schema contains path parameters that contains '/'. The latest generated Ruby client stopped working for all the operations that contain a path parameter with '/' in it. This is a regression for our use case of openapi-generator.

openapi-generator version

I am using the latest openapi-generator-cli docker image. This is a regression since v4.0.0 tag.

OpenAPI declaration file content or url

https://docs.pulpproject.org/en/3.0/nightly/api.json

Command line used for generation

docker run -u $(id -u) --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
    -i /local/api.json \
    -g ruby \
    -o /local/$1-client \
    -DgemName=$1_client \
    -DgemLicense="GPLv2" \
    -DgemVersion=0.1.0rc2 \
    --skip-validate-spec \
    --strict-spec=false

Steps to reproduce

Related issues/PRs

#3039

Suggest a fix

@ccouzens, could you make the path parameter escaping optional?

[auto-labeler]

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[ccouzens]

Hi @dkliban

I'm sorry to hear I broke your use case.

Just to confirm, in your use case slashes in path item values shouldn't be escaped?

There are suggestions that this should become an officially supported use case in the future.

@ccouzens, could you make the path parameter escaping optional?

I'll see what I can do.

[ccouzens]

I suspect monkey patching build_request_url would undo the escaping of slashes:

module Petstore
  class ApiClient
    def build_request_url(path)
      # Add leading and trailing slashes to path
      path = "/#{path}".gsub(/\/+/, '/')
      # restore slashes
      path = path.gsub('%2F', '/')
      @config.base_url + path
    end
  end
end

[ccouzens]

Hi @dkliban,

Can you let me know if the monkey patch is an appropriate work around for your use case?

module Petstore will need to replaced with the name of your generated client.
Add the code after the require statement that loads in your generated client.

It works by adding in this line:

      # restore slashes
      path = path.gsub('%2F', '/')

Kind regards,

Chris

[dkliban]

@ccouzens, Thanks for the suggestion. This solution would work, but it would always be in danger of breaking with each update of the Ruby client templates. What about a new config boolean for the Ruby client generator that would enable/disable path parameter encoding? "encodePathParameters" could default to False and users would set it to True when they want to enable it. The default behavior would be consistent with other language client generators. What do you think?

[ccouzens]

Hi @dkliban

"encodePathParameters" could default to False and users would set it to True when they want to enable it. The default behavior would be consistent with other language client generators. What do you think?

I can't speak for every language client generators, but OpenAPI clients are meant to encode slashes in path parameters. See this discussion for example: OAI/OpenAPI-Specification#892

As such, I think the default should be to percent encode special characters special characters in path parameters.

If there was such a flag, ideally it would sit within the OpenAPI declaration file. I'd be surprised if this happened in the next few months. (see the linked discussion)

What's the next best alternative?

Requiring the flag at each method call

get_pet_by_id(5, encode_path_parameters: false)

Advantages: flexibility
Disadvantages: I suspect you and any other users who need this field need it for all their endpoints. Flexibility isn't very helpful if you need to specify it everywhere.

A setting on the Configuration object

config = Petstore::Configuration.new do |config|
  config.encode_path_parameters = false
end
api = Petstore::PetApi.new(Petstore::ApiClient.new(config))

Generation time setting

openapi-generator -i petstore.yml -g ruby --additional-properties encodePathParameters=false

I think this has the benefit of the person generating and distributing the client getting to decide the behaviour.

Again, I'll see what I can do,

[dkliban]

The Generation Time Setting seems like the most ideal solution to me, @ccouzens.

[ccouzens]

Hi @dkliban ,

Before I raise a pull request, can you confirm this would fix your problem?

https://github.com/OpenAPITools/openapi-generator/compare/master...ccouzens:ruby_compatibility_with_old_path_parameter_behavior?expand=1

Usage:

--additional-properties compatibilitySlashesInPathParameters

[dkliban]

@ccouzens , yes, that string substitution would fix the problem we are experiencing. However, I didn't compile and run your changes.

[ccouzens]

@dkliban - I've opened a pull request to enable compatibility with the old behaviour. #3130

[autopp]

@dkliban Thank you for report this issue and sorry for the regression.

Just to confirm, in your use case slashes in path item values shouldn't be escaped?

There are suggestions that this should become an officially supported use case in the future.

As @ccouzens said, I would like to hear more about your use case.
At the moment I think as follows.

• Slashes in path parameters should be URL encoded.
• If the option is really needed, the generator should do URL encoding by default.

@OpenAPITools/generator-core-team
When I checked about other client generations (python,go, javascript), they seemed that they did not encode the path parameter.
I think it is better if the behavior regarding path parameters and URL encode is consistent among clients. I would like to hear the opinion of the core team.

[dkliban]

@autopp My application uses the href property of a resource as the main identifier. So when using the generated client the developer writes code that looks like this:

artifacts_api.artifacts_read('/pulp/api/v3/artifacts/22991d3e-3c77-4936-88eb-84ac58fae46d/')

The href being passed in is the whole path for that resource. So the OpenAPI schema[0] for that operation has a path that consists of a single path parameter called artifact_href.

[0] https://docs.pulpproject.org/en/3.0/nightly/api.json