Documentation
¶
Index ¶
- Constants
- func IsGenericConflictError(err error) bool
- func IsGenericForbiddenError(err error) bool
- func IsGenericNotFoundError(err error) bool
- func IsGenericNotImplementedError(err error) bool
- func IsGenericPreConditionFailedError(err error) bool
- func IsGenericStatusFailedDependencyError(err error) bool
- func IsGenericUnauthorizedError(err error) bool
- func IsGenericValidationError(err error) bool
- func NewGenericConflictError(err error) error
- func NewGenericForbiddenError(err error) error
- func NewGenericNotFoundError(err error) error
- func NewGenericNotImplementedError(err error) error
- func NewGenericPreConditionFailedError(err error) error
- func NewGenericStatusFailedDependencyError(err error) error
- func NewGenericUnauthorizedError(err error) error
- func NewGenericValidationError(err error) error
- func NewNamespaceNotFoundError(namespace string) error
- func NewNillableGenericValidationError(err error) error
- func RespondProblem(problem Problem, w http.ResponseWriter)
- func Validate[T any](v T, validators ...ValidatorFunc[T]) error
- type Address
- type Annotations
- type CadenceList
- type Cadenced
- type CadencedModel
- type CadencedResourceRepo
- type Clonable
- type CountryCode
- type CustomValidator
- type Equaler
- type GenericConflictError
- type GenericError
- type GenericForbiddenError
- type GenericNotFoundError
- type GenericNotImplementedError
- type GenericPreConditionFailedError
- type GenericStatusFailedDependencyError
- type GenericUnauthorizedError
- type GenericValidationError
- type ManagedModel
- type ManagedModelWithID
- type ManagedResource
- type ManagedResourceInput
- type ManagedUniqueResource
- type Metadata
- type MetadataModel
- type Metadatad
- type NamespaceNotFoundError
- type NamespacedID
- type NamespacedModel
- type Percentage
- func (p Percentage) Add(other Percentage) Percentage
- func (p Percentage) ApplyMarkupTo(value alpacadecimal.Decimal) alpacadecimal.Decimal
- func (p Percentage) ApplyTo(value alpacadecimal.Decimal) alpacadecimal.Decimal
- func (p Percentage) MarshalJSON() ([]byte, error)
- func (p Percentage) String() string
- func (p *Percentage) UnmarshalJSON(data []byte) error
- type Problem
- type ProblemType
- type StatusProblem
- type Validator
- type ValidatorFunc
- type VersionedModel
Constants ¶
const ProblemContentType = "application/problem+json"
ProblemContentType is the default content type for a Problem response
const ( // ProblemTypeDefault is the default problem type. ProblemTypeDefault = ProblemType("about:blank") )
Variables ¶
This section is empty.
Functions ¶
func IsGenericConflictError ¶
IsGenericConflictError returns true if the error is a GenericConflictError.
func IsGenericForbiddenError ¶
IsGenericForbiddenError returns true if the error is a GenericForbiddenError.
func IsGenericNotFoundError ¶
IsGenericNotFoundError returns true if the error is a GenericNotFoundError.
func IsGenericNotImplementedError ¶
IsGenericNotImplementedError returns true if the error is a GenericNotImplementedError.
func IsGenericValidationError ¶
IsGenericValidationError returns true if the error is a GenericValidationError.
func NewGenericConflictError ¶
NewGenericConflictError returns a new GenericConflictError.
func NewGenericForbiddenError ¶
NewGenericValidationError returns a new GenericForbiddenError.
func NewGenericNotFoundError ¶
NewGenericNotFoundError returns a new GenericNotFoundError.
func NewGenericNotImplementedError ¶
NewGenericNotImplementedError returns a new GenericNotImplementedError.
func NewGenericPreConditionFailedError ¶
GenericPreConditionFailedError
func NewGenericStatusFailedDependencyError ¶
GenericStatusFailedDependencyError
func NewGenericUnauthorizedError ¶
GenericUnauthorizedError
func NewGenericValidationError ¶
NewGenericValidationError returns a new GenericValidationError.
func NewNamespaceNotFoundError ¶
NewNamespaceNotFoundError returns a new NamespaceNotFoundError.
func NewNillableGenericValidationError ¶
NewNillableGenericValidationError returns a new GenericValidationError or nil if the error is nil. This is useful when someone passes in an errors.Join to the error.
func RespondProblem ¶
func RespondProblem(problem Problem, w http.ResponseWriter)
Respond will render the problem as JSON to the provided ResponseWriter.
func Validate ¶
func Validate[T any](v T, validators ...ValidatorFunc[T]) error
Types ¶
type Address ¶
type Address struct {
Country *CountryCode `json:"country,omitempty"`
PostalCode *string `json:"postalCode,omitempty"`
State *string `json:"state,omitempty"`
City *string `json:"city,omitempty"`
Line1 *string `json:"line1,omitempty"`
Line2 *string `json:"line2,omitempty"`
PhoneNumber *string `json:"phoneNumber,omitempty"`
}
type Annotations ¶
type Annotations = map[string]interface{}
type CadenceList ¶
type CadenceList[T Cadenced] []T
CadenceList is a simple abstraction for a list of cadenced models. It is useful to validate the relationship between the cadences of the models, like their ordering, overlaps, continuity, etc.
func NewSortedCadenceList ¶
func NewSortedCadenceList[T Cadenced](cadences []T) CadenceList[T]
func (CadenceList[T]) Cadences ¶
func (t CadenceList[T]) Cadences() []T
Cadences returns the cadences in the timeline
func (CadenceList[T]) GetOverlaps ¶
func (t CadenceList[T]) GetOverlaps() [][2]int
GetOverlaps returns true if there is any overlap between the cadences in the timeline
func (CadenceList[T]) IsContinuous ¶
func (t CadenceList[T]) IsContinuous() bool
func (CadenceList[T]) IsSorted ¶
func (t CadenceList[T]) IsSorted() bool
type Cadenced ¶
type Cadenced interface {
// contains filtered or unexported methods
}
Cadenced represents a model with active from and to dates. The interval described is inclusive on the from side and exclusive on the to side.
type CadencedModel ¶
type CadencedModel struct {
ActiveFrom time.Time `json:"activeFrom"`
// ActiveTo CANNOT be BEFORE ActiveFrom (it can be the same, which would mean the entity is never active)
ActiveTo *time.Time `json:"activeTo"`
}
func NewCadencedModelFromPeriod ¶
func NewCadencedModelFromPeriod(period timeutil.OpenPeriod) (CadencedModel, error)
func (CadencedModel) AsPeriod ¶
func (c CadencedModel) AsPeriod() timeutil.OpenPeriod
func (CadencedModel) Equal ¶
func (c CadencedModel) Equal(other CadencedModel) bool
func (CadencedModel) IsActiveAt ¶
func (c CadencedModel) IsActiveAt(t time.Time) bool
func (CadencedModel) IsZero ¶
func (c CadencedModel) IsZero() bool
type CadencedResourceRepo ¶
type CountryCode ¶
type CountryCode string
[ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 country code.
type CustomValidator ¶
type CustomValidator[T any] interface { ValidateWith(...ValidatorFunc[T]) error }
type GenericConflictError ¶
type GenericConflictError struct {
// contains filtered or unexported fields
}
func (*GenericConflictError) Error ¶
func (e *GenericConflictError) Error() string
func (*GenericConflictError) Unwrap ¶
func (e *GenericConflictError) Unwrap() error
type GenericError ¶
GenericError is an interface that all generic errors must implement.
type GenericForbiddenError ¶
type GenericForbiddenError struct {
// contains filtered or unexported fields
}
func (*GenericForbiddenError) Error ¶
func (e *GenericForbiddenError) Error() string
func (*GenericForbiddenError) Unwrap ¶
func (e *GenericForbiddenError) Unwrap() error
type GenericNotFoundError ¶
type GenericNotFoundError struct {
// contains filtered or unexported fields
}
func (*GenericNotFoundError) Error ¶
func (e *GenericNotFoundError) Error() string
func (*GenericNotFoundError) Unwrap ¶
func (e *GenericNotFoundError) Unwrap() error
type GenericNotImplementedError ¶
type GenericNotImplementedError struct {
// contains filtered or unexported fields
}
GenericNotImplementedError is returned when a meter is not found.
func (*GenericNotImplementedError) Error ¶
func (e *GenericNotImplementedError) Error() string
Error returns the error message.
func (*GenericNotImplementedError) Unwrap ¶
func (e *GenericNotImplementedError) Unwrap() error
Unwrap returns the wrapped error.
type GenericPreConditionFailedError ¶
type GenericPreConditionFailedError struct {
// contains filtered or unexported fields
}
func (*GenericPreConditionFailedError) Error ¶
func (e *GenericPreConditionFailedError) Error() string
func (*GenericPreConditionFailedError) Unwrap ¶
func (e *GenericPreConditionFailedError) Unwrap() error
type GenericStatusFailedDependencyError ¶
type GenericStatusFailedDependencyError struct {
// contains filtered or unexported fields
}
func (*GenericStatusFailedDependencyError) Error ¶
func (e *GenericStatusFailedDependencyError) Error() string
func (*GenericStatusFailedDependencyError) Unwrap ¶
func (e *GenericStatusFailedDependencyError) Unwrap() error
type GenericUnauthorizedError ¶
type GenericUnauthorizedError struct {
// contains filtered or unexported fields
}
func (*GenericUnauthorizedError) Error ¶
func (e *GenericUnauthorizedError) Error() string
func (*GenericUnauthorizedError) Unwrap ¶
func (e *GenericUnauthorizedError) Unwrap() error
type GenericValidationError ¶
type GenericValidationError struct {
// contains filtered or unexported fields
}
GenericValidationError is returned when a meter is not found.
func (*GenericValidationError) Error ¶
func (e *GenericValidationError) Error() string
Error returns the error message.
func (*GenericValidationError) Unwrap ¶
func (e *GenericValidationError) Unwrap() error
Unwrap returns the wrapped error.
type ManagedModel ¶
type ManagedModel struct {
CreatedAt time.Time `json:"createdAt"`
// After creation the entity is considered updated.
UpdatedAt time.Time `json:"updatedAt"`
// Time of soft delete. If not null, the entity is considered deleted.
DeletedAt *time.Time `json:"deletedAt,omitempty"`
}
func (ManagedModel) Equal ¶
func (m ManagedModel) Equal(other ManagedModel) bool
func (ManagedModel) IsDeleted ¶
func (m ManagedModel) IsDeleted() bool
func (ManagedModel) IsDeletedAt ¶
func (m ManagedModel) IsDeletedAt(t time.Time) bool
func (ManagedModel) Validate ¶
func (m ManagedModel) Validate() error
type ManagedModelWithID ¶
type ManagedModelWithID struct {
ManagedModel `json:",inline" mapstructure:",squash"`
ID string `json:"id"`
}
func (ManagedModelWithID) Equal ¶
func (m ManagedModelWithID) Equal(other ManagedModelWithID) bool
func (ManagedModelWithID) GetID ¶
func (m ManagedModelWithID) GetID() string
func (ManagedModelWithID) Validate ¶
func (m ManagedModelWithID) Validate() error
type ManagedResource ¶
type ManagedResource struct {
NamespacedModel `json:",inline" mapstructure:",squash"`
ManagedModel `json:",inline" mapstructure:",squash"`
// ID is the unique identifier for Resource.
ID string `json:"id"`
Description *string `json:"description,omitempty"`
Name string `json:"name"`
}
func NewManagedResource ¶
func NewManagedResource(input ManagedResourceInput) ManagedResource
func (ManagedResource) Validate ¶
func (r ManagedResource) Validate() error
type ManagedResourceInput ¶
type ManagedResourceInput struct {
ID string
Namespace string
CreatedAt time.Time
UpdatedAt time.Time
DeletedAt *time.Time
Name string
Description *string
}
func (ManagedResourceInput) Validate ¶
func (r ManagedResourceInput) Validate() error
type ManagedUniqueResource ¶
type ManagedUniqueResource struct {
NamespacedModel `json:",inline" mapstructure:",squash"`
ManagedModel `json:",inline" mapstructure:",squash"`
// ID is the unique identifier for Resource.
ID string `json:"id"`
// Key is the unique key for Resource.
Key string `json:"key"`
}
type Metadata ¶
func NewMetadata ¶
type MetadataModel ¶
type MetadataModel struct {
Metadata Metadata `json:"metadata,omitempty"`
}
type NamespaceNotFoundError ¶
type NamespaceNotFoundError struct {
// contains filtered or unexported fields
}
IsNamespaceNotFoundError returns true if the error is a NamespaceNotFoundError.
func (*NamespaceNotFoundError) Error ¶
func (e *NamespaceNotFoundError) Error() string
func (*NamespaceNotFoundError) Unwrap ¶
func (e *NamespaceNotFoundError) Unwrap() error
Unwrap returns the wrapped error.
type NamespacedID ¶
func (NamespacedID) Validate ¶
func (i NamespacedID) Validate() error
type NamespacedModel ¶
type NamespacedModel struct {
Namespace string `json:"namespace"`
}
func (NamespacedModel) Validate ¶
func (m NamespacedModel) Validate() error
type Percentage ¶
type Percentage struct {
alpacadecimal.Decimal
}
func NewPercentage ¶
func NewPercentage[T float64 | int | alpacadecimal.Decimal](value T) Percentage
NewPercentage creates a new Percentage from a numeric value, representation: 50% is represented as 50
func (Percentage) Add ¶
func (p Percentage) Add(other Percentage) Percentage
func (Percentage) ApplyMarkupTo ¶
func (p Percentage) ApplyMarkupTo(value alpacadecimal.Decimal) alpacadecimal.Decimal
ApplyMarkupTo applies the percentage to a value as a markup, e.g: NewPercentage(50).ApplyMarkupTo(100) = 150
func (Percentage) ApplyTo ¶
func (p Percentage) ApplyTo(value alpacadecimal.Decimal) alpacadecimal.Decimal
ApplyTo applies the percentage to a value, e.g: NewPercentage(50).ApplyTo(100) = 50
func (Percentage) MarshalJSON ¶
func (p Percentage) MarshalJSON() ([]byte, error)
func (Percentage) String ¶
func (p Percentage) String() string
func (*Percentage) UnmarshalJSON ¶
func (p *Percentage) UnmarshalJSON(data []byte) error
type Problem ¶
type Problem interface {
Respond(w http.ResponseWriter)
Error() string
ProblemType() ProblemType
ProblemTitle() string
ProblemStatus() int
}
Problem is the RFC 7807 response body.
type ProblemType ¶
type ProblemType string
ProblemType contains a URI that identifies the problem type. This URI will, ideally, contain human-readable documentation for the problem when de-referenced.
type StatusProblem ¶
type StatusProblem struct {
Err error `json:"-"` // low-level runtime error
// Type is a URI reference that identifies the problem type.
Type ProblemType `json:"type"`
// Title is a short, human-readable summary of the problem type.
Title string `json:"title"`
// Status is the HTTP status code generated by the origin server for this occurrence of the problem.
Status int `json:"status"`
// Detail is a human-readable explanation specific to this occurrence of the problem.
Detail string `json:"detail,omitempty"`
// Instance is a URI reference that identifies the specific occurrence of the problem.
Instance string `json:"instance,omitempty"`
// Extension fields are allowed by spec, see https://datatracker.ietf.org/doc/html/rfc7807#section-3.2
Extensions map[string]interface{} `json:"extensions,omitempty"`
}
StatusProblem is the RFC 7807 response body without additional fields.
func NewStatusProblem ¶
func NewStatusProblem(ctx context.Context, err error, status int) *StatusProblem
NewStatusProblem will generate a problem for the provided HTTP status code. The Problem's Status field will be set to match the status argument, and the Title will be set to the default Go status text for that code.
func (*StatusProblem) Error ¶
func (p *StatusProblem) Error() string
func (*StatusProblem) ProblemStatus ¶
func (p *StatusProblem) ProblemStatus() int
func (*StatusProblem) ProblemTitle ¶
func (p *StatusProblem) ProblemTitle() string
func (*StatusProblem) ProblemType ¶
func (p *StatusProblem) ProblemType() ProblemType
func (*StatusProblem) RawError ¶
func (p *StatusProblem) RawError() error
func (*StatusProblem) Respond ¶
func (p *StatusProblem) Respond(w http.ResponseWriter)
Respond will render the problem as JSON to the provided ResponseWriter.
type Validator ¶
type Validator interface {
// Validate returns an error if the instance of the Validator is invalid.
Validate() error
}
type ValidatorFunc ¶
type VersionedModel ¶
type VersionedModel struct {
// Key is the unique identifier of the entity across its versions.
// Might be generated by the system or provided by the user.
Key string `json:"key,omitempty"`
// Version is the integer sequential version of the entity, starting from 1.
Version int `json:"version,omitempty"`
}
VersionedModel represents a versionable entity. With each new version the sequence is incremented while the key remains the same. Key + Version uniquely identifies an entity.