- route definition
- Url: /api/v1/backups
- Method: GET
- Request:
BackupsListRequest - Response:
BackupsListResponse
- request definition
type BackupsListRequest struct {
Page int `form:"page,optional,default=1"`
PageSize int `form:"pageSize,optional,default=20"`
Type string `form:"type,optional"`
}
- response definition
type BackupsListResponse struct {
Items []Backup `json:"items"`
Total int64 `json:"total"`
Page int `json:"page"`
Size int `json:"pageSize"`
}
- route definition
- Url: /api/v1/backups
- Method: POST
- Request:
BackupCreateRequest - Response:
BackupDetailResponse
- request definition
type BackupCreateRequest struct {
Name string `json:"name,optional"`
Type string `json:"type,optional"` // full, incremental
}
- response definition
type BackupDetailResponse struct {
Id string `json:"id"`
Name string `json:"name"`
Size int64 `json:"size"`
Type string `json:"type"`
Status string `json:"status"`
CreatedAt string `json:"createdAt"`
}
type Backup struct {
Id string `json:"id"`
Name string `json:"name"`
Size int64 `json:"size"`
Type string `json:"type"`
Status string `json:"status"`
CreatedAt string `json:"createdAt"`
}
- route definition
- Url: /api/v1/backups/:id
- Method: DELETE
- Request:
BackupDeleteRequest - Response:
-
- request definition
type BackupDeleteRequest struct {
ID string `path:"id"`
}
- response definition
- route definition
- Url: /api/v1/backups/:id/download
- Method: GET
- Request:
BackupDownloadRequest - Response:
-
- request definition
type BackupDownloadRequest struct {
ID string `path:"id"`
}
- response definition