endpoint

type APIEndpoint struct {
	Metadata         *EndpointMetadata
	DecoderValidator handlerutils.RequestDecoderValidator
	Writer           handlerutils.ResultWriter
}

type APIEndpointFactory interface {
	NewAPIEndpoint(metadata *EndpointMetadata) *APIEndpoint
	GetDecoderValidator() handlerutils.RequestDecoderValidator
	GetResultWriter() handlerutils.ResultWriter
}

type APIObjectEndpointFactory struct {
	DecoderValidator handlerutils.RequestDecoderValidator
	ResultWriter     handlerutils.ResultWriter
}

type EndpointMetadata struct {
	// The API verb that this endpoint should use
	Verb types.APIVerb

	// The underlying HTTP method that this endpoint should use
	Method types.HTTPVerb

	// The constructed path for the endpoint
	Path *Path

	// A list of scopes required for the endpoint
	Scopes []types.PermissionScope

	// Whether the endpoint upgrades to a websocket
	IsWebsocket bool

	// Whether the endpoint should check for a usage limit
	CheckUsage bool

	// The usage metric that the request should check for, if CheckUsage
	UsageMetric types.UsageMetric

	// AllowUnverifiedEmails controls whether or not the endpoint should permit authenticated
	// users with unverified email addresses
	AllowUnverifiedEmails bool

	// (optional) ContentType describes the content type for the endpoint. If unspecified, it's
	// registered as application/json;utf8.
	ContentType string
}

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

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

type Path struct {
	// The parent path
	Parent *Path

	// The relative path from the parent
	RelativePath string
}

type RequestAction struct {
	Verb       types.APIVerb
	ResourceID string
}