240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
348 lines
9.8 KiB
YAML
348 lines
9.8 KiB
YAML
/api/v4/emoji:
|
|
post:
|
|
tags:
|
|
- emoji
|
|
summary: Create a custom emoji
|
|
description: |
|
|
Create a custom emoji for the team.
|
|
##### Permissions
|
|
Must be authenticated.
|
|
operationId: CreateEmoji
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
image:
|
|
description: A file to be uploaded
|
|
type: string
|
|
format: binary
|
|
emoji:
|
|
description: A JSON object containing a `name` field with the name of the
|
|
emoji and a `creator_id` field with the id of the
|
|
authenticated user.
|
|
type: string
|
|
required:
|
|
- image
|
|
- emoji
|
|
responses:
|
|
"201":
|
|
description: Emoji creation successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Emoji"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"413":
|
|
$ref: "#/components/responses/TooLarge"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
get:
|
|
tags:
|
|
- emoji
|
|
summary: Get a list of custom emoji
|
|
description: >
|
|
Get a page of metadata for custom emoji on the system. Since server
|
|
version 4.7, sort using the `sort` query parameter.
|
|
|
|
##### Permissions
|
|
|
|
Must be authenticated.
|
|
operationId: GetEmojiList
|
|
parameters:
|
|
- name: page
|
|
in: query
|
|
description: The page to select.
|
|
schema:
|
|
type: integer
|
|
default: 0
|
|
- name: per_page
|
|
in: query
|
|
description: The number of emojis per page.
|
|
schema:
|
|
type: integer
|
|
default: 60
|
|
- name: sort
|
|
in: query
|
|
description: Either blank for no sorting or "name" to sort by emoji names.
|
|
Minimum server version for sorting is 4.7.
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
responses:
|
|
"200":
|
|
description: Emoji list retrieval successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Emoji"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
"/api/v4/emoji/{emoji_id}":
|
|
get:
|
|
tags:
|
|
- emoji
|
|
summary: Get a custom emoji
|
|
description: |
|
|
Get some metadata for a custom emoji.
|
|
##### Permissions
|
|
Must be authenticated.
|
|
operationId: GetEmoji
|
|
parameters:
|
|
- name: emoji_id
|
|
in: path
|
|
description: Emoji GUID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Emoji retrieval successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Emoji"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
delete:
|
|
tags:
|
|
- emoji
|
|
summary: Delete a custom emoji
|
|
description: >
|
|
Delete a custom emoji.
|
|
|
|
##### Permissions
|
|
|
|
Must have the `manage_team` or `manage_system` permissions or be the user who created the emoji.
|
|
operationId: DeleteEmoji
|
|
parameters:
|
|
- name: emoji_id
|
|
in: path
|
|
description: Emoji GUID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Emoji delete successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Emoji"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
"/api/v4/emoji/name/{emoji_name}":
|
|
get:
|
|
tags:
|
|
- emoji
|
|
summary: Get a custom emoji by name
|
|
description: |
|
|
Get some metadata for a custom emoji using its name.
|
|
##### Permissions
|
|
Must be authenticated.
|
|
|
|
__Minimum server version__: 4.7
|
|
operationId: GetEmojiByName
|
|
parameters:
|
|
- name: emoji_name
|
|
in: path
|
|
description: Emoji name
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Emoji retrieval successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Emoji"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
"/api/v4/emoji/{emoji_id}/image":
|
|
get:
|
|
tags:
|
|
- emoji
|
|
summary: Get custom emoji image
|
|
description: |
|
|
Get the image for a custom emoji.
|
|
##### Permissions
|
|
Must be authenticated.
|
|
operationId: GetEmojiImage
|
|
parameters:
|
|
- name: emoji_id
|
|
in: path
|
|
description: Emoji GUID
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Emoji image retrieval successful
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
/api/v4/emoji/search:
|
|
post:
|
|
tags:
|
|
- emoji
|
|
summary: Search custom emoji
|
|
description: >
|
|
Search for custom emoji by name based on search criteria provided in the
|
|
request body. A maximum of 200 results are returned.
|
|
|
|
##### Permissions
|
|
|
|
Must be authenticated.
|
|
|
|
|
|
__Minimum server version__: 4.7
|
|
operationId: SearchEmoji
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- term
|
|
properties:
|
|
term:
|
|
description: The term to match against the emoji name.
|
|
type: string
|
|
prefix_only:
|
|
description: Set to only search for names starting with the search term.
|
|
type: string
|
|
description: Search criteria
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: Emoji list retrieval successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "#/components/schemas/Emoji"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
/api/v4/emoji/autocomplete:
|
|
get:
|
|
tags:
|
|
- emoji
|
|
summary: Autocomplete custom emoji
|
|
description: >
|
|
Get a list of custom emoji with names starting with or matching the
|
|
provided name. Returns a maximum of 100 results.
|
|
|
|
##### Permissions
|
|
|
|
Must be authenticated.
|
|
|
|
|
|
__Minimum server version__: 4.7
|
|
operationId: AutocompleteEmoji
|
|
parameters:
|
|
- name: name
|
|
in: query
|
|
description: The emoji name to search.
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Emoji list retrieval successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Emoji"
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$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"
|