Close a worktree's README

DELETE https://runix.chat/api/v1/armada/workspaces/{workspace_uuid}/readme

The client no longer has the README open: its user stops getting readme events for it, unless another of their clients has it open. The awareness update it sends, which removes its cursor, goes to the other viewers.

Changes: New in Zulip 13.0 (feature level ZF-8c5c9c).

Usage examples

curl -sSX DELETE https://runix.chat/api/v1/armada/workspaces/8e6d3b9e-4c36-4f2a-9a55-3f4b0c6f1d2e/readme \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode client=2747362911 \
    --data-urlencode awareness=AQHu9N7EAgIEbnVsbA==

Parameters

Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}