OpenAPITools / OpenAPITools/openapi-generator

[REQ] custom timeout open_timeout / read_timeout / write_timeout

Open
#15,252 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Would like to be able to customise open_timeout / read_timeout / write_timeout on the faraday connection instead of a blanket timeout

so we can have detail control over how long we want to wait for:

  • issue with establishing the connection
  • issue with the server processing the request
  • etc

Describe the solution you'd like

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache#L71

to allow additional configuration of open_timeout / read_timeout / write_timeout

Describe alternatives you've considered

this is my current workaround https://github.com/OpenAPITools/openapi-generator/issues/15252#issuecomment-1514299595

Additional context

...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review modules/openapi-generator/src/main/resources/ruby-client/api_client_faraday_partial.mustache around line 71, then compare it with the workaround in the linked issue comment. The change is complete when generated Ruby Faraday clients can configure open_timeout, read_timeout, and write_timeout separately instead of relying only on a blanket timeout.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.