mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 22:43:42 +00:00
docs: Document /get_stream_id API endpoint.
This commit is contained in:
@@ -167,6 +167,41 @@ paths:
|
|||||||
enum:
|
enum:
|
||||||
- ''
|
- ''
|
||||||
|
|
||||||
|
/get_stream_id:
|
||||||
|
get:
|
||||||
|
description: Fetch a stream's ID from its name.
|
||||||
|
operationId: zerver.views.streams.json_get_stream_id
|
||||||
|
parameters:
|
||||||
|
- name: stream
|
||||||
|
in: query
|
||||||
|
description: The name of the stream whose ID to fetch.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
security:
|
||||||
|
- basicAuth: []
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Success.
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/definitions/JsonSuccess'
|
||||||
|
- properties:
|
||||||
|
stream_id:
|
||||||
|
type: integer
|
||||||
|
example: 42
|
||||||
|
msg:
|
||||||
|
enum:
|
||||||
|
- ''
|
||||||
|
'400':
|
||||||
|
description: Bad request.
|
||||||
|
schema:
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/definitions/JsonError'
|
||||||
|
- properties:
|
||||||
|
msg:
|
||||||
|
enum:
|
||||||
|
- Invalid stream name '<stream>'
|
||||||
|
|
||||||
/messages:
|
/messages:
|
||||||
get:
|
get:
|
||||||
description: |
|
description: |
|
||||||
@@ -238,7 +273,7 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/MessageResponse'
|
$ref: '#/definitions/MessageResponse'
|
||||||
|
|
||||||
/messages/{message_id}/:
|
/messages/{message_id}:
|
||||||
get:
|
get:
|
||||||
description: Retrieve the content of a message.
|
description: Retrieve the content of a message.
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
Reference in New Issue
Block a user