aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoradamw <adam@warski.org>2017-11-22 14:43:26 +0100
committeradamw <adam@warski.org>2017-11-22 14:43:26 +0100
commitfe50ad485c037c30dada741cf87e552a99c2d9bb (patch)
tree7f3b864b179e2d4dd5ad9b7f02380733b3b0d52d /docs
parentc5b39e46b30d20c0bfcefb5f4a12f9b3169007ee (diff)
downloadsttp-fe50ad485c037c30dada741cf87e552a99c2d9bb.tar.gz
sttp-fe50ad485c037c30dada741cf87e552a99c2d9bb.tar.bz2
sttp-fe50ad485c037c30dada741cf87e552a99c2d9bb.zip
Documentation notes about Uri
Diffstat (limited to 'docs')
-rw-r--r--docs/requests/uri.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/requests/uri.rst b/docs/requests/uri.rst
index 93c7b47..53eeb0e 100644
--- a/docs/requests/uri.rst
+++ b/docs/requests/uri.rst
@@ -24,10 +24,12 @@ Using the URI interpolator it's possible to conveniently create ``Uri`` instance
Note the ``uri`` prefix before the string and the standard Scala string-embedding syntax (``$user``, ``$filter``).
-Any values embedded in the URI will be URL-encoded, taking into account the context (e.g., the whitespace in ``user`` will be %-encoded as ``%20D``, while the whitespace in ``filter`` will be query-encoded as ``+``).
+Any values embedded in the URI will be URL-encoded, taking into account the context (e.g., the whitespace in ``user`` will be %-encoded as ``%20D``, while the whitespace in ``filter`` will be query-encoded as ``+``). On the other hand, parts of the URI given as literal strings (not embedded values), are assumed to be URL-encoded and thus will be decoded when creating a ``Uri`` instance.
All components of the URI can be embedded from values: scheme, username/password, host, port, path, query and fragment.
+Both the ``Uri`` class and the interpolator can be used stand-alone, without using the rest of sttp. Conversions are available both from and to ``java.net.URI``; ``Uri.toString`` returns the URI as a ``String``.
+
Optional values
---------------