Files
zeekayandHanzo Dev 404de134f3 Point the API spec and its route checker at the new base
The OpenAPI document keys every operation by its full path, so the spec
described endpoints that no longer exist the moment the server moved.

The openApiSync analyzer cross-checks each registered subrouter against
that document and reconstructs the prefix from a literal of its own, so
spec and analyzer have to move together or every route reports as
missing. Its special case for the v5 root goes away with the root
itself.

The api/v4 directory keeps its name: it is where the spec sources live,
not a URL anyone requests.

Co-authored-by: Hanzo Dev <[email protected]>
2026-08-14 10:58:08 -07:00

90 lines
2.5 KiB
YAML

/v1/team/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"