paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-07 07:23:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

api docs: Create the NonExistingStreamError schema definition.

Browse Source
This commit is contained in:
Yago González
2018-06-21 02:25:29 +02:00
committed by Tim Abbott
parent 586e013069
commit f63b7ada60
1 changed files with 17 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
zerver/openapi/zulip.yaml
View File

@@ -273,20 +273,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
allOf: $ref: '#/components/schemas/NonExistingStreamError'
- $ref: '#/components/schemas/CodedError'
- properties:
stream:
type: string
description: The name of the stream that could not be
found.
- example:
{
"code": "STREAM_DOES_NOT_EXIST",
"msg": "Stream 'nonexistent_stream' does not exist",
"result": "error",
"stream": "nonexistent_stream"
}
'400_non_existing_user': '400_non_existing_user':
description: Bad request. description: Bad request.
content: content:
@@ -802,20 +789,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
allOf: $ref: '#/components/schemas/NonExistingStreamError'
- $ref: '#/components/schemas/CodedError'
- properties:
stream:
type: string
description: The name of the stream that could not be
found.
- example:
{
"code": "STREAM_DOES_NOT_EXIST",
"msg": "Stream 'nonexistent_stream' does not exist",
"result": "error",
"stream": "nonexistent_stream"
}
/register: /register:
post: post:
description: This powerful endpoint can be used to register a Zulip description: This powerful endpoint can be used to register a Zulip
@@ -1107,6 +1081,21 @@ components:
"queue_id": "1518820930:1", "queue_id": "1518820930:1",
"result": "error" "result": "error"
} }
NonExistingStreamError:
allOf:
- $ref: '#/components/schemas/CodedError'
- properties:
stream:
type: string
description: The name of the stream that could not be
found.
- example:
{
"code": "STREAM_DOES_NOT_EXIST",
"msg": "Stream 'nonexistent_stream' does not exist",
"result": "error",
"stream": "nonexistent_stream"
}
AddSubscriptionsResponse: AddSubscriptionsResponse:
allOf: allOf:
- $ref: '#/components/schemas/JsonSuccess' - $ref: '#/components/schemas/JsonSuccess'