endpoints

type AppendSpanAttributesFn = func(r *http.Request, m map[string]string)

type Endpoint struct {
	Methods  []string
	Route    string
	Version  string
	Group    *EndpointGroup // Endpoint group, used for allowlisting
	Handler  http.HandlerFunc
	Settings EndpointSettings
}

type EndpointCtxData struct {
	Group    *EndpointGroup
	Settings EndpointSettings
	SpanData any
}

type EndpointCtxKey struct{}

type EndpointGroup struct {
	// Endpoint group name.
	Name EndpointGroupName
	// Endpoint group version.
	Version EndpointGroupVersion
	// AppendSpanAttributes is a function invoked by the tracing middleware.
	// It receives a map where the callback can add attributes to be added to the span.
	// If this is not defined, no additional data is added to the span.
	AppendSpanAttributes AppendSpanAttributesFn
	// MethodName is an optional method that returns the "method" key used in the server monitoring metrics.
	// If unset, the default value is to use the endpoint name.
	MethodName MethodNameFn
}

type EndpointGroupName string

type EndpointGroupVersion string

type EndpointSettings struct {
	Name          string // Method name, used in logging and for other purposes
	IsFallback    bool   // Endpoint is used as fallback when the method or URL isn't found
	AlwaysAllowed bool   // Endpoint is always allowed regardless of API access rules
	IsHealthCheck bool   // Mark endpoint as healthcheck - for API logging purposes
}

type MethodNameFn = func(r *http.Request) string