Send proper JSON POST data to /publicRooms (#16185)

The include_all_networks was previously sent in the JSON body as
string "true" and "false" instead of boolean true and false.
This commit is contained in:
Patrick Cloke 2023-08-25 12:11:40 -04:00 committed by GitHub
parent a8a46b1336
commit fcf7a5759e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 10 deletions

1
changelog.d/16185.bugfix Normal file
View file

@ -0,0 +1 @@
Fix a spec compliance issue where requests to the `/publicRooms` federation API would specify `include_all_networks` as a string.

View file

@ -475,13 +475,11 @@ class TransportLayerClient:
See synapse.federation.federation_client.FederationClient.get_public_rooms for See synapse.federation.federation_client.FederationClient.get_public_rooms for
more information. more information.
""" """
if search_filter:
# this uses MSC2197 (Search Filtering over Federation)
path = _create_v1_path("/publicRooms") path = _create_v1_path("/publicRooms")
data: Dict[str, Any] = { if search_filter:
"include_all_networks": "true" if include_all_networks else "false" # this uses MSC2197 (Search Filtering over Federation)
} data: Dict[str, Any] = {"include_all_networks": include_all_networks}
if third_party_instance_id: if third_party_instance_id:
data["third_party_instance_id"] = third_party_instance_id data["third_party_instance_id"] = third_party_instance_id
if limit: if limit:
@ -505,17 +503,15 @@ class TransportLayerClient:
) )
raise raise
else: else:
path = _create_v1_path("/publicRooms")
args: Dict[str, Union[str, Iterable[str]]] = { args: Dict[str, Union[str, Iterable[str]]] = {
"include_all_networks": "true" if include_all_networks else "false" "include_all_networks": "true" if include_all_networks else "false"
} }
if third_party_instance_id: if third_party_instance_id:
args["third_party_instance_id"] = (third_party_instance_id,) args["third_party_instance_id"] = third_party_instance_id
if limit: if limit:
args["limit"] = [str(limit)] args["limit"] = str(limit)
if since_token: if since_token:
args["since"] = [since_token] args["since"] = since_token
try: try:
response = await self.client.get_json( response = await self.client.get_json(