Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/api/remove-linkifiers.md

29 lines
551 B
Markdown
Raw Normal View History

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.
2018-10-16 21:01:17 +02:00
# Remove linkifiers
api docs: Document DELETE /realm/filters/<filter_id>.
2018-08-14 03:20:39 +02:00
openapi: Use description markdown for rendering endpoint descriptions. Firstly, change endpoint descriptions in zulip.yaml so that they match their counterpart in the api docs. Then edit the api docs so that they use api description markdown extension for displaying endpoint description.
2020-04-28 20:00:46 +02:00
{generate_api_description(/realm/filters/{filter_id}:delete)}
api docs: Document DELETE /realm/filters/<filter_id>.
2018-08-14 03:20:39 +02:00
## Usage examples
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{start_tabs}
{tab|python}
api docs: Document DELETE /realm/filters/<filter_id>.
2018-08-14 03:20:39 +02:00
openapi: Standardize URL format to use {var_name} syntax. The previous code for the validator test was fairly messy due to checking for both formats of the openapi url, one with <variable_name> and the other with {variable_name}. To eliminate this, we have standardized the format and restricted it to {variable_name} as per the official format at: https://swagger.io/docs/specification/describing-parameters.
2019-07-11 12:45:26 +02:00
{generate_code_example(python)|/realm/filters/{filter_id}:delete|example}
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{tab|curl}
api docs: Document DELETE /realm/filters/<filter_id>.
2018-08-14 03:20:39 +02:00
docs: Make remove-linkifiers use curl example system.
2019-10-14 11:45:00 +02:00
{generate_code_example(curl)|/realm/filters/{filter_id}:delete|example}
api docs: Document DELETE /realm/filters/<filter_id>.
2018-08-14 03:20:39 +02:00
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{end_tabs}
api docs: Document DELETE /realm/filters/<filter_id>.
2018-08-14 03:20:39 +02:00
## Arguments
openapi: Standardize URL format to use {var_name} syntax. The previous code for the validator test was fairly messy due to checking for both formats of the openapi url, one with <variable_name> and the other with {variable_name}. To eliminate this, we have standardized the format and restricted it to {variable_name} as per the official format at: https://swagger.io/docs/specification/describing-parameters.
2019-07-11 12:45:26 +02:00
{generate_api_arguments_table|zulip.yaml|/realm/filters/{filter_id}:delete}
api docs: Document DELETE /realm/filters/<filter_id>.
2018-08-14 03:20:39 +02:00
## Response
#### Example response
A typical successful JSON response may look like:
openapi: Standardize URL format to use {var_name} syntax. The previous code for the validator test was fairly messy due to checking for both formats of the openapi url, one with <variable_name> and the other with {variable_name}. To eliminate this, we have standardized the format and restricted it to {variable_name} as per the official format at: https://swagger.io/docs/specification/describing-parameters.
2019-07-11 12:45:26 +02:00
{generate_code_example|/realm/filters/{filter_id}:delete|fixture(200)}