Files
team/api/v4/source/usage.yaml
T
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

82 lines
2.4 KiB
YAML

/v1/team/usage/posts:
get:
tags:
- usage
summary: Get current usage of posts
description: >
Retrieve rounded off total no. of posts for this instance.
Example: returns 4000 instead of 4321
##### Permissions
Must be authenticated.
__Minimum server version__: 7.0
operationId: GetPostsUsage
responses:
"200":
description: Total no. of posts returned successfully
content:
application/json:
schema:
$ref: "#/components/schemas/PostsUsage"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/team/usage/storage:
get:
tags:
- usage
summary: Get the total file storage usage for the instance in bytes.
description: >
Get the total file storage usage for the instance in bytes rounded down to the most significant digit.
Example: returns 4000 instead of 4321
##### Permissions
Must be authenticated.
__Minimum server version__: 7.1
operationId: GetStorageUsage
responses:
"200":
description: The total file storage usage for the instance in bytes rounded down to the most significant digit.
content:
application/json:
schema:
$ref: "#/components/schemas/StorageUsage"
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"
/v1/team/usage/teams:
get:
tags:
- usage
summary: Get current usage of teams
description: >
Retrieve rounded total number of teams for this instance.
##### Permissions
Must be authenticated.
operationId: GetTeamsUsage
responses:
"200":
description: Total number of teams returned successfully
content:
application/json:
schema:
type: object
properties:
active:
type: integer
cloud_archived:
type: integer
teams:
type: integer
"401":
$ref: "#/components/responses/Unauthorized"
"500":
$ref: "#/components/responses/InternalServerError"