CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-07-09 21:21:47 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

openapi: Improve stream description details.

Browse Source
This commit is contained in:
Tim Abbott 2022-01-21 14:10:48 -08:00
parent 61e87b0ac8
commit afd8d5ef0c
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
zerver/openapi/zulip.yaml
View File

@ -6634,10 +6634,13 @@ paths:
properties:
name:
type: string
description: The name of a stream.
description: |
The name of the stream.
description:
type: string
description: A short description of the stream.
description: |
The [description](/help/change-the-stream-description)
to use for a new stream being created, in text/markdown format.
required:
- name
example:
@ -14140,13 +14143,15 @@ components:
description:
type: string
description: |
The short description of a stream in text/markdown format,
The [description](/help/change-the-stream-description) of the stream in text/markdown format,
intended to be used to prepopulate UI for editing a stream's
description.
See also `rendered_description`.
rendered_description:
type: string
description: |
A short description of a stream rendered as HTML, intended to
The [description](/help/change-the-stream-description) of the stream rendered as HTML, intended to
be used when displaying the stream description in a UI.
One should use the standard Zulip rendered_markdown CSS when
@ -14154,6 +14159,8 @@ components:
work correctly. And any client-side security logic for
user-generated message content should be applied when displaying
this HTML as though it were the body of a Zulip message.
See also `description`.
date_created:
type: integer
description: |