mirror of
https://github.com/zulip/zulip.git
synced 2025-11-17 04:12:02 +00:00
linkifiers: Rename articles to current feature name.
These were previously called "linkification filters", but we now want to consistently refer to them as "linkifiers" in the UI and API docs.
This commit is contained in:
@@ -1,6 +1,8 @@
|
|||||||
# Create organization filters
|
# Create linkifiers
|
||||||
|
|
||||||
Establish patterns in the messages that should be automatically linkified.
|
Configure [linkifiers](/help/add-a-custom-linkification-filter),
|
||||||
|
regular expression patterns that are automatically linkified when they
|
||||||
|
appear in messages and topics.
|
||||||
|
|
||||||
`POST {{ api_url }}/v1/realm/filters`
|
`POST {{ api_url }}/v1/realm/filters`
|
||||||
|
|
||||||
@@ -1,6 +1,9 @@
|
|||||||
# List organization filters
|
# List linkifiers
|
||||||
|
|
||||||
Fetch all the filters set up for the user's organization.
|
List all of an organization's configured
|
||||||
|
[linkifiers](/help/add-a-custom-linkification-filter), regular
|
||||||
|
expression patterns that are automatically linkified when they appear
|
||||||
|
in messages and topics.
|
||||||
|
|
||||||
`GET {{ api_url }}/v1/realm/filters`
|
`GET {{ api_url }}/v1/realm/filters`
|
||||||
|
|
||||||
@@ -40,11 +43,11 @@ curl {{ api_url }}/v1/realm/filters \
|
|||||||
|
|
||||||
#### Return values
|
#### Return values
|
||||||
|
|
||||||
* `filters`: An array of sub-arrays, each representing one of the filters set
|
* `filters`: An array of tuples, each representing one of the
|
||||||
up in the organization. Each of these tuples contain the pattern, the
|
linkifiers set up in the organization. Each of these tuples contain the
|
||||||
formatted URL and the filter's ID, in that order. See [Create organization
|
pattern, the formatted URL and the filter's ID, in that order. See
|
||||||
filters](/api/create-org-filters#create-organization-filters) for details on
|
the [Create linkifiers](/api/add-linkifiers) article for details on what
|
||||||
what does each field mean.
|
each field means.
|
||||||
|
|
||||||
#### Example response
|
#### Example response
|
||||||
|
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
# Remove organization filters
|
# Remove linkifiers
|
||||||
|
|
||||||
Remove an organization filter.
|
Remove [linkifiers](/help/add-a-custom-linkification-filter), regular
|
||||||
|
expression patterns that are automatically linkified when they appear
|
||||||
|
in messages and topics.
|
||||||
|
|
||||||
`DELETE {{ api_url }}/v1/realm/filters/<filter_id>`
|
`DELETE {{ api_url }}/v1/realm/filters/<filter_id>`
|
||||||
|
|
||||||
@@ -32,9 +32,9 @@
|
|||||||
#### Server & organizations
|
#### Server & organizations
|
||||||
|
|
||||||
* [Get server settings](/api/server-settings)
|
* [Get server settings](/api/server-settings)
|
||||||
* [List organization filters](/api/list-org-filters)
|
* [List linkifiers](/api/list-linkifiers)
|
||||||
* [Create organization filters](/api/create-org-filters)
|
* [Create organization filters](/api/add-linkifiers)
|
||||||
* [Remove organization filters](/api/remove-org-filters)
|
* [Remove organization filters](/api/remove-linkifiers)
|
||||||
* [Get all custom emoji](/api/get-org-emoji)
|
* [Get all custom emoji](/api/get-org-emoji)
|
||||||
|
|
||||||
#### Real-time events
|
#### Real-time events
|
||||||
|
|||||||
@@ -1278,13 +1278,11 @@ paths:
|
|||||||
anyOf:
|
anyOf:
|
||||||
- string
|
- string
|
||||||
- integer
|
- integer
|
||||||
description: An array of sub-arrays, each representing
|
description: An array of tuples, each representing one of the
|
||||||
one of the filters set up in the organization. Each of
|
linkifiers set up in the organization. Each of these tuples contain the
|
||||||
these tuples contain the pattern, the formatted URL and
|
pattern, the formatted URL and the filter's ID, in that order. See
|
||||||
the filter's ID, in that order.
|
the [Create linkifiers](/api/add-linkifiers) article for details on what
|
||||||
See [Create organization
|
each field means.
|
||||||
filters](/api/create-org-filters#create-organization-filters)
|
|
||||||
for details on what does each field mean.
|
|
||||||
- example:
|
- example:
|
||||||
{
|
{
|
||||||
"msg": "",
|
"msg": "",
|
||||||
|
|||||||
Reference in New Issue
Block a user