resterror

Documentation

Index

• type Error
  • func (e *Error) Error() string
  • func (e *Error) String() string

Types

type Error

type Error struct {
	// The main error message. Should be short enough to fit in a phone's
	// alert box. Do not end this message with a period.
	Title string `json:"title"`

	// Id of this error message ("forbidden", "invalid_parameter", etc)
	ID string `json:"id"`

	// More information about what went wrong.
	Detail string `json:"detail,omitempty"`

	// Path to the object that's in error.
	Instance string `json:"instance,omitempty"`

	// Link to more information about the error (Zendesk, API docs, etc).
	Type string `json:"type,omitempty"`

	// HTTP status code of the error.
	Status int `json:"status,omitempty"`
}

Error implements the HTTP Problem spec laid out here: https://tools.ietf.org/html/rfc7807

func (*Error) Error

func (e *Error) Error() string

func (*Error) String

func (e *Error) String() string