problem

Documentation

Index

• Variables
• type ForbiddenProblem
  • func (f ForbiddenProblem) Error() string
  • func (f ForbiddenProblem) Send(w http.ResponseWriter)
• type Input
  • func (i Input) Error() string
  • func (i Input) Send(w http.ResponseWriter)
• type ParamError
• type Payload
  • func (p Payload) Send(w http.ResponseWriter)
  • func (p *Payload) Validate() error
• type Problem
• type UnexpectedProblem
  • func (u UnexpectedProblem) Error() string
  • func (u UnexpectedProblem) Send(w http.ResponseWriter)

Variables

var (
	ErrInvalidPayload    = errors.New("invalid problem")
	ErrInvalidParameters = errors.New("invalid parameters")
	ErrUnexpected        = errors.New("unexpected error")
	ErrForbidden         = errors.New("forbidden")
)

Differents problem issues

var DefaultForbidden = ForbiddenProblem{
	Payload: &Payload{
		Type:   "about:blank",
		Title:  "Your are missing credentials or have insufficient rights",
		Status: http.StatusForbidden,
	},
}

var DefaultInput = Input{
	Payload: &Payload{
		Type:   "about:blank",
		Title:  "Your parameters didn't validate",
		Status: http.StatusBadRequest,
	},
}

var DefaultUnexpected = UnexpectedProblem{
	Payload: &Payload{
		Type:   "about:blank",
		Title:  "An unexpected error occured decoding request",
		Status: http.StatusInternalServerError,
	},
}

Types

type ForbiddenProblem

type ForbiddenProblem struct {
	*Payload
}

ForbiddenProblem problem

func (ForbiddenProblem) Error

func (f ForbiddenProblem) Error() string

Error implements error interface

func (ForbiddenProblem) Send

func (f ForbiddenProblem) Send(w http.ResponseWriter)

Send implements Problem interface

type Input

type Input struct {
	*Payload
	InvalidParams []ParamError `json:"invalid_parameters"`
}

Input extends a standard problem problem with invalid parameters

func (Input) Error

func (i Input) Error() string

Error implement error interface

func (Input) Send

func (i Input) Send(w http.ResponseWriter)

Send implements Problem interface

type ParamError

type ParamError struct {
	Field  string `json:"field"`
	Reason string `json:"reason"`
}

ParamError describe an error on a specific parameter

type Payload

type Payload struct {
	Type   string `json:"type"`
	Title  string `json:"title"`
	Status int    `json:"status"`
}

Payload represents most basic problem of an `application/problem+json` response.

func (Payload) Send

func (p Payload) Send(w http.ResponseWriter)

Send implements Problem

func (*Payload) Validate

func (p *Payload) Validate() error

Validate provides validation and sets default values if needed

type Problem

type Problem interface {
	Send(http.ResponseWriter)
}

type UnexpectedProblem

type UnexpectedProblem struct {
	*Payload
}

UnexpectedProblem problem

func (UnexpectedProblem) Error

func (u UnexpectedProblem) Error() string

Error implements error interface

func (UnexpectedProblem) Send

func (u UnexpectedProblem) Send(w http.ResponseWriter)

Send implements Problem interface