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

33 lines
657 B
Markdown
Raw Normal View History

apidocs: Replace hardcoded titles with generated ones. This commit replaces the hardcoded titles of /api pages with the auto-generated ones from the openapi data using the markdown processor.
2021-05-22 13:21:18 +02:00
{generate_api_title(/realm/linkifiers:get)}
api docs: Document GET /realm/filters.
2018-08-14 03:10:37 +02:00
linkifiers: Update API to send data using dictionaries. * This introduces a new event type `realm_linkifiers` and a new key for the initial data fetch of the same name. Newer clients will be expected to use these. * Backwards compatibility is ensured by changing neither the current event nor the /register key. The data which these hold is the same as before, but internally, it is generated by processing the `realm_linkifiers` data. We send both the old and the new event types to clients whenever the linkifiers are changed. Older clients will simply ignore the new event type, and vice versa. * The `realm/filters:GET` endpoint (which returns tuples) is currently used by none of the official Zulip clients. This commit replaces it with `realm/linkifiers:GET` which returns data in the new dictionary format. TODO: Update the `get_realm_filters` method in the API bindings, to hit this new URL instead of the old one. * This also updates the webapp frontend to use the newer events and keys.
2021-03-30 12:51:54 +02:00
{generate_api_description(/realm/linkifiers:get)}
api docs: Document GET /realm/filters.
2018-08-14 03:10:37 +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 GET /realm/filters.
2018-08-14 03:10:37 +02:00
linkifiers: Update API to send data using dictionaries. * This introduces a new event type `realm_linkifiers` and a new key for the initial data fetch of the same name. Newer clients will be expected to use these. * Backwards compatibility is ensured by changing neither the current event nor the /register key. The data which these hold is the same as before, but internally, it is generated by processing the `realm_linkifiers` data. We send both the old and the new event types to clients whenever the linkifiers are changed. Older clients will simply ignore the new event type, and vice versa. * The `realm/filters:GET` endpoint (which returns tuples) is currently used by none of the official Zulip clients. This commit replaces it with `realm/linkifiers:GET` which returns data in the new dictionary format. TODO: Update the `get_realm_filters` method in the API bindings, to hit this new URL instead of the old one. * This also updates the webapp frontend to use the newer events and keys.
2021-03-30 12:51:54 +02:00
{generate_code_example(python)|/realm/linkifiers:get|example}
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
apidocs: Automatically add javascript example tabs. The javascript tab in .md templates can be generated along with the line that adds js example. Further, as a part of the effort of moving towards a single template, the markdown extension for javascrit examples is modified to return empty string if javascript example doesn't exist for that endpoint. This would make it possible to cover more endpoints with a single template. The js example tabs are now automatically generated during generation of javascript code, and so need to be removed. Also, the markdown function to render js examples can be added in all templates, since it is parses and returns an empty string if the examples don't exist, and allows us to move towards a common template. The pages have been verified to be correct by using diff between old and new pages' raw HTML.
2021-06-02 18:36:25 +02:00
{generate_code_example(javascript)|/realm/linkifiers:get|example}
api_docs: Use tabbed_sections extension in new API docs.
2018-10-18 00:14:30 +02:00
{tab|curl}
api docs: Document GET /realm/filters.
2018-08-14 03:10:37 +02:00
linkifiers: Update API to send data using dictionaries. * This introduces a new event type `realm_linkifiers` and a new key for the initial data fetch of the same name. Newer clients will be expected to use these. * Backwards compatibility is ensured by changing neither the current event nor the /register key. The data which these hold is the same as before, but internally, it is generated by processing the `realm_linkifiers` data. We send both the old and the new event types to clients whenever the linkifiers are changed. Older clients will simply ignore the new event type, and vice versa. * The `realm/filters:GET` endpoint (which returns tuples) is currently used by none of the official Zulip clients. This commit replaces it with `realm/linkifiers:GET` which returns data in the new dictionary format. TODO: Update the `get_realm_filters` method in the API bindings, to hit this new URL instead of the old one. * This also updates the webapp frontend to use the newer events and keys.
2021-03-30 12:51:54 +02:00
{generate_code_example(curl)|/realm/linkifiers:get|example}
api docs: Document GET /realm/filters.
2018-08-14 03:10:37 +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 GET /realm/filters.
2018-08-14 03:10:37 +02:00
openapi_docs: Replace `argument` with `parameter`. The term `parameter` is a better word than `argument` for data passed to an API endpoint; this is why OpenAPI uses in their terminology. Replace `argument` with `parameter` in the API docs to improve their readability. Fixes #15435.
2020-06-18 15:35:25 +02:00
## Parameters
api docs: Document GET /realm/filters.
2018-08-14 03:10:37 +02:00
linkifiers: Update API to send data using dictionaries. * This introduces a new event type `realm_linkifiers` and a new key for the initial data fetch of the same name. Newer clients will be expected to use these. * Backwards compatibility is ensured by changing neither the current event nor the /register key. The data which these hold is the same as before, but internally, it is generated by processing the `realm_linkifiers` data. We send both the old and the new event types to clients whenever the linkifiers are changed. Older clients will simply ignore the new event type, and vice versa. * The `realm/filters:GET` endpoint (which returns tuples) is currently used by none of the official Zulip clients. This commit replaces it with `realm/linkifiers:GET` which returns data in the new dictionary format. TODO: Update the `get_realm_filters` method in the API bindings, to hit this new URL instead of the old one. * This also updates the webapp frontend to use the newer events and keys.
2021-03-30 12:51:54 +02:00
{generate_api_arguments_table|zulip.yaml|/realm/linkifiers:get}
api docs: Document GET /realm/filters.
2018-08-14 03:10:37 +02:00
## Response
linkifiers: Update API to send data using dictionaries. * This introduces a new event type `realm_linkifiers` and a new key for the initial data fetch of the same name. Newer clients will be expected to use these. * Backwards compatibility is ensured by changing neither the current event nor the /register key. The data which these hold is the same as before, but internally, it is generated by processing the `realm_linkifiers` data. We send both the old and the new event types to clients whenever the linkifiers are changed. Older clients will simply ignore the new event type, and vice versa. * The `realm/filters:GET` endpoint (which returns tuples) is currently used by none of the official Zulip clients. This commit replaces it with `realm/linkifiers:GET` which returns data in the new dictionary format. TODO: Update the `get_realm_filters` method in the API bindings, to hit this new URL instead of the old one. * This also updates the webapp frontend to use the newer events and keys.
2021-03-30 12:51:54 +02:00
{generate_return_values_table|zulip.yaml|/realm/linkifiers:get}
api docs: Document GET /realm/filters.
2018-08-14 03:10:37 +02:00
#### Example response
linkifiers: Update API to send data using dictionaries. * This introduces a new event type `realm_linkifiers` and a new key for the initial data fetch of the same name. Newer clients will be expected to use these. * Backwards compatibility is ensured by changing neither the current event nor the /register key. The data which these hold is the same as before, but internally, it is generated by processing the `realm_linkifiers` data. We send both the old and the new event types to clients whenever the linkifiers are changed. Older clients will simply ignore the new event type, and vice versa. * The `realm/filters:GET` endpoint (which returns tuples) is currently used by none of the official Zulip clients. This commit replaces it with `realm/linkifiers:GET` which returns data in the new dictionary format. TODO: Update the `get_realm_filters` method in the API bindings, to hit this new URL instead of the old one. * This also updates the webapp frontend to use the newer events and keys.
2021-03-30 12:51:54 +02:00
{generate_code_example|/realm/linkifiers:get|fixture(200)}
apidocs: Fix response in API templates. Now, the descriptions and all subschemas are directly returned just by `generate_code_example`, and so, these individual subschemas and descriptions can be removed from the templates. All API endpoints docs are exactly the same after the change, except few where missing 400 responses got added due to the modification
2021-06-07 22:53:29 +02:00
{generate_code_example|/realm/linkifiers:get|fixture(400)}