Docstring

This commit is contained in:
David Baker 2018-06-04 12:05:58 +01:00
parent 6a29e815fc
commit c5930d513a

View file

@ -265,6 +265,20 @@ class MatrixFederationHttpClient(object):
def sign_request(self, destination, method, url_bytes, headers_dict, def sign_request(self, destination, method, url_bytes, headers_dict,
content=None, destination_is=None): content=None, destination_is=None):
"""
Signs a request by adding an Authorization header to headers_dict
Args:
destination (str): The desination home server of the request. May be null if the
destination is an identity server, in which case destination_is must be non-null.
method (str): The HTTP method of the request
url_bytes (str): ?
headers_dict (dict): Dictionary of request headers to append to
content (str): The body of the request
destination_is (str): As 'destination', but if the destination is an identity server
Returns:
Deferred
"""
request = { request = {
"method": method, "method": method,
"uri": url_bytes, "uri": url_bytes,