apishttp

type Caller struct {
	UserID string
	Email  string
	// Roles are what the route policy resolves an operation's verdict from.
	Roles []string
	// Persona is the caller's resolved persona, whose connection rules decide
	// which connections they reach. An unresolved persona reaches nothing.
	Persona string
	// IsAdmin lifts the persona boundary, which is what an administrator has
	// everywhere else in the product.
	IsAdmin bool
}

type Connection struct {
	Name        string
	Kind        string
	Description string
}

type Deps struct {
	// Caller resolves the authenticated reader. Nil leaves the routes
	// unmounted: a surface that cannot tell who is asking cannot narrow
	// anything to them.
	Caller func(r *http.Request) *Caller
	// Connections enumerates what a caller reaches. It is the composition
	// root's, because resolving it means walking the live toolkit registry
	// through the persona boundary and this package holds neither. It takes
	// the whole Caller rather than a narrowing of it, so the answer and the
	// identity it was drawn for cannot drift apart.
	//
	// Nil leaves the routes unmounted, for the same reason connreach yields a
	// nil Lister: a deployment that cannot enumerate its connections should
	// serve no set rather than an empty one a page renders as "you reach
	// nothing".
	Connections func(ctx context.Context, caller *Caller) []Connection
	// Locate finds the api-gateway toolkit serving one connection, or nil when
	// no live toolkit does. Nil leaves the routes unmounted.
	Locate func(connection string) OperationBrowser
	// Elevate puts the caller's identity on the context the toolkit reads, so
	// the route policy resolves the same roles it would resolve for that
	// caller's tool call. Nil means no elevation, which the policy reads as an
	// anonymous caller.
	Elevate func(ctx context.Context, c *Caller) context.Context
}

type Handler struct {
	// contains filtered or unexported fields
}

type OperationBrowser interface {
	BrowseConnection(ctx context.Context, name string) (*apigatewaykit.BrowseConnection, error)
	BrowseOperations(ctx context.Context, connection string) ([]apigatewaykit.OperationSummary, error)
	BrowseOperation(ctx context.Context, connection, operationID, spec string) (*apigatewaykit.EndpointSchemaOutput, error)
}