aboutsummaryrefslogtreecommitdiff
path: root/docs/conf
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf')
-rw-r--r--docs/conf/redirects.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/conf/redirects.rst b/docs/conf/redirects.rst
new file mode 100644
index 0000000..e826c7c
--- /dev/null
+++ b/docs/conf/redirects.rst
@@ -0,0 +1,10 @@
+Redirects
+=========
+
+By default, sttp follows redirects.
+
+If you'd like to disable following redirects, use the ``followRedirects`` method::
+
+ sttp.followRedirects(false)
+
+If a request has been redirected, the history of all followed redirects is accessible through the ``response.history`` list. The first response (oldest) comes first. The body of each response will be a ``Left(message)`` (as the status code is non-2xx), where the message is whatever the server returned as the response body.