servicecatalog

type Binding struct {
	Consumer   string       `json:"consumer"`
	Field      string       `json:"field"`
	Interface  string       `json:"interface"`
	Methods    []CodeMethod `json:"methods"`
	Candidates []string     `json:"candidates"` // assignable producers, NOT selected bindings
	Providers  []string     `json:"providers"`  // accessors in this field's composition expression
	Resolution string       `json:"resolution"` // composition_expression or unresolved
}

type Catalog struct {
	Schema      string       `json:"schema"`
	Module      string       `json:"module"`
	Processes   []Process    `json:"processes"`
	Services    []Service    `json:"services"`
	Components  []Component  `json:"components"`
	Bindings    []Binding    `json:"bindings"`
	Clients     []Client     `json:"clients"`
	Diagnostics []Diagnostic `json:"diagnostics"`
}

type Client struct {
	ID          string `json:"id"`
	Provider    string `json:"provider"`
	Service     string `json:"service"`
	ConfigField string `json:"config_field"` // existing fully-qualified proto config field, NOT its value
	Constructor string `json:"constructor"`
	Source      Source `json:"source"`
	Resolution  string `json:"resolution"` // declared; no target URL inference
}

type ClientBinding struct {
	Service     string
	ConfigField string
}

type CodeMethod struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	Signature  string `json:"signature"`   // Go types qualified by import path
	Scope      string `json:"scope"`       // legacy instrumentation scope
	LegacyName string `json:"legacy_name"` // legacy pkg.Method span name
	Source     Source `json:"source"`
}

type Component struct {
	ID      string       `json:"id"`
	Name    string       `json:"name"`
	Kind    string       `json:"kind"`
	Type    string       `json:"type"`
	Source  Source       `json:"source"`
	Methods []CodeMethod `json:"methods"`
	// ImplementationCandidates are assignable concrete types in the component's
	// package. They are not proof of which implementation a constructor returns.
	ImplementationCandidates []Implementation `json:"implementation_candidates"`
}

type Diagnostic struct {
	Code      string `json:"code"`
	Component string `json:"component,omitempty"`
	Source    Source `json:"source"`
}

type Implementation struct {
	Type    string       `json:"type"`
	Source  Source       `json:"source"`
	Methods []CodeMethod `json:"methods"`
}

type Method struct {
	ID              string `json:"id"` // full proto service + "/" + method
	Name            string `json:"name"`
	Input           string `json:"input"`
	Output          string `json:"output"`
	ClientStreaming bool   `json:"client_streaming"`
	ServerStreaming bool   `json:"server_streaming"`
	Idempotency     string `json:"idempotency"` // UNKNOWN, IDEMPOTENT, NO_SIDE_EFFECTS
	AuthRequired    bool   `json:"auth_required"`
}

type Process struct {
	ID         string   `json:"id"`
	Root       string   `json:"root"`
	Command    []string `json:"command"`
	Components []string `json:"components"`
	Serves     []Serve  `json:"serves"`
	Clients    []string `json:"clients"` // registrations reachable by this root: can-call only
	Source     Source   `json:"source"`
}

type Serve struct {
	Component  string `json:"component"` // handler component; method names join to Component.Methods
	Service    string `json:"service"`   // fully-qualified protobuf service
	RouteSet   string `json:"route_set"`
	Audience   string `json:"audience"`
	Resolution string `json:"resolution"` // declared_route_set; not runtime observation
}

type Service struct {
	Name      string   `json:"name"`
	ProtoFile string   `json:"proto_file"`
	Methods   []Method `json:"methods"`
	// Descriptor is the existing forge_descriptor.json ServiceDef, unchanged:
	// Schemas, SchemaFiles, Enums and field validate/validate_options are the
	// authoritative schema graph. Do not invent a second validation dialect.
	Descriptor json.RawMessage `json:"descriptor"`
}

type Source struct {
	Path string `json:"path"` // module-relative, never absolute
	Line int    `json:"line"`
}