web

Documentation

Index

• Constants
• Variables
• func NewDescriptionRequest(labelOverride string) filter.ReadableValue[string]
• func NewLevelRequest(labelOverride string) filter.ReadableValue[string]
• func NewNameRequest(labelOverride string) filter.ReadableValue[string]
• func NewOccurrenceRequest(labelOverride string) filter.ReadableValue[string]
• func NewOriginRequest(labelOverride string) filter.ReadableValue[string]
• func NewWebEngine() *gin.Engine
• func RegisterSwaggerDocsRoute(docsRouter gin.IRouter)
• func ToFilterOption(options filter.RequestOption, _ int) query.FilterOption

Constants

const (
	LabelIsEqualTo  = "is equal to"
	LabelContains   = "contains"
	LabelBeginsWith = "begins with"
	LabelAfter      = "after"
	LabelBefore     = "before"
)

Filter request options operator labels

const (
	// APIVersion is the current version of the web API
	APIVersion = "1.0"
)

const APIVersionKey = "api-version"

Variables

var (
	OperatorEqual = filter.ReadableValue[filter.CompareOperator]{
		Label: LabelIsEqualTo,
		Value: filter.CompareOperatorIsEqualTo,
	}
	OperatorContains = filter.ReadableValue[filter.CompareOperator]{
		Label: LabelContains,
		Value: filter.CompareOperatorContains,
	}
	OperatorBeginsWith = filter.ReadableValue[filter.CompareOperator]{
		Label: LabelBeginsWith,
		Value: filter.CompareOperatorBeginsWith,
	}
	OperatorAfter = filter.ReadableValue[filter.CompareOperator]{
		Label: LabelAfter,
		Value: filter.CompareOperatorAfterDate,
	}
	OperatorBefore = filter.ReadableValue[filter.CompareOperator]{
		Label: LabelBefore,
		Value: filter.CompareOperatorBeforeDate,
	}
)

Compare operators

Functions

func NewDescriptionRequest

func NewDescriptionRequest(labelOverride string) filter.ReadableValue[string]

func NewLevelRequest

func NewLevelRequest(labelOverride string) filter.ReadableValue[string]

func NewNameRequest

func NewNameRequest(labelOverride string) filter.ReadableValue[string]

func NewOccurrenceRequest

func NewOccurrenceRequest(labelOverride string) filter.ReadableValue[string]

func NewOriginRequest

func NewOriginRequest(labelOverride string) filter.ReadableValue[string]

func NewWebEngine

func NewWebEngine() *gin.Engine

func RegisterSwaggerDocsRoute

func RegisterSwaggerDocsRoute(docsRouter gin.IRouter)

func ToFilterOption

func ToFilterOption(options filter.RequestOption, _ int) query.FilterOption