Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api-changelog: Add entry for feature level 193 updates. 

Adds an entry to the API changelog for feature level 193. The
changes documented here are from commit 3802503a8a.
This commit is contained in:
Lauryn Menard 2023-07-20 17:01:39 +02:00 committed by Tim Abbott
parent 8743602648
commit 072a62d5b5
2 changed files with 57 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api_docs/changelog.md
View File

@ -20,6 +20,16 @@ format used by the Zulip server that they are interacting with.
## Changes in Zulip 8.0 ## Changes in Zulip 8.0
**Feature level 193**
* [`POST /messages/{message_id}/reactions`](/api/add-reaction),
[`DELETE /messages/{message_id}/reactions`](/api/remove-reaction):
Endpoints return specific error responses if an emoji reaction
already exists when adding a reaction (`"code": "REACTION_ALREADY_EXISTS"`)
or if an emoji reaction does not exist when deleting a reaction
(`"code": "REACTION_DOES_NOT_EXIST"`). Previously, these errors
returned the `"BAD_REQUEST"` code.
**Feature level 192** **Feature level 192**
* [`GET /events`](/api/get-events): Stream creation events are now * [`GET /events`](/api/get-events): Stream creation events are now

67
zerver/openapi/zulip.yaml
View File

@ -6680,17 +6680,30 @@ paths:
content: content:
application/json: application/json:
schema: schema:
allOf: oneOf:
- $ref: "#/components/schemas/CodedError" - allOf:
- example: - $ref: "#/components/schemas/CodedError"
{ - example:
"result": "error", {
"msg": "Invalid emoji code", "result": "error",
"code": "BAD_REQUEST", "msg": "Invalid emoji code",
} "code": "BAD_REQUEST",
description: | }
An example JSON error response for when the emoji code is invalid: description: |
An example JSON error response for when the emoji code is invalid:
- allOf:
- $ref: "#/components/schemas/CodedError"
- example:
{
"result": "error",
"msg": "Reaction already exists.",
"code": "REACTION_ALREADY_EXISTS",
}
description: |
An example JSON error response for when the reaction already exists.
**Changes**: New in Zulip 8.0 (feature level 193). Previously, this
error returned the `"BAD_REQUEST"` code.
delete: delete:
operationId: remove-reaction operationId: remove-reaction
summary: Remove an emoji reaction summary: Remove an emoji reaction
@ -6729,16 +6742,30 @@ paths:
content: content:
application/json: application/json:
schema: schema:
allOf: oneOf:
- $ref: "#/components/schemas/CodedError" - allOf:
- example: - $ref: "#/components/schemas/CodedError"
{ - example:
"result": "error", {
"msg": "Invalid message(s)", "result": "error",
"code": "BAD_REQUEST", "msg": "Invalid emoji code",
} "code": "BAD_REQUEST",
description: | }
An example JSON error response for when the emoji code is invalid: description: |
An example JSON error response for when the emoji code is invalid:
- allOf:
- $ref: "#/components/schemas/CodedError"
- example:
{
"result": "error",
"msg": "Reaction doesn't exist.",
"code": "REACTION_DOES_NOT_EXIST",
}
description: |
An example JSON error response for when the reaction does not exist.
**Changes**: New in Zulip 8.0 (feature level 193). Previously, this
error returned the `"BAD_REQUEST"` code.
/messages/{message_id}/read_receipts: /messages/{message_id}/read_receipts:
get: get: