summary refs log tree commit diff
path: root/synapse/http
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2017-10-27 10:59:50 +0100
committerRichard van der Hoff <richard@matrix.org>2017-10-27 10:59:50 +0100
commit173567a7f2fadb96eb580f4e2a5b51bbb2949baa (patch)
treea9612e6d4bd218667ad488966cc5e912cee20494 /synapse/http
parentFront-end proxy: pass through auth header (diff)
downloadsynapse-173567a7f2fadb96eb580f4e2a5b51bbb2949baa.tar.xz
Docstring for post_urlencoded_get_json
Diffstat (limited to 'synapse/http')
-rw-r--r--synapse/http/client.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/synapse/http/client.py b/synapse/http/client.py
index e96c027d75..24830a1526 100644
--- a/synapse/http/client.py
+++ b/synapse/http/client.py
@@ -115,6 +115,17 @@ class SimpleHttpClient(object):
 
     @defer.inlineCallbacks
     def post_urlencoded_get_json(self, uri, args={}, headers=None):
+        """
+        Args:
+            uri (str):
+            args (dict[str, str|List[str]]): query params
+            headers (dict[str, List[str]]|None): If not None, a map from
+               header name to a list of values for that header
+
+        Returns:
+            Deferred[object]: parsed json
+        """
+
         # TODO: Do we ever want to log message contents?
         logger.debug("post_urlencoded_get_json args: %s", args)