firetail

type ErrorAppspecInvalid struct {
	Err error // The error that occurred during initialisation of the middleware due to the appspec being invalid
}

type ErrorAtRequest interface {
	error

	// Should return the appropriate HTTP status code to provide in response to the request for which the error occured
	StatusCode() int

	// Should return a title string appropriate for public RFC7807 error responses
	Title() string
}

type ErrorAtRequestUnspecified struct {
	Err error
}

type ErrorAuthNoMatchingScheme struct {
	Err *openapi3filter.SecurityRequirementsError
}

type ErrorAuthSchemeNotImplemented struct {
	MissingScheme string
}

type ErrorInvalidConfiguration struct {
	Err error // The path that was used to attempt to load the appspec
}

type ErrorRequestBodyInvalid struct {
	Err error
}

type ErrorRequestContentTypeInvalid struct {
	RequestedContentType string
	RequestedRoute       string
}

type ErrorRequestHeadersInvalid struct {
	Err error
}

type ErrorRequestPathParamsInvalid struct {
	Err error
}

type ErrorRequestQueryParamsInvalid struct {
	Err error
}

type ErrorResponseBodyInvalid struct {
	Err error
}

type ErrorResponseHeadersInvalid struct {
	Err error
}

type ErrorResponseStatusCodeInvalid struct {
	RespondedStatusCode int
}

type ErrorRouteNotFound struct {
	RequestedPath string // The path that was requested for which no corresponding route could be found
}

type ErrorUnsupportedMethod struct {
	RequestedPath   string // The route that corresponds to the path that was requested for which the method is not supported
	RequestedMethod string // The method which was requested but is not supported on the route corresponding to the request path
}

type Options struct {
	// SpecPath is the path at which your openapi spec can be found. Supplying an empty string disables any validation.
	OpenapiSpecPath string

	// OpenapiBytes is the raw bytes of your openapi spec. Supplying an empty slice disables any validation. OpenapiBytes takes
	// precedence over OpenapiSpecPath if both are provided. OpenapiSpecPath will be used if OpenapiBytes is nil or len() == 0
	OpenapiBytes []byte

	// LogsApiToken is the API token which will be used when sending logs to the Firetail logging API with the default batch callback.
	// This value should typically be loaded in from an environment variable. If unset, the default batch callback will not forward
	// logs to the Firetail SaaS
	LogsApiToken string

	// LogsApiUrl is the URL of the Firetail logging API endpoint to which logs will be sent by the default batch callback. This value
	// should typically be loaded in from an environment variable. If unset, the default value is the Firetail SaaS' bulk logs endpoint
	// in the default region (firetail.app). If another region is being used, this option will need to be configured appropriately. For
	// example, for us.firetail.app LogsApiUrl should normally be https://api.logging.us-east-2.prod.firetail.app/logs/bulk
	LogsApiUrl string

	// LogBatchCallback is an optional callback which is provided with a batch of Firetail log entries ready to be sent to Firetail. The
	// default callback sends log entries to the Firetail logging API. It may be customised to, for example, additionally log the entries
	// to a file on disk
	LogBatchCallback func([][]byte)

	// MaxBatchSize is the maximum size of a logging batch in bytes which will be passed to the LogBatchCallback, or the default callback
	// if it is used.
	MaxBatchSize int

	// MaxLogAge is the maximum age of the oldest log in a batch which will be passed to the LogBatchCallback, or the default callback if
	// it is used.
	MaxLogAge time.Duration

	// ErrCallback is an optional callback func which is given an error and a ResponseWriter to which an apropriate response can be written
	// for the error. This allows you customise the responses given, when for example a request or response fails to validate against the
	// openapi spec, to be consistent with the format in which the rest of your application returns error responses
	ErrCallback func(ErrorAtRequest, http.ResponseWriter, *http.Request)

	// DebugErrs is a flag which, when set to true, will enable the default ErrCallback to send more verbose information in the RFC7807
	// error responses' `details` member.
	DebugErrs bool

	// AuthCallbacks is a map of strings, which should match the names of your appspec's securitySchemes, to callback funcs which must be
	// defined if you wish to use security schemas in your openapi specification. See the openapi3filter package's reference for further
	// documentation
	AuthCallbacks map[string]openapi3filter.AuthenticationFunc

	// EnableRequestValidation is an optional flag which, if set to true, enables request validation against the openapi spec provided -
	// if no openapi spec is provided, then no validation will be performed
	EnableRequestValidation bool

	// EnableResponseValidation is an optional flag which, if set to true, enables response validation against the openapi spec provided -
	// if no openapi spec is provided, then no validation will be performed
	EnableResponseValidation bool

	// CustomBodyDecoders is a map of Content-Type header values to openapi3 decoders - if the kin-openapi module does not support your
	// Content-Type by default, you will need to add a custom decoder here
	CustomBodyDecoders map[string]openapi3filter.BodyDecoder

	// LogEntrySanitiser is a function used to sanitise the log entries sent to Firetail. You may wish to use this to redact sensitive
	// information, or anonymise identifiable information using a custom implementation of this callback for your application. A default
	// implementation is provided in the firetail logging package
	LogEntrySanitiser func(logging.LogEntry) logging.LogEntry
}