From d13bd6e8d3963a74d5845b3084ef376f9e5150eb Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 16 Oct 2018 12:01:17 -0700 Subject: [PATCH] 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. --- ...{create-org-filters.md => add-linkifiers.md} | 6 ++++-- .../{list-org-filters.md => list-linkifiers.md} | 17 ++++++++++------- ...move-org-filters.md => remove-linkifiers.md} | 6 ++++-- templates/zerver/help/include/rest-endpoints.md | 6 +++--- zerver/openapi/zulip.yaml | 12 +++++------- 5 files changed, 26 insertions(+), 21 deletions(-) rename templates/zerver/api/{create-org-filters.md => add-linkifiers.md} (78%) rename templates/zerver/api/{list-org-filters.md => list-linkifiers.md} (58%) rename templates/zerver/api/{remove-org-filters.md => remove-linkifiers.md} (80%) diff --git a/templates/zerver/api/create-org-filters.md b/templates/zerver/api/add-linkifiers.md similarity index 78% rename from templates/zerver/api/create-org-filters.md rename to templates/zerver/api/add-linkifiers.md index bff7b11605..85d0d3fc30 100644 --- a/templates/zerver/api/create-org-filters.md +++ b/templates/zerver/api/add-linkifiers.md @@ -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` diff --git a/templates/zerver/api/list-org-filters.md b/templates/zerver/api/list-linkifiers.md similarity index 58% rename from templates/zerver/api/list-org-filters.md rename to templates/zerver/api/list-linkifiers.md index 8108a33d86..24c4a65012 100644 --- a/templates/zerver/api/list-org-filters.md +++ b/templates/zerver/api/list-linkifiers.md @@ -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 diff --git a/templates/zerver/api/remove-org-filters.md b/templates/zerver/api/remove-linkifiers.md similarity index 80% rename from templates/zerver/api/remove-org-filters.md rename to templates/zerver/api/remove-linkifiers.md index 6f7e2e267f..4a86c82b28 100644 --- a/templates/zerver/api/remove-org-filters.md +++ b/templates/zerver/api/remove-linkifiers.md @@ -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/` diff --git a/templates/zerver/help/include/rest-endpoints.md b/templates/zerver/help/include/rest-endpoints.md index f0750beeb1..5bb32f0af0 100644 --- a/templates/zerver/help/include/rest-endpoints.md +++ b/templates/zerver/help/include/rest-endpoints.md @@ -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 diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index a70bda6ad1..fcdccd514d 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -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": "",