review

type Artifact struct {
	Version  int      `json:"version"`
	Baseline Snapshot `json:"baseline"`
	Desired  Snapshot `json:"desired"`
	// Changes lists every change between baseline and desired, selected or not.
	Changes []migrate.Change `json:"changes,omitempty"`
	// Selection limits Steps to these change IDs; empty means every change.
	Selection []string `json:"selection,omitempty"`
	Steps     []Step   `json:"steps"`
	Advisory  []string `json:"advisory,omitempty"`
	Hash      string   `json:"hash"`
}

type Options struct {
	Dialect         string
	Schema          string
	DesiredHCL      string
	Advisory        []string
	PreserveOmitted bool
	// Selection limits the plan to these change IDs; empty plans every change.
	Selection []string
	// Baseline plans from this reviewed snapshot instead of inspecting the database.
	Baseline *Snapshot
}

type Outcome string

type Request struct {
	Artifact         Artifact
	Hash             string
	Acknowledgements []string
	LockTimeout      time.Duration
}

type Result struct {
	Hash    string  `json:"hash"`
	Outcome Outcome `json:"outcome"`
	Steps   int     `json:"steps"`
}

type Snapshot struct {
	Dialect string `json:"dialect"`
	Schema  string `json:"schema"`
	HCL     string `json:"hcl"`
}

type Step struct {
	ID          string `json:"id"`
	SQL         string `json:"sql"`
	Comment     string `json:"comment,omitempty"`
	Destructive bool   `json:"destructive,omitempty"`
	// Changes are the IDs of the described changes this statement implements.
	Changes []string `json:"changes,omitempty"`
}