web

package

v0.11.0 Latest Latest Go to latest Published: Nov 26, 2025 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation ¶

Index ¶

Constants
Variables
func NewWebEngine(httpConfig config.Http) *gin.Engine
func RegisterSwaggerDocsRoute(docsRouter gin.IRouter, kc config.KeycloakConfig)
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

View Source

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

View Source

const APIVersionKey = "api-version"

Variables ¶

View Source

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

View Source

var (
	NameFilterRequestName = filter.ReadableValue[string]{
		Label: labelNameFilterField,
		Value: dtos.NameField,
	}
	DescriptionFilterRequestName = filter.ReadableValue[string]{
		Label: labelDescriptionFilterField,
		Value: dtos.DescriptionFieldName,
	}
	OccurrenceFilterRequestName = filter.ReadableValue[string]{
		Label: labelOccurrenceFilterField,
		Value: dtos.OccurrenceFieldName,
	}
	OriginFilterRequestName = filter.ReadableValue[string]{
		Label: labelOriginFilterField,
		Value: dtos.OriginFieldName,
	}
	LevelFilterRequestName = filter.ReadableValue[string]{
		Label: labelLevelFilterField,
		Value: dtos.LevelFieldName,
	}
)

filter names

Functions ¶

func NewWebEngine ¶

func NewWebEngine(httpConfig config.Http) *gin.Engine

func RegisterSwaggerDocsRoute ¶

func RegisterSwaggerDocsRoute(docsRouter gin.IRouter, kc config.KeycloakConfig)

func ToFilterOption ¶ added in v0.2.0

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

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
healthcontroller
dtos
helper
middleware
notificationcontroller
dtos
testhelper

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL