mirror of https://github.com/zulip/zulip.git
openapi: Fix inconsistencies in OpenAPI error documentation.
Fixes a few small inconsistences / mistakes in the OpenAPI documentation related to error documentation. Does not change the rendered API documentation, which is likely why these were not noticed sooner.
This commit is contained in:
parent
496273ddbc
commit
0acf955265
|
@ -6822,7 +6822,7 @@ paths:
|
|||
- $ref: "#/components/schemas/SuccessDescription"
|
||||
- example: {"msg": "", "result": "success"}
|
||||
"400":
|
||||
description: Success.
|
||||
description: Bad request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
@ -8770,7 +8770,7 @@ paths:
|
|||
- $ref: "#/components/schemas/SuccessDescription"
|
||||
- example: {"msg": "", "result": "success"}
|
||||
"400":
|
||||
description: Bad request
|
||||
description: Bad request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
@ -13595,7 +13595,7 @@ paths:
|
|||
- $ref: "#/components/schemas/JsonSuccess"
|
||||
- $ref: "#/components/schemas/SuccessDescription"
|
||||
"400":
|
||||
description: Error.
|
||||
description: Bad request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
|
@ -15995,15 +15995,11 @@ components:
|
|||
}
|
||||
InvalidMessageError:
|
||||
allOf:
|
||||
- $ref: "#/components/schemas/JsonSuccessBase"
|
||||
- $ref: "#/components/schemas/JsonErrorBase"
|
||||
- additionalProperties: false
|
||||
properties:
|
||||
result: {}
|
||||
msg: {}
|
||||
raw_content:
|
||||
type: string
|
||||
description: |
|
||||
The raw content of the message.
|
||||
example:
|
||||
{
|
||||
"msg": "Invalid message(s)",
|
||||
|
|
Loading…
Reference in New Issue