mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
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]>
127 lines
3.3 KiB
YAML
127 lines
3.3 KiB
YAML
"/v1/team/exports":
|
|
get:
|
|
tags:
|
|
- exports
|
|
summary: List export files
|
|
description: >
|
|
Lists all available export files.
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_system` permissions.
|
|
operationId: ListExports
|
|
responses:
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"/v1/team/exports/{export_name}":
|
|
get:
|
|
tags:
|
|
- exports
|
|
summary: Download an export file
|
|
description: |
|
|
Downloads an export file.
|
|
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_system` permissions.
|
|
operationId: DownloadExport
|
|
parameters:
|
|
- name: export_name
|
|
in: path
|
|
description: The name of the export file to download
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
delete:
|
|
tags:
|
|
- exports
|
|
summary: Delete an export file
|
|
description: |
|
|
Deletes an export file.
|
|
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
|
|
Must have `manage_system` permissions.
|
|
operationId: DeleteExport
|
|
parameters:
|
|
- name: export_name
|
|
in: path
|
|
description: The name of the export file to delete
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|
|
"/v1/team/exports/{export_name}/presign-url":
|
|
post:
|
|
tags:
|
|
- exports
|
|
summary: Create a presigned URL for export download
|
|
description: |
|
|
Creates a presigned URL for downloading an export file.
|
|
|
|
__Minimum server version__: 5.33
|
|
|
|
##### Permissions
|
|
Must have `manage_system` permission.
|
|
operationId: PresignExport
|
|
parameters:
|
|
- name: export_name
|
|
in: path
|
|
description: The name of the export file
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Presigned URL created successfully
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
url:
|
|
type: string
|
|
"400":
|
|
$ref: "#/components/responses/BadRequest"
|
|
"401":
|
|
$ref: "#/components/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/components/responses/Forbidden"
|
|
"404":
|
|
$ref: "#/components/responses/NotFound"
|
|
"500":
|
|
$ref: "#/components/responses/InternalServerError"
|