mirror of https://github.com/zulip/zulip.git
31daef7f79
In feature levels 153 and 154, a new value of "partially_completed" for `result` in a success (HTTP status code 200) was added for two endpoints that process messages in batches: /api/delete-topic and /api/mark-all-as-read. Prior to these changes, `result` was either "success" or "error" for all responses, which was a useful API invariant to have for clients. So, here we remove "partially_completed" as a potential value for "result" in a response. And instead, for the two endpoints noted above, we return a boolean field "complete" to indicate if the response successfully deleted/marked as read all the targeted messages (complete: true) or if only some of the targeted messages were processed (complete: false). The "code" field for an error string that was also returned as part of a partially completed response is removed in these changes as well. The web app does not currently use the /api/mark-all-as-read endpoint, but it does use the /api/delete-topic endpoint, so these changes update that to check the `complete` boolean instead of the string value for `result`. |
||
|---|---|---|
| .. | ||
| include | ||
| api-doc-template.md | ||
| api-keys.md | ||
| changelog.md | ||
| client-libraries.md | ||
| configuring-python-bindings.md | ||
| construct-narrow.md | ||
| create-scheduled-message.md | ||
| create-stream.md | ||
| deploying-bots.md | ||
| http-headers.md | ||
| incoming-webhooks-overview.md | ||
| incoming-webhooks-walkthrough.md | ||
| index.md | ||
| installation-instructions.md | ||
| integrations-overview.md | ||
| missing.md | ||
| non-webhook-integrations.md | ||
| outgoing-webhooks.md | ||
| real-time-events.md | ||
| rest-error-handling.md | ||
| rest.md | ||
| roles-and-permissions.md | ||
| running-bots.md | ||
| send-message.md | ||
| sidebar_index.md | ||
| writing-bots.md | ||