From 3f4e79d42f7a81fa3f8e790630f71570287c2be0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johan=20L=C3=B6vdahl?= <johan.lovdahl@uxvibe.com>
Date: Sun, 13 Nov 2016 15:39:40 +0100
Subject: Add functions for getting and setting response headers

---
 .../manual/cowboy_req.set_resp_headers.asciidoc    | 51 ++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 doc/src/manual/cowboy_req.set_resp_headers.asciidoc

(limited to 'doc/src/manual/cowboy_req.set_resp_headers.asciidoc')

diff --git a/doc/src/manual/cowboy_req.set_resp_headers.asciidoc b/doc/src/manual/cowboy_req.set_resp_headers.asciidoc
new file mode 100644
index 0000000..e5a0fcb
--- /dev/null
+++ b/doc/src/manual/cowboy_req.set_resp_headers.asciidoc
@@ -0,0 +1,51 @@
+= cowboy_req:set_resp_headers(3)
+
+== Name
+
+cowboy_req:set_resp_headers - Set several response headers
+
+== Description
+
+[source,erlang]
+----
+set_resp_headers(Headers, Req) -> cowboy_req:req()
+
+Headers :: cowboy:http_headers()
+Req     :: cowboy_req:req()
+----
+
+Add all given headers to the response headers.
+If a given header key already exists in the currently set
+response-header map the given value will overwrite the old.
+
+== Arguments
+
+Headers::
+
+A map with keys and values as binary strings.
+Key values should be lowercase to function properly.
+
+Req::
+
+The Req object.
+
+== Return value
+
+A request object updated with the given response headers.
+
+== Changelog
+
+* *2.0*: Function introduced.
+
+== Examples
+
+.Get all response headers
+[source,erlang]
+----
+Req1 = cowboy_req:set_resp_headers(#{<<"x-header-test">> => <<"1">>}, Req0).
+----
+
+== See also
+
+link:man:cowboy_req(3)[cowboy_req(3)],
+link:man:cowboy_req:resp_headers(3)[cowboy_req:resp_headers(3)]
\ No newline at end of file
-- 
cgit v1.2.3

