analysis

type Consumer struct {
	Kind         string   `json:"kind"`
	Collection   string   `json:"collection"`    // where the consumer is declared
	CollectionID model.ID `json:"collection_id"` //
	File         string   `json:"file"`          // the flow, hook flow or request file
	Flow         string   `json:"flow,omitempty"`
	Node         string   `json:"node,omitempty"`
	Hook         string   `json:"hook,omitempty"` // e.g. "post · request auth/login · inline #0"
	Version      string   `json:"version"`
	Fills        []string `json:"fills,omitempty"` // the node's with keys
	Reads        []Read   `json:"reads,omitempty"`
	Status       Status   `json:"status"`
	Reason       string   `json:"reason,omitempty"` // why the whole consumer is broken, when no single read is
}

type Contract struct {
	Source  string
	Files   []string
	Samples []Sample
	// Removed says the request version is gone: a changed API description no longer has it. Every consumer
	// of it is broken, whatever it reads.
	Removed bool
}

type ContractInfo struct {
	Source string   `json:"source"` // SourceExample, SourceResponse, or empty when nothing is known
	Files  []string `json:"files,omitempty"`
}

type Contracts interface {
	Contract(c model.Collection, r model.Request, version string) (Contract, diag.List)
}

type Coverage struct {
	Operations []OperationCoverage
}

type DataLink struct {
	From string `json:"from"`
	To   string `json:"to"`
	Via  string `json:"via"`
}

type FileContracts struct {
	DataDir func(model.ID) string
}

type OperationCoverage struct {
	Collection string
	Request    string // the request's path
	Version    string
	Used       []string     // the flows and hooks that call it
	Statuses   []StatusSeen // the statuses the description documents
	Read       []string     // response fields a flow reads, as JSONPaths ($.user.id)
	Unread     []string     // response fields no flow reads
}

type Read struct {
	Kind   string `json:"kind"`
	Expr   string `json:"expr"`             // as written: nodes.login.token, response.body.id, extract token, with.tenant
	Target string `json:"target"`           // what is checked: $.data.token, a header, cookie or input name
	Via    string `json:"via,omitempty"`    // the extract name a node read goes through
	Reader string `json:"reader,omitempty"` // the node whose template reads it; empty for flow-level templates
	File   string `json:"file"`
	Path   string `json:"path"` // YAML path of the reading template
	Status Status `json:"status"`
	Reason string `json:"reason,omitempty"`
	// contains filtered or unexported fields
}

type Replaced struct {
	Base Contracts
	By   map[string]Contract
}

type Report struct {
	Collection   string         `json:"collection"`
	CollectionID model.ID       `json:"collection_id"`
	Request      string         `json:"request"` // path, e.g. auth/login
	RequestID    model.ID       `json:"request_id"`
	Versions     []VersionUsage `json:"versions"`
	Status       Status         `json:"status"` // the worst version's
}

type Sample struct {
	Source       string      // SourceExample or SourceResponse
	File         string      // the example or saved-response file
	Status       int         // HTTP status
	Headers      http.Header // response headers
	HeadersKnown bool        // false when an example lists no headers: header reads cannot be judged
	Body         any         // the JSON body, or nil when the body is not JSON
	Text         string      // the body text, when it is not JSON
	Schema       any         // for SourceSchema: the response's JSON Schema
}

type SkipReader struct {
	Skipped  string
	Reader   string
	Reads    string
	Required bool
}

type Status string

type StatusSeen struct {
	Status int
	Seen   bool
}

type Target struct {
	Collection model.ID
	Request    model.ID
}

type Totals struct {
	Operations, Used       int
	Statuses, SeenStatuses int
	Fields, ReadFields     int
}

type VersionUsage struct {
	Version   string       `json:"version"`
	Contract  ContractInfo `json:"contract"`
	Consumers []Consumer   `json:"consumers"`
	Status    Status       `json:"status"` // the worst consumer's
}