Add workaround note

pull/4840/head
Andrew Morgan 2019-03-13 11:14:43 +00:00
parent 97653ef1f4
commit cf301e37d8
1 changed files with 4 additions and 10 deletions

View File

@ -197,7 +197,6 @@ class MatrixFederationHttpClient(object):
long_retries=False, long_retries=False,
ignore_backoff=False, ignore_backoff=False,
backoff_on_404=False, backoff_on_404=False,
try_trailing_slash_on_404=False,
): ):
""" """
Sends a request to the given server. Sends a request to the given server.
@ -213,11 +212,6 @@ class MatrixFederationHttpClient(object):
backoff_on_404 (bool): Back off if we get a 404 backoff_on_404 (bool): Back off if we get a 404
try_trailing_slash_on_404 (bool): True if on a 404 response we
should try appending a trailing slash to the end of the
request. This will be attempted before backing off if backing
off has been enabled.
Returns: Returns:
Deferred[twisted.web.client.Response]: resolves with the HTTP Deferred[twisted.web.client.Response]: resolves with the HTTP
response object on success. response object on success.
@ -502,9 +496,9 @@ class MatrixFederationHttpClient(object):
a failure of the server (and should therefore back off future a failure of the server (and should therefore back off future
requests). requests).
try_trailing_slash_on_404 (bool): True if on a 404 response we try_trailing_slash_on_404 (bool): True if on a 404 response we
should try appending a trailing slash to the end of the should try appending a trailing slash to the end of the request.
request. This will be attempted before backing off if backing Workaround for #3622 in Synapse <0.99.2. This will be attempted
off has been enabled. before backing off if backing off has been enabled.
Returns: Returns:
Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The
@ -632,7 +626,7 @@ class MatrixFederationHttpClient(object):
and try the request anyway. and try the request anyway.
try_trailing_slash_on_404 (bool): True if on a 404 response we try_trailing_slash_on_404 (bool): True if on a 404 response we
should try appending a trailing slash to the end of the should try appending a trailing slash to the end of the
request. request. Workaround for #3622 in Synapse <0.99.2.
Returns: Returns:
Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The Deferred[dict|list]: Succeeds when we get a 2xx HTTP response. The
result will be the decoded JSON body. result will be the decoded JSON body.