xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

zulip: Fix principals default for remove_subscriptions.

Browse source 
The documented API for DELETE /api/v1/users/me/subscriptions is that
principals should be omitted to remove a subscription for the calling
user.  A call with principals=[] should have a different meaning, but
a server bug currently conflates this with a call omitting principals.
Avoid relying on this bug.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg 2022-01-12 19:26:51 -08:00 committed by Tim Abbott
parent 70b86614bd
commit 68128640bf
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
zulip/zulip/__init__.py
View file

@ -1383,12 +1383,16 @@ class Client:
)
def remove_subscriptions(
self, streams: Iterable[str], principals: Union[Sequence[str], Sequence[int]] = []
self,
streams: Iterable[str],
principals: Optional[Union[Sequence[str], Sequence[int]]] = None,
) -> Dict[str, Any]:
"""
See examples/unsubscribe for example usage.
"""
request = dict(subscriptions=streams, principals=principals)
request: Dict[str, object] = dict(subscriptions=streams)
if principals is not None:
request["principals"] = principals
return self.call_endpoint(
url="users/me/subscriptions",
method="DELETE",