zulip/templates/zerver/api/update-linkifier.md
akshatdalton 6509c4f8f4 linkifiers: Add an API to support the editing of linkifier.
This commit adds an API to `zproject/urls.py` to edit/update
the realm linkifier. Its helper function to update the
database is added in `zerver/lib/actions.py`.

`zulip.yaml` is documented accordingly as well, clearly
stating that this API updates one linkifier at a time.

The tests are added for the API and helper function which
updates the realm linkifier.

Fixes #10830.
2021-04-19 18:01:45 -07:00

33 lines
644 B
Markdown

# Update a linkifier
{generate_api_description(/realm/filters/{filter_id}:patch)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/realm/filters/{filter_id}:patch|example}
{tab|curl}
{generate_code_example(curl)|/realm/filters/{filter_id}:patch|example}
{end_tabs}
## Parameters
{generate_api_arguments_table|zulip.yaml|/realm/filters/{filter_id}:patch}
## Response
#### Return values
{generate_return_values_table|zulip.yaml|/realm/filters/{filter_id}:patch}
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/realm/filters/{filter_id}:patch|fixture(200)}