schema

type APICall struct {
	API                  string `json:"api"`
	Phase                string `json:"phase"`
	Condition            string `json:"condition,omitempty"`
	ConditionDescription string `json:"condition_description,omitempty"`
	Purpose              string `json:"purpose"`
	Repeated             bool   `json:"repeated,omitempty"`
	Cached               bool   `json:"cached,omitempty"`
}

type Capabilities struct {
	SchemaVersion int              `json:"schema_version"`
	CLI           string           `json:"cli"`
	Surface       string           `json:"surface"`
	OutputModes   []string         `json:"output_modes"`
	Schema        SchemaCapability `json:"schema"`
	Errors        ErrorContract    `json:"errors"`
	Products      []ProductSurface `json:"products"`
}

type CommandSchema struct {
	SchemaVersion int               `json:"schema_version"`
	Command       string            `json:"command"`
	SchemaID      string            `json:"schema_id,omitempty"`
	CLI           string            `json:"cli,omitempty"`
	Usage         string            `json:"usage,omitempty"`
	Kind          string            `json:"kind"`
	Risk          Risk              `json:"risk"`
	Description   string            `json:"description"`
	Positionals   []PositionalParam `json:"positionals,omitempty"`
	Params        map[string]Param  `json:"params"`
	Filters       map[string]Filter `json:"filters,omitempty"`
	Examples      []string          `json:"examples,omitempty"`
	Output        *OutputShape      `json:"output,omitempty"`
	Contract      *Contract         `json:"contract,omitempty"`
	APICalls      []APICall         `json:"api_calls,omitempty"`
}

type CommandSchemaMode string

type Contract struct {
	DryRun      Support             `json:"dry_run"`
	Idempotency IdempotencyContract `json:"idempotency"`
	Wait        *WaitContract       `json:"wait,omitempty"`
}

type ErrorContract struct {
	Structured   bool     `json:"structured"`
	Stream       string   `json:"stream"`
	Fields       []string `json:"fields"`
	ActionFields []string `json:"action_fields"`
}

type Filter struct {
	Type        string `json:"type"`
	Description string `json:"description,omitempty"`
}

type IdempotencyContract struct {
	Supported bool   `json:"supported"`
	Field     string `json:"field,omitempty"`
	Prefix    string `json:"prefix,omitempty"`
	Mode      string `json:"mode,omitempty"`
	Reason    string `json:"reason,omitempty"`
}

type OutputShape struct {
	Root   string   `json:"root,omitempty"`
	Fields []string `json:"fields,omitempty"`
}

type Param struct {
	Type           string           `json:"type"`
	Description    string           `json:"description,omitempty"`
	Required       bool             `json:"required,omitempty"`
	Repeatable     bool             `json:"repeatable,omitempty"`
	Positional     bool             `json:"positional,omitempty"`
	PositionalMany bool             `json:"positional_many,omitempty"`
	Default        any              `json:"default,omitempty"`
	Input          string           `json:"input,omitempty"`
	Items          *Param           `json:"items,omitempty"`
	Fields         map[string]Param `json:"fields,omitempty"`
}

type PositionalParam struct {
	Name        string `json:"name"`
	Type        string `json:"type,omitempty"`
	Description string `json:"description,omitempty"`
	Required    bool   `json:"required,omitempty"`
	Many        bool   `json:"many,omitempty"`
	Input       string `json:"input,omitempty"`
}

type ProductSummary struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
}

type ProductSurface struct {
	Product     string            `json:"product"`
	Description string            `json:"description,omitempty"`
	Resources   []ResourceSurface `json:"resources"`
}

type ResourceSurface struct {
	Product     string   `json:"product,omitempty"`
	Name        string   `json:"name"`
	Parent      string   `json:"parent,omitempty"`
	SchemaID    string   `json:"schema_id"`
	Description string   `json:"description,omitempty"`
	Actions     []string `json:"actions"`
}

type Risk struct {
	Level       string `json:"level"`
	Description string `json:"description"`
}

type SchemaCapability struct {
	Supported    bool     `json:"supported"`
	ListCommands []string `json:"list_commands"`
	GetCommand   string   `json:"get_command"`
}

type Support struct {
	Supported bool   `json:"supported"`
	Flag      string `json:"flag,omitempty"`
	Reason    string `json:"reason,omitempty"`
}

type WaitContract struct {
	Waitable    bool             `json:"waitable"`
	NoWaitFlag  string           `json:"no_wait_flag,omitempty"`
	TimeoutFlag string           `json:"timeout_flag,omitempty"`
	PollCommand string           `json:"poll_command,omitempty"`
	Waiters     []WaiterContract `json:"waiters,omitempty"`
}

type WaiterContract struct {
	Name          string   `json:"name"`
	Probe         string   `json:"probe,omitempty"`
	Target        string   `json:"target,omitempty"`
	Interval      string   `json:"interval,omitempty"`
	Timeout       string   `json:"timeout,omitempty"`
	FailureStates []string `json:"failure_states,omitempty"`
}