conform

type Client struct {
	Name    string
	Headers http.Header
}

type Difference struct {
	// Client, Format and Endpoint identify the request (filled by the
	// caller that ran it; Compare leaves them empty).
	Client   string `json:"client,omitempty"`
	Format   string `json:"format,omitempty"`
	Endpoint string `json:"endpoint,omitempty"`

	Path      string `json:"path"`
	Kind      string `json:"kind"`
	Reference any    `json:"reference,omitempty"`
	Target    any    `json:"target,omitempty"`
	// Count is how many times the path occurs on the side that has it (the
	// reference for missing/type/value, the target for extra).
	Count int `json:"count,omitempty"`
	// Nested is how many descendant paths of a missing or extra element
	// were folded into this difference.
	Nested   int    `json:"nested,omitempty"`
	Blocking bool   `json:"blocking"`
	Reason   string `json:"reason,omitempty"`
}

type DiscoveredIDs struct {
	Values   map[string]string `json:"values"`
	Warnings []string          `json:"warnings,omitempty"`
}

type EndpointSummary struct {
	Endpoint string        `json:"endpoint"`
	Missing  []PathSummary `json:"missing,omitempty"`
	Extra    []PathSummary `json:"extra,omitempty"`
	Type     []PathSummary `json:"type,omitempty"`
	Value    []PathSummary `json:"value,omitempty"`
	// Other holds status, header, parse and request errors.
	Other []PathSummary `json:"other,omitempty"`
}

type PathSummary struct {
	Format    string   `json:"format"`
	Path      string   `json:"path"`
	Kind      string   `json:"kind"`
	Reference string   `json:"reference,omitempty"`
	Target    string   `json:"target,omitempty"`
	Clients   []string `json:"clients"`
	Count     int      `json:"count,omitempty"`
	Nested    int      `json:"nested,omitempty"`
	Blocking  bool     `json:"blocking,omitempty"`
}

type Protocol interface {
	Clients() map[string]Client
	Corpus(profile string) []Request
	Formats() []bool // false is XML, true is JSON
	Discover(context.Context, *http.Client, string, string, string, *DiscoveredIDs) DiscoveredIDs
	Fetch(context.Context, *http.Client, string, string, Request, string, map[string]string, bool) (Response, error)
	FixtureName(profile string, request Request, jsonMode bool) string
	// IgnorePaths supplies regular expressions for protocol-specific differences.
	IgnorePaths() []string
	Redact(response Response) Response
	Compare(reference, target Response) Report
}

type ReferenceDefect struct {
	ID       string `json:"id"`
	Detail   string `json:"detail"`
	Observed string `json:"observed"`
}

type Report struct {
	Differences      []Difference      `json:"differences"`
	Discovery        []string          `json:"discovery,omitempty"`
	ReferenceDefects []ReferenceDefect `json:"reference_defects,omitempty"`
	// Endpoints lists every endpoint compared, so summaries can show
	// endpoints without differences too.
	Endpoints []string `json:"endpoints,omitempty"`
}

type Request struct {
	Name, Method, Path string
	Headers            map[string]http.Header
	Body               []byte
	RangeKind          string
	FixtureOnly        bool
	ExpectedStatus     int
}

type RequestComparer interface {
	CompareRequest(Request, Response, Response) Report
}

type Response struct {
	Status          int              `json:"status"`
	Headers         http.Header      `json:"headers"`
	Body            []byte           `json:"body"`
	Kind            string           `json:"kind,omitempty"`
	RangeKind       string           `json:"rangeKind,omitempty"`
	BodyLength      int64            `json:"bodyLength,omitempty"`
	SHA256          string           `json:"sha256,omitempty"`
	Truncated       bool             `json:"truncated,omitempty"`
	ReferenceDefect *ReferenceDefect `json:"reference_defect,omitempty"`
	RequestRange    string           `json:"requestRange,omitempty"`
}

type ResponseObserver interface {
	Observe(Request, Response, map[string]string)
}

type Route struct {
	Method  string `json:"method"`
	Pattern string `json:"pattern"`
}

type RouteInventory struct {
	Available bool    `json:"available"`
	Routes    []Route `json:"routes"`
}