diff --git a/synapse/rest/client/models.py b/synapse/rest/client/models.py index c7fabcf6d2..eb725cf1c1 100644 --- a/synapse/rest/client/models.py +++ b/synapse/rest/client/models.py @@ -117,6 +117,8 @@ class MsisdnRequestTokenBody(ThreepidRequestTokenBody): class SlidingSyncBody(RequestBodyModel): """ + Sliding Sync API request body. + Attributes: lists: Sliding window API. A map of list key to list information (:class:`SlidingSyncList`). Max lists: 100. The list keys should be diff --git a/tests/handlers/test_sliding_sync.py b/tests/handlers/test_sliding_sync.py index 222f6088c9..aebc661023 100644 --- a/tests/handlers/test_sliding_sync.py +++ b/tests/handlers/test_sliding_sync.py @@ -12,7 +12,10 @@ from tests.unittest import HomeserverTestCase class GetSyncRoomIdsForUserTestCase(HomeserverTestCase): - """Tests Sliding Sync handler `get_sync_room_ids_for_user`.""" + """ + Tests Sliding Sync handler `get_sync_room_ids_for_user()` to make sure it returns + the correct list of rooms IDs. + """ servlets = [ admin.register_servlets, @@ -192,7 +195,7 @@ class GetSyncRoomIdsForUserTestCase(HomeserverTestCase): def test_no_joins_after_to_token(self) -> None: """ - Rooms we join after the `to_token` should not show up. See condition "2b)" + Rooms we join after the `to_token` should *not* show up. See condition "2b)" comments in the `get_sync_room_ids_for_user()` method. """ user1_id = self.register_user("user1", "pass")