Release v0.5.10

Author: wojtekmach

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.5.10 (2025-03-21)
+
+  * [`Req`]: Add `Req.get_headers_list/1`.
+
 ## v0.5.9 (2025-03-17)
 
   * [`encode_body`]: Support any enumerable in `:form_multipart`
@@ -1204,6 +1208,7 @@ See "Adapter" section in `Req.Request` module documentation for more information
 [`Req.merge/2`]:                https://hexdocs.pm/req/Req.html#merge/2
 [`Req.parse_message/2`]:        https://hexdocs.pm/req/Req.html#merge/2
 [`Req.cancel_async_request/1`]: https://hexdocs.pm/req/Req.html#merge/2
+[`Req.get_headers_list/1`]:     https://hexdocs.pm/req/Req.html#get_headers_list/1
 
 [`Req.Request`]:                   https://hexdocs.pm/req/Req.Request.html
 [`Req.Request.new/1`]:             https://hexdocs.pm/req/Req.Request.html#new/1

lib/req.ex

@@ -101,7 +101,7 @@ defmodule Req do
 
   See `:into` option in `Req.new/1` documentation for more information on response body streaming.
 
-  ## Header Names
+  ## Headers
 
   The HTTP specification requires that header names should be case-insensitive.
   Req allows two ways to access the headers; using functions and by accessing
@@ -121,6 +121,17 @@ defmodule Req do
     * functions like `Req.Request.get_header/2`, `Req.Request.put_header/3`,
       `Req.Response.get_header/2`, `Req.Response.put_header/3`, etc
       automatically downcase the given header name.
+
+  > #### Note {: .tip}
+  >
+  > Most Elixir/Erlang HTTP clients represent headers as lists of tuples like:
+  >
+  > ```elixir
+  > [{"content-type", "text/plain"}]`
+  > ```
+  >
+  > For interopability with those, use
+  > `Req.get_headers_list/1`.
   """
 
   # Response streaming to caller:
@@ -177,7 +188,7 @@ defmodule Req do
 
       If you set `:headers` options both in `Req.new/1` and `request/2`, the header lists are merged.
 
-      See also "Header Names" section in the module documentation.
+      See also "Headers" section in the module documentation.
 
     * `:body` - the request body.
 

lib/req/request.ex

@@ -63,7 +63,7 @@ defmodule Req.Request do
     * `:url` - the HTTP request URL.
 
     * `:headers` - the HTTP request headers. The header names should be downcased.
-      See also "Header Names" section in `Req` module documentation.
+      See also "Headers" section in `Req` module documentation.
 
     * `:body` - the HTTP request body.
 
@@ -854,7 +854,7 @@ defmodule Req.Request do
   @doc """
   Returns the values of the header specified by `name`.
 
-  See also "Header Names" section in `Req` module documentation.
+  See also "Headers" section in `Req` module documentation.
 
   ## Examples
 
@@ -877,7 +877,7 @@ defmodule Req.Request do
 
   If the header was previously set, its value is overwritten.
 
-  See also "Header Names" section in `Req` module documentation.
+  See also "Headers" section in `Req` module documentation.
 
   ## Examples
 
@@ -941,7 +941,7 @@ defmodule Req.Request do
 
   All occurrences of the header are deleted, in case the header is repeated multiple times.
 
-  See also "Header Names" section in `Req` module documentation.
+  See also "Headers" section in `Req` module documentation.
 
   ## Examples
 

lib/req/response.ex

@@ -7,7 +7,7 @@ defmodule Req.Response do
     * `:status` - the HTTP status code.
 
     * `:headers` - the HTTP response headers. The header names should be downcased.
-      See also "Header Names" section in `Req` module documentation.
+      See also "Headers" section in `Req` module documentation.
 
     * `:body` - the HTTP response body.
 
@@ -150,7 +150,7 @@ defmodule Req.Response do
   @doc """
   Returns the values of the header specified by `name`.
 
-  See also "Header Names" section in `Req` module documentation.
+  See also "Headers" section in `Req` module documentation.
 
   ## Examples
 
@@ -166,7 +166,7 @@ defmodule Req.Response do
   Adds a new response header `name` if not present, otherwise replaces the
   previous value of that header with `value`.
 
-  See also "Header Names" section in `Req` module documentation.
+  See also "Headers" section in `Req` module documentation.
 
   ## Examples
 
@@ -184,7 +184,7 @@ defmodule Req.Response do
 
   All occurrences of the header are deleted, in case the header is repeated multiple times.
 
-  See also "Header Names" section in `Req` module documentation.
+  See also "Headers" section in `Req` module documentation.
 
   ## Examples
 

mix.exs

@@ -1,7 +1,7 @@
 defmodule Req.MixProject do
   use Mix.Project
 
-  @version "0.5.9"
+  @version "0.5.10"
   @source_url "https://github.com/wojtekmach/req"
 
   def project do