v4api

type Endpoint struct {
	Method string
	// Pattern is the path under the prefix; {name} matches one segment.
	Pattern string
	// Edition is EditionAll or EditionCommercial.
	Edition string
	// Summary says what it does.
	Summary string
	// Replaces names the v2 route it rewrites, if any.
	Replaces string
	// contains filtered or unexported fields
}

type ProviderKind struct {
	Kind        string   `json:"kind"`
	Name        string   `json:"name"`
	Config      []string `json:"config"`
	Required    []string `json:"required_config"`
	Credentials []string `json:"credentials"`
}

type Request struct {
	Method string
	// Path is the request path under ControlPrefix or PublicPrefix.
	Path           string
	Query          map[string][]string
	Body           []byte
	IdempotencyKey string
	// ActorID is the kernel-authenticated caller.
	ActorID uint
	// SuperAdmin is the kernel's word that the caller may DELETE (a super
	// administrator). The kernel sends it on the list routes, whose answers
	// carry it as can_delete (F5b D7); it is false elsewhere.
	SuperAdmin bool
}

type Response struct {
	StatusCode int
	Body       []byte
}

type Service struct {
	Forward forwardv1.ForwardControlClient
	// NewRequestID names a write without an Idempotency-Key; a random id by
	// default.
	NewRequestID func() string
}

type TargetHealth struct {
	RouteID   string `json:"route_id"`
	RouteName string `json:"route_name"`
	Paused    bool   `json:"paused"`
	// Key is "host:port".
	Key      string `json:"key"`
	Host     string `json:"host"`
	Port     uint32 `json:"port"`
	Weight   uint32 `json:"weight"`
	Priority uint32 `json:"priority"`
	// State is the worst state the reporting nodes see (HEALTH_STATE_*);
	// HEALTH_STATE_UNSPECIFIED before any report.
	State string `json:"state"`
	// Healthy and Reports count the nodes that see it healthy and that
	// report it at all.
	Healthy int `json:"healthy"`
	Reports int `json:"reports"`
	// RttUs is the best latest connect round trip; 0 when none succeeded.
	RttUs            uint32 `json:"rtt_us"`
	CheckedAtUnixMs  int64  `json:"checked_at_unix_ms"`
	CircuitOpenUntil int64  `json:"circuit_open_until_unix_ms,omitempty"`
}

type TopologyEdge struct {
	From     string `json:"from"`
	To       string `json:"to"`
	RouteID  string `json:"route_id"`
	HopIndex uint32 `json:"hop_index"`
	Engine   string `json:"engine"`
	// Security is the link's transport (LINK_SECURITY_*); empty to a
	// target.
	Security string `json:"security,omitempty"`
	Paused   bool   `json:"paused"`
}

type TopologyNode struct {
	ID string `json:"id"`
	// Kind is "forward", "proxy" or "target".
	Kind        string `json:"kind"`
	Name        string `json:"name"`
	InInventory bool   `json:"in_inventory"`
	Reported    bool   `json:"reported"`
	Applied     bool   `json:"applied"`
	HopErrors   uint32 `json:"hop_errors"`
	// Lagging is true when the node runs an older generation than its
	// desired one, or never reported one.
	Lagging bool `json:"lagging"`
}

type Total struct {
	RouteID     string `json:"route_id"`
	HopIndex    uint32 `json:"hop_index"`
	NodeRef     string `json:"node_ref"`
	UpBytes     uint64 `json:"up_bytes"`
	DownBytes   uint64 `json:"down_bytes"`
	UpPackets   uint64 `json:"up_packets"`
	DownPackets uint64 `json:"down_packets"`
	NewConns    uint64 `json:"new_conns"`
}

type TrendPoint struct {
	HourStartUnixMs int64  `json:"hour_start_unix_ms"`
	UpBytes         uint64 `json:"up_bytes"`
	DownBytes       uint64 `json:"down_bytes"`
	NewConns        uint64 `json:"new_conns"`
}

type Violation struct {
	Field   string `json:"field"`
	Message string `json:"message"`
	Code    string `json:"code"`
	RouteID string `json:"route_id,omitempty"`
}