mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-03 20:40:00 -05:00
885802eae7
* api: remove PHP code samples * api: remove Curl code samples * api: remove Go code samples * link out to marketplace exclusively for community-built drivers * absolute path to V4_SRC * programmatically extract x-codeSamples * initial batch of examples * Update api/server/main.go Co-authored-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com> * Update api/server/main.go Co-authored-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com> * Update api/server/main.go Co-authored-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com> * updated examples --------- Co-authored-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com>
89 lines
2.5 KiB
YAML
89 lines
2.5 KiB
YAML
/api/v4/brand/image:
|
|
get:
|
|
tags:
|
|
- brand
|
|
summary: Get brand image
|
|
description: >
|
|
Get the previously uploaded brand image. Returns 404 if no brand image
|
|
has been uploaded.
|
|
|
|
##### Permissions
|
|
|
|
No permission required.
|
|
operationId: GetBrandImage
|
|
responses:
|
|
"200":
|
|
description: Brand image retrieval successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: string
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"501":
|
|
$ref: "#/components/responses/NotImplemented"
|
|
post:
|
|
tags:
|
|
- brand
|
|
summary: Upload brand image
|
|
description: |
|
|
Uploads a brand image.
|
|
##### Permissions
|
|
Must have `manage_system` permission.
|
|
operationId: UploadBrandImage
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
image:
|
|
description: The image to be uploaded
|
|
type: string
|
|
format: binary
|
|
required:
|
|
- image
|
|
responses:
|
|
"201":
|
|
description: Brand image upload successful
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/StatusOK"
|
|
"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"
|
|
delete:
|
|
tags:
|
|
- brand
|
|
summary: Delete current brand image
|
|
description: >
|
|
Deletes the previously uploaded brand image. Returns 404 if no brand
|
|
image has been uploaded.
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_system` permission.
|
|
|
|
__Minimum server version: 5.6__
|
|
operationId: DeleteBrandImage
|
|
responses:
|
|
"200":
|
|
description: Brand image succesfully deleted
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/StatusOK"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|