model

type DerivedType ¶

type DerivedType interface {
	Unwrap() WithSchema
}

type Entity ¶

type Entity interface {
	WithSchema
	Serializable
}

Entity is a domain model that can be serialized and has a schema. The term comes from Domain-Driven Design (DDD).

type FieldError ¶

type FieldError struct {
	Message string `json:"message"`
	// contains filtered or unexported fields
}

FieldError is used to indicate an error with a specific request field.

func (fe FieldError) Details() map[string]interface{}

func (fe FieldError) Field() string

type Nil ¶

type Nil struct{}

Nil is a model that represents an empty object.

func (n Nil) Example() []byte

func (n Nil) Marshal() (json.RawMessage, error)

func (n Nil) Name() string

func (n Nil) Schema() []byte

func (n Nil) Unmarshal(data json.RawMessage) error

type Serializable ¶

type Serializable interface {
	Marshal() (json.RawMessage, error)
	Unmarshal(data json.RawMessage) error
}

Serializable is an interface for serializing and deserializing data. Serializble is used for data types sent and received over the wire.

type ValidationError ¶

type ValidationError struct {
	Errors []FieldError `json:"errors"`
}

ValidationError represents a collection of field errors.

func ToValidationError(result *gojsonschema.Result) ValidationError

func (fe ValidationError) Error() string

type WithName ¶

type WithName interface {
	Name() string
}

WithName is an interface for defining a name for a data type. The name is used for generating API documentation and for uniquely identifying the data type.

type WithSchema ¶

type WithSchema interface {
	WithName
	Schema() []byte
	Example() []byte
}

WithSchema is an interface for defining a schema and example data for a data type. The schema is used for validating data and for generating API documentation, along with the example data.