mirror of
https://github.com/zulip/zulip.git
synced 2026-06-21 21:32:29 +08:00
api_docs: Add "Topic" common component.
To facilitate re-use of the same parameters in other paths, this commit store the content of the parameter "topic" in components.
This commit is contained in:
parent
05b1ddeb84
commit
86eed5d9bb
@ -581,15 +581,7 @@ paths:
|
||||
type: string
|
||||
example: [9, 10]
|
||||
required: true
|
||||
- name: topic
|
||||
in: query
|
||||
description: |
|
||||
The topic of the message. Only required if `type` is `stream`, ignored
|
||||
otherwise. Maximum length of 60 characters.
|
||||
schema:
|
||||
type: string
|
||||
default:
|
||||
example: Castle
|
||||
- $ref: '#/components/parameters/Topic'
|
||||
- name: content
|
||||
in: query
|
||||
description: |
|
||||
@ -682,15 +674,7 @@ paths:
|
||||
type: integer
|
||||
example: 42
|
||||
required: true
|
||||
- name: topic
|
||||
in: query
|
||||
description: |
|
||||
The topic of the message. Only required for stream messages. Maximum
|
||||
length of 60 characters.
|
||||
schema:
|
||||
type: string
|
||||
default:
|
||||
example: Castle
|
||||
- $ref: '#/components/parameters/Topic'
|
||||
- name: propagate_mode
|
||||
in: query
|
||||
description: |
|
||||
@ -3734,3 +3718,13 @@ components:
|
||||
type: integer
|
||||
example: 42
|
||||
required: true
|
||||
Topic:
|
||||
name: topic
|
||||
in: query
|
||||
description: |
|
||||
The topic of the message. Only required for stream messages
|
||||
(`type="stream"`), ignored otherwise. Maximum length of 60
|
||||
characters.
|
||||
schema:
|
||||
type: string
|
||||
example: Castle
|
||||
|
||||
Loading…
Reference in New Issue
Block a user