schema

Documentation

Index

• Constants
• func ContextSetRoot(err *jsonschema.ValidationError, head string) *jsonschema.ValidationError
• func GetKeysInOrder(schemaRef string) ([]string, error)
• func NewDuplicateCredentialsError() error
• func NewInvalidCredentialsError() error
• func NewInvalidFormatError(instancePtr, format, value string) error
• func NewMinLengthError(instancePtr string, expected, actual int) error
• func NewPasswordPolicyViolationError(instancePtr string, reason string) error
• func NewRequiredError(missingPtr, missingFieldName string) error
• func WithExtensionRunner(e *ExtensionRunner) func(*validatorOptions)
• type Extension
• type ExtensionConfig
• type ExtensionRunner
  • func NewExtensionRunner(meta ExtensionRunnerMetaSchema, runners ...Extension) (*ExtensionRunner, error)
  • func (r *ExtensionRunner) AddRunner(run Extension) *ExtensionRunner
  • func (r *ExtensionRunner) Extension() jsonschema.Extension
  • func (r *ExtensionRunner) Finish() error
  • func (r *ExtensionRunner) Register(compiler *jsonschema.Compiler) *ExtensionRunner
• type ExtensionRunnerMetaSchema
• type Handler
  • func NewHandler(r handlerDependencies) *Handler
  • func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)
  • func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)
• type HandlerProvider
• type Schema
  • func (s *Schema) SchemaURL(host *url.URL) *url.URL
• type Schemas
  • func (s Schemas) GetByID(id string) (*Schema, error)
• type ValidationError
• type ValidationErrorContextDuplicateCredentialsError
  • func (r *ValidationErrorContextDuplicateCredentialsError) AddContext(_, _ string)
  • func (r *ValidationErrorContextDuplicateCredentialsError) FinishInstanceContext()
• type ValidationErrorContextInvalidCredentialsError
  • func (r *ValidationErrorContextInvalidCredentialsError) AddContext(_, _ string)
  • func (r *ValidationErrorContextInvalidCredentialsError) FinishInstanceContext()
• type ValidationErrorContextPasswordPolicyViolation
  • func (r *ValidationErrorContextPasswordPolicyViolation) AddContext(_, _ string)
  • func (r *ValidationErrorContextPasswordPolicyViolation) FinishInstanceContext()
• type ValidationProvider
• type Validator
  • func NewValidator() *Validator
  • func (v *Validator) Validate(href string, document json.RawMessage, opts ...func(*validatorOptions)) error

Constants

const SchemasPath string = "schemas"

Functions

func ContextSetRoot

func ContextSetRoot(err *jsonschema.ValidationError, head string) *jsonschema.ValidationError

func GetKeysInOrder

func GetKeysInOrder(schemaRef string) ([]string, error)

func NewDuplicateCredentialsError

func NewDuplicateCredentialsError() error

func NewInvalidCredentialsError

func NewInvalidCredentialsError() error

func NewInvalidFormatError

func NewInvalidFormatError(instancePtr, format, value string) error

func NewMinLengthError

func NewMinLengthError(instancePtr string, expected, actual int) error

func NewPasswordPolicyViolationError

func NewPasswordPolicyViolationError(instancePtr string, reason string) error

func NewRequiredError

func NewRequiredError(missingPtr, missingFieldName string) error

func WithExtensionRunner

func WithExtensionRunner(e *ExtensionRunner) func(*validatorOptions)

Types

type Extension

type Extension interface {
	Run(ctx jsonschema.ValidationContext, config ExtensionConfig, value interface{}) error
	Finish() error
}

type ExtensionConfig

type ExtensionConfig struct {
	Credentials struct {
		Password struct {
			Identifier bool `json:"identifier"`
		} `json:"password"`
	} `json:"credentials"`
	Verification struct {
		Via string `json:"via"`
	} `json:"verification"`
	Recovery struct {
		Via string `json:"via"`
	} `json:"recovery"`
	Mappings struct {
		Identity struct {
			Traits []struct {
				Path string `json:"path"`
			} `json:"traits"`
		} `json:"identity"`
	} `json:"mappings"`
}

type ExtensionRunner

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

func NewExtensionRunner

func NewExtensionRunner(meta ExtensionRunnerMetaSchema, runners ...Extension) (*ExtensionRunner, error)

func (*ExtensionRunner) AddRunner

func (r *ExtensionRunner) AddRunner(run Extension) *ExtensionRunner

func (*ExtensionRunner) Extension

func (r *ExtensionRunner) Extension() jsonschema.Extension

func (*ExtensionRunner) Finish

func (r *ExtensionRunner) Finish() error

func (*ExtensionRunner) Register

func (r *ExtensionRunner) Register(compiler *jsonschema.Compiler) *ExtensionRunner

type ExtensionRunnerMetaSchema

type ExtensionRunnerMetaSchema string

const (
	ExtensionRunnerIdentityMetaSchema ExtensionRunnerMetaSchema = "extension/identity.schema.json"
)

type Handler

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

func NewHandler

func NewHandler(r handlerDependencies) *Handler

func (*Handler) RegisterAdminRoutes

func (h *Handler) RegisterAdminRoutes(admin *x.RouterAdmin)

func (*Handler) RegisterPublicRoutes

func (h *Handler) RegisterPublicRoutes(public *x.RouterPublic)

type HandlerProvider

type HandlerProvider interface {
	SchemaHandler() *Handler
}

type Schema

type Schema struct {
	ID     string   `json:"id"`
	URL    *url.URL `json:"-"`
	RawURL string   `json:"url"`
}

func (*Schema) SchemaURL

func (s *Schema) SchemaURL(host *url.URL) *url.URL

type Schemas

type Schemas []Schema

func (Schemas) GetByID

func (s Schemas) GetByID(id string) (*Schema, error)

type ValidationError

type ValidationError struct {
	*jsonschema.ValidationError
	Messages text.Messages
}

type ValidationErrorContextDuplicateCredentialsError

type ValidationErrorContextDuplicateCredentialsError struct{}

func (*ValidationErrorContextDuplicateCredentialsError) AddContext

func (r *ValidationErrorContextDuplicateCredentialsError) AddContext(_, _ string)

func (*ValidationErrorContextDuplicateCredentialsError) FinishInstanceContext

func (r *ValidationErrorContextDuplicateCredentialsError) FinishInstanceContext()

type ValidationErrorContextInvalidCredentialsError

type ValidationErrorContextInvalidCredentialsError struct{}

func (*ValidationErrorContextInvalidCredentialsError) AddContext

func (r *ValidationErrorContextInvalidCredentialsError) AddContext(_, _ string)

func (*ValidationErrorContextInvalidCredentialsError) FinishInstanceContext

func (r *ValidationErrorContextInvalidCredentialsError) FinishInstanceContext()

type ValidationErrorContextPasswordPolicyViolation

type ValidationErrorContextPasswordPolicyViolation struct {
	Reason string
}

func (*ValidationErrorContextPasswordPolicyViolation) AddContext

func (r *ValidationErrorContextPasswordPolicyViolation) AddContext(_, _ string)

func (*ValidationErrorContextPasswordPolicyViolation) FinishInstanceContext

func (r *ValidationErrorContextPasswordPolicyViolation) FinishInstanceContext()

type ValidationProvider

type ValidationProvider interface {
	SchemaValidator() *Validator
}

type Validator

type Validator struct {
	sync.RWMutex
}

func NewValidator

func NewValidator() *Validator

func (*Validator) Validate

func (v *Validator) Validate(
	href string,
	document json.RawMessage,
	opts ...func(*validatorOptions),
) error