From 73cfd8cffc6a896ce1835cc0cefce69881fa048c Mon Sep 17 00:00:00 2001
From: Jonas Hartmann <netzebw@jonas-hartmann.com>
Date: Mon, 13 Jan 2025 08:54:34 +0100
Subject: [PATCH] req-docs
---
lib/ex_aws/request/req.ex | 4 +++-
mix.exs | 2 +-
2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/lib/ex_aws/request/req.ex b/lib/ex_aws/request/req.ex
index d6b2cfbd..ed411f8a 100644
--- a/lib/ex_aws/request/req.ex
+++ b/lib/ex_aws/request/req.ex
@@ -4,6 +4,8 @@ defmodule ExAws.Request.Req do
@moduledoc """
Configuration for `m:Req`.
+ The minimum recommended `req` version is `0.4.0`.
+
Options can be set for `m:Req` with the following config:
config :ex_aws, :req_opts,
@@ -31,7 +33,7 @@ defmodule ExAws.Request.Req do
end
end
- # Req uses :follow_redirects, but some clients pass the :hackney option
+ # Req >= 0.4.0 uses :redirect, but some clients pass the :hackney option
# :follow_redirect. Rename the option for Req to use.
defp rename_follow_redirect(opts) do
{follow, opts} = Keyword.pop(opts, :follow_redirect, false)
diff --git a/mix.exs b/mix.exs
index da860225..050eac82 100644
--- a/mix.exs
+++ b/mix.exs
@@ -45,7 +45,7 @@ defmodule ExAws.Mixfile do
{:dialyxir, "~> 1.0", only: [:dev, :test], runtime: false},
{:ex_doc, "~> 0.16", only: [:dev, :test]},
{:hackney, "~> 1.16", optional: true},
- {:req, "~> 0.3", optional: true},
+ {:req, "~> 0.4", optional: true},
{:jason, "~> 1.1", optional: true},
{:jsx, "~> 2.8 or ~> 3.0", optional: true},
{:mox, "~> 1.0", only: :test},