paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-21 15:09:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

api-docs: Update mute/unmute user error documentation for 'code' fields.

Browse Source
This commit is contained in:
Lauryn Menard
2023-09-01 17:30:57 +02:00
committed by Tim Abbott
parent c4d4dfda4d
commit 28a2893a41
1 changed files with 36 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
zerver/openapi/zulip.yaml
View File

@@ -9160,19 +9160,34 @@ paths:
schema:
oneOf:
- allOf:
- $ref: "#/components/schemas/JsonError"
- example: {"msg": "Cannot mute self", "result": "error"}
- $ref: "#/components/schemas/CodedError"
- example:
{
"code": "BAD_REQUEST",
"msg": "Cannot mute self",
"result": "error",
}
description: |
An example JSON response for when the user is yourself:
An example JSON response for when the user ID is the current
user's ID:
- allOf:
- $ref: "#/components/schemas/JsonError"
- example: {"msg": "No such user", "result": "error"}
- $ref: "#/components/schemas/CodedError"
- example:
{
"code": "BAD_REQUEST",
"msg": "No such user",
"result": "error",
}
description: |
An example JSON response for when the user is nonexistent or inaccessible:
- allOf:
- $ref: "#/components/schemas/JsonError"
- $ref: "#/components/schemas/CodedError"
- example:
{"msg": "User already muted", "result": "error"}
{
"code": "BAD_REQUEST",
"msg": "User already muted",
"result": "error",
}
description: |
An example JSON response for when the user is already muted:
delete:
@@ -9196,13 +9211,23 @@ paths:
schema:
oneOf:
- allOf:
- $ref: "#/components/schemas/JsonError"
- example: {"msg": "No such user", "result": "error"}
- $ref: "#/components/schemas/CodedError"
- example:
{
"code": "BAD_REQUEST",
"msg": "No such user",
"result": "error",
}
description: |
An example JSON response for when the user is nonexistent or inaccessible:
- allOf:
- $ref: "#/components/schemas/JsonError"
- example: {"msg": "User is not muted", "result": "error"}
- $ref: "#/components/schemas/CodedError"
- example:
{
"code": "BAD_REQUEST",
"msg": "User is not muted",
"result": "error",
}
description: |
An example JSON response for when the user is not previously muted: