zulip/templates/zerver/api/remove-playground.md
Sumanth V Rao d2e5b62dce realm/playground: Add API endpoint for deleting a playground entry.
Similar to the previous commit, we have added a `do_*` function
which does the deletion from the DB. The next commit handles sending
the events when both adding and deleting a playground entry.

Added the openAPI format data to zulip.yaml for DELETE
/realm/playgrounds/{playground_id}. Also added python and curl
examples to remove-playground.md.

Tests added.
2021-04-07 08:20:53 +05:30

594 B

Remove a playground

{generate_api_description(/realm/playgrounds/{playground_id}:delete)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/realm/playgrounds/{playground_id}:delete|example}

{tab|curl}

{generate_code_example(curl)|/realm/playgrounds/{playground_id}:delete|example}

{end_tabs}

Parameters

{generate_api_arguments_table|zulip.yaml|/realm/playgrounds/{playground_id}:delete}

Response

Example response

A typical successful JSON response may look like:

{generate_code_example|/realm/playgrounds/{playground_id}:delete|fixture(200)}