Skip to content

Wrong Faraday options format in docs/file.README.html #688

@vc-jl

Description

@vc-jl

oauth2/docs/file.README.html

Lines 1186 to 1201 in 3e18dc0

```ruby
client = OAuth2::Client.new(
id,
secret,
site: "https://provider.example.com",
connection_opts: {
request: 5, timeout: 15,
proxy: ENV["HTTPS_PROXY"],
ssl: true,
},
) do |faraday|
faraday.request(:url_encoded)
# faraday.response :logger, Logger.new($stdout) # see OAUTH_DEBUG below
faraday.adapter(:net_http_persistent) # or any Faraday adapter you need
end
```

It looks as if the connection_opts are in a wrong format and they were meant to be:

connection_opts: {
  request: {open_timeout: 5, timeout: 15},
  proxy: ENV["HTTPS_PROXY"], 
  ssl: {verify: true},
}

just as in README.md. If that's the case, I'd be happy to open a PR.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions