requestinventory

type Action struct {
	ID    string
	Owner string
	// ReadOnly is the action's own classification, not the route's: pagination
	// is a question about a read, and a mutation answering with a list is
	// answering about what it just changed.
	ReadOnly bool
	// Route carries the input and output types and their schemas. Its Handler
	// is bound to no client here, since nothing in this package calls it.
	Route toolutil.ActionRoute
}

type Coverage struct {
	Total    int
	Covered  int
	Silent   int
	Unmapped int
	// Silent and Unmapped owners are sorted by package, and each one's actions
	// are sorted too, so a report of them is stable between runs.
	SilentOwners   []Owner
	UnmappedOwners []Owner
}

type Inventory struct {
	Note     string `json:"note"`
	Requests []Row  `json:"requests"`
}

type Owner struct {
	Package string   `json:"package"`
	Actions []string `json:"actions"`
}

type Row struct {
	Package string `json:"package"`
	Kind    string `json:"kind"`
	Method  string `json:"method"`
	Path    string `json:"path"`
	// Query, Body and Variables are the union of every name this package was
	// seen sending this endpoint, never one call's set. Two calls that differ
	// only in which optional filter they pass are the same endpoint, so the
	// union answers which names were sent it and deliberately not which of
	// them were sent together: a combination is a property of the tests, and
	// reading one off this file would be reading a fixture as a contract.
	Query     []string `json:"query,omitempty"`
	Body      []string `json:"body,omitempty"`
	Operation string   `json:"operation,omitempty"`
	Variables []string `json:"variables,omitempty"`
	// Identifiers counts, per placeholder of Path, the distinct raw values the
	// recorder templated into that position across every call this package
	// made to this endpoint.
	//
	// It is the only thing in a row that is about the values rather than the
	// names, and it is here because the templating that makes a row an
	// endpoint is also what hides a whole class of defect: with one fixture
	// value, a handler that builds /projects/1/... and one that builds
	// /projects/<the caller's id>/... produce the same row. A count of one is
	// therefore a lead and never a verdict, and most of them are innocent.
	//
	// Absent on a row recorded before this field existed, and on a path with
	// no placeholder in it at all.
	Identifiers map[string]int `json:"identifiers,omitempty"`
}