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

40 lines
788 B
Markdown
Raw Normal View History

api docs: Improve headings and organization for endpoints. Mostly, this is a change in ordering to make more sense, but we also fix several names that were clearly confusing. We restore the convention that each endpoint has the same title at the top of the page as what we have in the sidebar menu, which appears to have been violated in many recent updates to API documentation.
2020-06-19 07:30:42 +02:00
# Delete an event queue
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01: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(/events:delete)}
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
## Usage examples
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{start_tabs}
{tab|python}
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
api docs: Migrate DELETE /events to OpenAPI.
2018-06-21 01:28:33 +02:00
{generate_code_example(python)|/events:delete|example}
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|js}
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
api/delete-queue: Add JavaScript example.
2018-01-14 00:00:08 +01:00
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
js_examples: Migrate and test delete_queue example.
2020-06-21 20:51:21 +02:00
{generate_code_example(javascript)|/events:delete|example}
api/delete-queue: Add JavaScript example.
2018-01-14 00:00:08 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{tab|curl}
docs: Make delete-queue use curl example system.
2019-10-14 12:45:34 +02:00
{generate_code_example(curl)|/events:delete|example}
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
api docs: Use Markdown extension for tabbed sections.
2018-09-17 16:27:32 +02:00
{end_tabs}
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01: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: Move code examples farther up.
2018-01-20 22:03:05 +01:00
api docs: Migrate DELETE /events to OpenAPI.
2018-06-21 01:28:33 +02:00
{generate_api_arguments_table|zulip.yaml|/events:delete}
api docs: Move code examples farther up.
2018-01-20 22:03:05 +01:00
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
## Response
#### Example response
A typical successful JSON response may look like:
api docs: Migrate DELETE /events to OpenAPI.
2018-06-21 01:28:33 +02:00
{generate_code_example|/events:delete|fixture(200)}
api docs: Document the DELETE /api/v1/events endpoint. Note that there is no JavaScript equivalent for requesting this endpoint in zulip-js yet.
2018-01-04 21:35:32 +01:00
A typical JSON response for when the `queue_id` is non-existent or the
associated queue has already been deleted:
api docs: Migrate DELETE /events to OpenAPI.
2018-06-21 01:28:33 +02:00
{generate_code_example|/events:delete|fixture(400)}