config

Documentation

Index

• type Option
  • func WithContentAssertions() Option
  • func WithCustomFormat(name string, validator func(v any) error) Option
  • func WithExistingOpts(options *ValidationOptions) Option
  • func WithFormatAssertions() Option
  • func WithOpenAPIMode() Option
  • func WithRegexEngine(engine jsonschema.RegexpEngine) Option
  • func WithScalarCoercion() Option
  • func WithoutOpenAPIMode() Option
  • func WithoutSecurityValidation() Option
• type ValidationOptions
  • func NewValidationOptions(opts ...Option) *ValidationOptions

Types

type Option

type Option func(*ValidationOptions)

Option Enables an 'Options pattern' approach

func WithContentAssertions

func WithContentAssertions() Option

WithContentAssertions enables checks for contentType, contentEncoding, etc

func WithCustomFormat

func WithCustomFormat(name string, validator func(v any) error) Option

WithCustomFormat adds custom formats and their validators that checks for custom 'format' assertions When you add different validators with the same name, they will be overridden, and only the last registration will take effect.

func WithExistingOpts

func WithExistingOpts(options *ValidationOptions) Option

WithExistingOpts returns an Option that will copy the values from the supplied ValidationOptions instance

func WithFormatAssertions

func WithFormatAssertions() Option

WithFormatAssertions enables checks for 'format' assertions (such as date, date-time, uuid, etc)

func WithOpenAPIMode

func WithOpenAPIMode() Option

WithOpenAPIMode enables OpenAPI-specific keyword validation (default: true)

func WithRegexEngine

func WithRegexEngine(engine jsonschema.RegexpEngine) Option

WithRegexEngine Assigns a custom regular-expression engine to be used during validation.

func WithScalarCoercion

func WithScalarCoercion() Option

WithScalarCoercion enables string to boolean/number coercion (Jackson-style)

func WithoutOpenAPIMode

func WithoutOpenAPIMode() Option

WithoutOpenAPIMode disables OpenAPI-specific keyword validation

func WithoutSecurityValidation

func WithoutSecurityValidation() Option

WithoutSecurityValidation disables security validation for request validation

type ValidationOptions

type ValidationOptions struct {
	RegexEngine         jsonschema.RegexpEngine
	FormatAssertions    bool
	ContentAssertions   bool
	SecurityValidation  bool
	OpenAPIMode         bool // Enable OpenAPI-specific vocabulary validation
	AllowScalarCoercion bool // Enable string->boolean/number coercion
	Formats             map[string]func(v any) error
}

ValidationOptions A container for validation configuration.

Generally fluent With... style functions are used to establish the desired behavior.

func NewValidationOptions

func NewValidationOptions(opts ...Option) *ValidationOptions

NewValidationOptions creates a new ValidationOptions instance with default values.