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

openapi: Move stray custom emoji description into OpenAPI.

Browse Source
This commit is contained in:
Suyash Vardhan Mathur
2021-06-22 00:37:47 +05:30
committed by Tim Abbott
parent 3f104c378b
commit 3129895818
2 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
templates/zerver/api/upload-custom-emoji.md
View File

@@ -21,29 +21,14 @@
## Parameters
As described above, the image file to upload must be provided in the
request's body.
{generate_api_arguments_table|zulip.yaml|/realm/emoji/{emoji_name}:post}
## Emoji name
The emoji name can only contain letters, numbers, dashes, and spaces.
Upper and lower case letters are treated the same, and underscores (_)
are treated the same as spaces (consistent with how the Zulip UI
handles emoji).
## Maximum file size
The maximum file size for uploads can be configured by the
administrator of the Zulip server by setting `MAX_EMOJI_FILE_SIZE_MIB`
in the [server's settings][1]. `MAX_EMOJI_FILE_SIZE_MIB` defaults
to 5MB.
[1]: https://zulip.readthedocs.io/en/latest/subsystems/settings.html#server-settings
{generate_parameter_description(/realm/emoji/{emoji_name}:post)}
## Response
{generate_response_description(/realm/emoji/{emoji_name}:post)}
## Response
#### Example response
{generate_code_example|/realm/emoji/{emoji_name}:post|fixture(200)}

17
zerver/openapi/zulip.yaml
View File

@@ -6565,14 +6565,31 @@ paths:
[organization's configuration](https://zulip.com/help/only-allow-admins-to-add-emoji).
`POST {{ api_url }}/v1/realm/emoji/{emoji_name}`
x-parameter-description: |
As described above, the image file to upload must be provided in the
request's body.
## Maximum file size
The maximum file size for uploads can be configured by the
administrator of the Zulip server by setting `MAX_EMOJI_FILE_SIZE_MIB`
in the [server's settings][1]. `MAX_EMOJI_FILE_SIZE_MIB` defaults
to 5MB.
[1]: https://zulip.readthedocs.io/en/latest/subsystems/settings.html#server-settings
parameters:
- name: emoji_name
required: true
in: path
description: |
The name that should be associated with the uploaded emoji image/gif.
The emoji name can only contain letters, numbers, dashes, and spaces.
Upper and lower case letters are treated the same, and underscores (_)
are treated the same as spaces (consistent with how the Zulip UI
handles emoji).
schema:
type: string
example: smile
requestBody:
content:
multipart/form-data: