From 3e6cce5ab5bc559aa9b2771d6194229b24cd4f06 Mon Sep 17 00:00:00 2001 From: Harrison Healey Date: Tue, 17 Oct 2023 15:09:26 -0400 Subject: [PATCH] Add documentation for get emojis by names API (#24983) --- api/v4/source/emoji.yaml | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/api/v4/source/emoji.yaml b/api/v4/source/emoji.yaml index d2a7439346..f2b5026016 100644 --- a/api/v4/source/emoji.yaml +++ b/api/v4/source/emoji.yaml @@ -306,3 +306,42 @@ $ref: "#/components/responses/Forbidden" "501": $ref: "#/components/responses/NotImplemented" + /api/v4/emoji/names: + post: + tags: + - emoji + summary: Get custom emojis by name + description: > + Get a list of custom emoji based on a provided list of emoji names. A maximum of + 200 results are returned. + + ##### Permissions + + Must be authenticated. + + __Minimum server version__: 9.2 + operationId: GetEmojisByNames + requestBody: + content: + application/json: + schema: + type: array + items: + type: string + description: List of emoji names + required: true + responses: + "200": + description: Emoji list retrieval successful + content: + application/json: + schema: + type: array + items: + $ref: "#/components/schemas/User" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "501": + $ref: "#/components/responses/NotImplemented"