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

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:
Lauryn Menard 2022-05-07 00:07:08 +02:00 committed by GitHub
parent 496273ddbc
commit 0acf955265
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
zerver/openapi/zulip.yaml
View File

@ -6822,7 +6822,7 @@ paths:
- $ref: "#/components/schemas/SuccessDescription" - $ref: "#/components/schemas/SuccessDescription"
- example: {"msg": "", "result": "success"} - example: {"msg": "", "result": "success"}
"400": "400":
description: Success. description: Bad request.
content: content:
application/json: application/json:
schema: schema:
@ -8770,7 +8770,7 @@ paths:
- $ref: "#/components/schemas/SuccessDescription" - $ref: "#/components/schemas/SuccessDescription"
- example: {"msg": "", "result": "success"} - example: {"msg": "", "result": "success"}
"400": "400":
description: Bad request description: Bad request.
content: content:
application/json: application/json:
schema: schema:
@ -13595,7 +13595,7 @@ paths:
- $ref: "#/components/schemas/JsonSuccess" - $ref: "#/components/schemas/JsonSuccess"
- $ref: "#/components/schemas/SuccessDescription" - $ref: "#/components/schemas/SuccessDescription"
"400": "400":
description: Error. description: Bad request.
content: content:
application/json: application/json:
schema: schema:
@ -15995,15 +15995,11 @@ components:
} }
InvalidMessageError: InvalidMessageError:
allOf: allOf:
- $ref: "#/components/schemas/JsonSuccessBase" - $ref: "#/components/schemas/JsonErrorBase"
- additionalProperties: false - additionalProperties: false
properties: properties:
result: {} result: {}
msg: {} msg: {}
raw_content:
type: string
description: |
The raw content of the message.
example: example:
{ {
"msg": "Invalid message(s)", "msg": "Invalid message(s)",