janek/mostr-zulip-bot
1
0
Fork 0
Code Issues Pull requests Releases Activity

api: Update add_realm_filter to support url_template.

Browse source 
This adds support to adding linkifiers with the new URL template syntax.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
This commit is contained in:
Zixuan James Li 2022-10-15 20:41:39 -04:00 • committed by Tim Abbott
parent ae142a380d
commit 8016ed144c
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
zulip/zulip/__init__.py
View file

@ -1040,20 +1040,24 @@ class Client:
method="GET",
)
def add_realm_filter(self, pattern: str, url_format_string: str) -> Dict[str, Any]:
def add_realm_filter(self, pattern: str, url_template: str) -> Dict[str, Any]:
"""
Example usage:
>>> client.add_realm_filter('#(?P<id>[0-9]+)', 'https://github.com/zulip/zulip/issues/%(id)s')
>>> client.add_realm_filter('#(?P<id>[0-9]+)', 'https://github.com/zulip/zulip/issues/{id}')
{'result': 'success', 'msg': '', 'id': 42}
"""
data = {"pattern": pattern}
if self.feature_level >= 176:
# Starting from feature level 176, we use RFC 6570 compliant URL
# templates instead.
data["url_template"] = url_template
else:
data["url_format_string"] = url_template
return self.call_endpoint(
url="realm/filters",
method="POST",
request={
"pattern": pattern,
"url_format_string": url_format_string,
},
request=data,
)
def remove_realm_filter(self, filter_id: int) -> Dict[str, Any]:
@ -1809,7 +1813,7 @@ if LEGACY_CLIENT_INTERFACE_FROM_SERVER_DOCS_VERSION == "3":
Example usage:
>>> client.get_realm_filters()
{'result': 'success', 'msg': '', 'filters': [['#(?P<id>[0-9]+)', 'https://github.com/zulip/zulip/issues/%(id)s', 1]]}
{'result': 'success', 'msg': '', 'filters': [['#(?P<id>[0-9]+)', 'https://github.com/zulip/zulip/issues/{id}', 1]]}
"""
# This interface was removed in 4d482e0ef30297f716885fd8246f4638a856ba3b
return self.call_endpoint(