mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 14:03:30 +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`
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -40,11 +43,11 @@ curl {{ api_url }}/v1/realm/filters \
|
||||
|
||||
#### Return values
|
||||
|
||||
* `filters`: An array of sub-arrays, each representing one of the filters set
|
||||
up in the organization. Each of these tuples contain the pattern, the
|
||||
formatted URL and the filter's ID, in that order. See [Create organization
|
||||
filters](/api/create-org-filters#create-organization-filters) for details on
|
||||
what does each field mean.
|
||||
* `filters`: An array of tuples, each representing one of the
|
||||
linkifiers set up in the organization. Each of these tuples contain the
|
||||
pattern, the formatted URL and the filter's ID, in that order. See
|
||||
the [Create linkifiers](/api/add-linkifiers) article for details on what
|
||||
each field means.
|
||||
|
||||
#### 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>`
|
||||
|
||||
@@ -32,9 +32,9 @@
|
||||
#### Server & organizations
|
||||
|
||||
* [Get server settings](/api/server-settings)
|
||||
* [List organization filters](/api/list-org-filters)
|
||||
* [Create organization filters](/api/create-org-filters)
|
||||
* [Remove organization filters](/api/remove-org-filters)
|
||||
* [List linkifiers](/api/list-linkifiers)
|
||||
* [Create organization filters](/api/add-linkifiers)
|
||||
* [Remove organization filters](/api/remove-linkifiers)
|
||||
* [Get all custom emoji](/api/get-org-emoji)
|
||||
|
||||
#### Real-time events
|
||||
|
||||
@@ -1278,13 +1278,11 @@ paths:
|
||||
anyOf:
|
||||
- string
|
||||
- integer
|
||||
description: An array of sub-arrays, each representing
|
||||
one of the filters set up in the organization. Each of
|
||||
these tuples contain the pattern, the formatted URL and
|
||||
the filter's ID, in that order.
|
||||
See [Create organization
|
||||
filters](/api/create-org-filters#create-organization-filters)
|
||||
for details on what does each field mean.
|
||||
description: An array of tuples, each representing one of the
|
||||
linkifiers set up in the organization. Each of these tuples contain the
|
||||
pattern, the formatted URL and the filter's ID, in that order. See
|
||||
the [Create linkifiers](/api/add-linkifiers) article for details on what
|
||||
each field means.
|
||||
- example:
|
||||
{
|
||||
"msg": "",
|
||||
|
||||
Reference in New Issue
Block a user