Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api-docs: Make realm_linkifiers current API clear in description. 

Adjusts the descriptions of realm_linkifiers (and deprecated
realm_filters) events and register response fields so that the
description of the current API is complete without the feature
level 176 **Changes** notes.
This commit is contained in:
Lauryn Menard 2023-05-22 12:30:46 +02:00 committed by Tim Abbott
parent fd02648b0e
commit 6d6a335e32
1 changed files with 31 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
zerver/openapi/zulip.yaml
View File

@ -3110,14 +3110,18 @@ paths:
Processing this event is important for doing Markdown local echo Processing this event is important for doing Markdown local echo
correctly. correctly.
**Changes**: As of Zulip 7.0 (feature level 176), clients will not Clients will not receive this event unless the event queue is
receive this event unless the event queue is registered with the registered with the client capability
client capability `{"linkifier_url_template": true}`. This is because `{"linkifier_url_template": true}`.
the change to specify linkifiers with a URL template instead of a
URL format string is not backwards-compatible.
See [`POST /register`](/api/register-queue#parameter-client_capabilities) See [`POST /register`](/api/register-queue#parameter-client_capabilities)
for how client capabilities can be specified. for how client capabilities can be specified.
**Changes**: Before Zulip 7.0 (feature level 176), the
`linkifier_url_template` client capability was not required. The
requirement was added because linkifiers were updated to contain
a URL template instead of a URL format string, which was not a
backwards-compatible change.
New in Zulip 4.0 (feature level 54), replacing the deprecated New in Zulip 4.0 (feature level 54), replacing the deprecated
`realm_filters` event type. `realm_filters` event type.
properties: properties:
@ -3171,12 +3175,13 @@ paths:
additionalProperties: false additionalProperties: false
deprecated: true deprecated: true
description: | description: |
Legacy event type. Previously, sent to all users in a Zulip organization Legacy event type that is no longer sent to clients. Previously, sent
when the set of configured [linkifiers](/help/add-a-custom-linkifier) to all users in a Zulip organization when the set of configured
for the organization has changed. [linkifiers](/help/add-a-custom-linkifier) for the organization was
changed.
**Changes**: As of Zulip 7.0 (feature level 176), clients will no longer **Changes**: Prior to Zulip 7.0 (feature level 176), this event type
receive this event. was sent to clients.
**Deprecated** in Zulip 4.0 (feature level 54), and replaced by the **Deprecated** in Zulip 4.0 (feature level 54), and replaced by the
`realm_linkifiers` event type, which has a clearer name and format. `realm_linkifiers` event type, which has a clearer name and format.
@ -3199,10 +3204,10 @@ paths:
description: | description: |
An array of tuples, where each tuple described a linkifier. The first An array of tuples, where each tuple described a linkifier. The first
element of the tuple was a string regex pattern which represented the element of the tuple was a string regex pattern which represented the
pattern that to be linkified on matching, for example `"#(?P<id>[123])"`. pattern to be linkified on matching, for example `"#(?P<id>[123])"`.
The second element was the URL with which the pattern matching string The second element was the URL format string that the pattern should be
should be linkified with, so with the above pattern an example URL would linkified with. A URL format string for the above example would be
be `"https://realm.com/my_realm_filter/%(id)s"`. And the third element `"https://realm.com/my_realm_filter/%(id)s"`. And the third element
was the ID of the realm filter. was the ID of the realm filter.
example: example:
{ {
@ -10985,14 +10990,17 @@ paths:
Array of objects where each object describes a single Array of objects where each object describes a single
[linkifier](/help/add-a-custom-linkifier). [linkifier](/help/add-a-custom-linkifier).
**Changes**: As of Zulip 7.0 (feature level 176), clients will Clients will receive an empty array unless the event queue is
receive an empty array unless the event queue is registered with the registered with the client capability `{"linkifier_url_template": true}`.
client capability `{"linkifier_url_template": true}`. This is because
the change to specify linkifiers with a URL template instead of a
URL format string is not backwards-compatible.
See [`client_capabilities`](/api/register-queue#parameter-client_capabilities) See [`client_capabilities`](/api/register-queue#parameter-client_capabilities)
parameter for how this can be specified. parameter for how this can be specified.
**Changes**: Before Zulip 7.0 (feature level 176), the
`linkifier_url_template` client capability was not required. The
requirement was added because linkifiers were updated to contain
a URL template instead of a URL format string, which was a not
backwards-compatible change.
New in Zulip 4.0 (feature level 54). Clients can access this data for New in Zulip 4.0 (feature level 54). Clients can access this data for
servers on earlier feature levels via the legacy `realm_filters` property. servers on earlier feature levels via the legacy `realm_filters` property.
items: items:
@ -11034,10 +11042,10 @@ paths:
**Changes**: Prior to Zulip 7.0 (feature level 176), this was **Changes**: Prior to Zulip 7.0 (feature level 176), this was
an array of tuples, where each tuple described a linkifier. The first an array of tuples, where each tuple described a linkifier. The first
element of the tuple was a string regex pattern which represented the element of the tuple was a string regex pattern which represented the
pattern that to be linkified on matching, for example `"#(?P<id>[123])"`. pattern to be linkified on matching, for example `"#(?P<id>[123])"`.
The second element was the URL with which the pattern matching string The second element was a URL format string that the pattern should be
should be linkified with, so with the above pattern an example URL would linkified with. A URL format string for the above example would be
be `"https://realm.com/my_realm_filter/%(id)s"`. And the third element `"https://realm.com/my_realm_filter/%(id)s"`. And the third element
was the ID of the realm filter. was the ID of the realm filter.
**Deprecated** in Zulip 4.0 (feature level 54), replaced by the **Deprecated** in Zulip 4.0 (feature level 54), replaced by the