Croupier

Appearance

迁移 API ​

1. "执行向下迁移" ​

  1. route definition
  • Url: /api/v1/migrate/down
  • Method: POST
  • Request: MigrateDownRequest
  • Response: MigrateDownResponse
  1. request definition
go
type MigrateDownRequest struct {
	Target string `json:"target,optional"` // specific version to migrate to
	Force bool `json:"force,optional"` // force run even if already applied
}
  1. response definition
go
type MigrateDownResponse struct {
	Success bool `json:"success"`
	Message string `json:"message"`
	Results []MigrationResult `json:"results,omitempty"`
}

2. "获取迁移历史" ​

  1. route definition
  • Url: /api/v1/migrate/history
  • Method: GET
  • Request: MigrationHistoryRequest
  • Response: MigrationHistoryResponse
  1. request definition
go
type MigrationHistoryRequest struct {
	Page int `form:"page,optional,default=1"`
	PageSize int `form:"pageSize,optional,default=20"`
	Status string `form:"status,optional"`
}
  1. response definition
go
type MigrationHistoryResponse struct {
	Items []MigrationResult `json:"items"`
	Total int64 `json:"total"`
	Page int `json:"page"`
	Size int `json:"pageSize"`
}

3. "获取迁移状态" ​

  1. route definition
  • Url: /api/v1/migrate/status
  • Method: GET
  • Request: MigrationStatusRequest
  • Response: MigrationStatusResponse
  1. request definition
go
type MigrationStatusRequest struct {
}
  1. response definition
go
type MigrationStatusResponse struct {
	LatestVersion string `json:"latestVersion"`
	PendingCount int `json:"pendingCount"`
	HistoryItems []MigrationResult `json:"historyItems,omitempty"`
}

4. "执行向上迁移" ​

  1. route definition
  • Url: /api/v1/migrate/up
  • Method: POST
  • Request: MigrateUpRequest
  • Response: MigrateUpResponse
  1. request definition
go
type MigrateUpRequest struct {
	Force bool `json:"force,optional"` // force run even if already applied
	Step int `json:"step,optional"` // specific step to run (-1 for all)
}
  1. response definition
go
type MigrateUpResponse struct {
	Success bool `json:"success"`
	Message string `json:"message"`
	Results []MigrationResult `json:"results,omitempty"`
}