mirror of https://github.com/zulip/zulip.git synced 2026-07-15 21:03:26 +08:00

Eeshan Garg cecea75457 api_docs: Detect missing arguments in curl examples.

This commit adds automated tests that make sure that every curl
example command in our API docs has the '-X (POST|GET)' argument.

Fixes: #11927

2019-05-28 16:53:48 -07:00

Delete a message

Permanently delete a message.

DELETE {{ api_url }}/v1/messages/<msg_id>

This API corresponds to the delete a message completely feature documented in the Zulip Help Center.

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/messages/{message_id}:delete|example(admin_config=True)}

{tab|curl}

curl -X DELETE {{ api_url }}/v1/messages/{message_id} \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \

{end_tabs}

{generate_api_arguments_table|zulip.yaml|/messages/{message_id}:delete}

A typical successful JSON response may look like:

{generate_code_example|/messages/{message_id}:delete|fixture(200)}

An example JSON response for when the specified message does not exist:

{generate_code_example|/messages/{message_id}:delete|fixture(400_invalid_message)}

An example JSON response for when the user making the query does not have permission to delete the message:

{generate_code_example|/messages/{message_id}:delete|fixture(400_not_admin)}