routes

type Change struct {
	Kind  string `json:"kind"` // route-added, route-removed, route-changed
	Route string `json:"route"`
	What  string `json:"what,omitempty"`
}

type Coverage struct {
	Covered   []string            // route keys reached by a request
	Excluded  map[string]string   // route key → reason
	Uncovered []string            // neither reached by a request that should succeed nor excluded
	Negative  []string            // reached only by requests that expect an error (not-found, invalid-param…); also in Uncovered
	Requests  map[string][]string // route key → request IDs
	Unknown   []string            // requests that reach no route
	Stale     []string            // exclusions that match no route
	NoBody    []string            // routes that take a body and have no sample
}

type Exclusion struct {
	Target string `yaml:"target,omitempty"` // only routes of this service; empty: every service
	Route  string `yaml:"route"`            // "METHOD /path" glob; without a method it matches every method
	Reason string `yaml:"reason"`
}

type Exclusions struct {
	Version int         `yaml:"version"`
	Routes  []Exclusion `yaml:"routes"`
}

type FileField struct {
	Field string `json:"field"`
	Kind  string `json:"kind"`
}

type Inventory struct {
	Version int     `json:"version"`
	Routes  []Route `json:"routes"`
}

type Param struct {
	Name     string
	Optional bool
	CatchAll bool
}

type Route struct {
	Methods    []string          `json:"methods"` // "*" means any method
	Path       string            `json:"path"`
	Target     string            `json:"target,omitempty"` // the service, with several targets
	Domain     string            `json:"domain,omitempty"`
	Name       string            `json:"name,omitempty"`
	Action     string            `json:"action,omitempty"`
	File       string            `json:"file,omitempty"` // source file of the action, relative to the project root, with :line when known
	Middleware []string          `json:"middleware,omitempty"`
	Auth       bool              `json:"auth,omitempty"`  // needs an authenticated identity
	Body       json.RawMessage   `json:"body,omitempty"`  // sample request body
	Query      map[string]string `json:"query,omitempty"` // required query parameters with sample values
	BodySource string            `json:"body_source,omitempty"`
	BodyType   string            `json:"body_type,omitempty"` // media type of the body when not application/json
	Files      []FileField       `json:"files,omitempty"`     // file fields of a multipart/form-data body
	Source     string            `json:"source"`              // adapter that found it
}