apierrors

Documentation

Index

• Variables
• type ErrInvalidPatch
  • func (e ErrInvalidPatch) Error() string

Variables

var (
	ErrAddDatasetAlreadyExists           = errors.New("forbidden - dataset already exists")
	ErrDatasetTypeInvalid                = errors.New("invalid dataset type")
	ErrTypeMismatch                      = errors.New("type mismatch")
	ErrAddUpdateDatasetBadRequest        = errors.New("failed to parse json body")
	ErrConflictUpdatingInstance          = errors.New("conflict updating instance resource")
	ErrDatasetNotFound                   = errors.New("dataset not found")
	ErrDeleteDatasetNotFound             = errors.New("delete dataset not found")
	ErrDeletePublishedDatasetForbidden   = errors.New("a published dataset cannot be deleted")
	ErrDimensionNodeNotFound             = errors.New("dimension node not found")
	ErrDimensionNotFound                 = errors.New("dimension not found")
	ErrDimensionOptionNotFound           = errors.New("dimension option not found")
	ErrDimensionsNotFound                = errors.New("dimensions not found")
	ErrEditionNotFound                   = errors.New("edition not found")
	ErrEditionsNotFound                  = errors.New("no editions were found")
	ErrIncorrectStateToDetach            = errors.New("only versions with a state of edition-confirmed or associated can be detached")
	ErrInstanceNotFound                  = errors.New("instance not found")
	ErrInstanceConflict                  = errors.New("instance does not match the expected eTag")
	ErrInternalServer                    = errors.New("internal error")
	ErrInsertedObservationsInvalidSyntax = errors.New("inserted observation request parameter not an integer")
	ErrInvalidQueryParameter             = errors.New("invalid query parameter")
	ErrInvalidBody                       = errors.New("invalid request body")
	ErrTooManyQueryParameters            = errors.New("too many query parameters have been provided")
	ErrMetadataVersionNotFound           = errors.New("version not found")
	ErrMissingJobProperties              = errors.New("missing job properties")
	ErrMissingParameters                 = errors.New("missing properties in JSON")
	ErrResourcePublished                 = errors.New("unable to update resource as it has been published")
	ErrResourceState                     = errors.New("incorrect resource state")
	ErrUnableToParseJSON                 = errors.New("failed to parse json body")
	ErrUnableToReadMessage               = errors.New("failed to read message body")
	ErrUnauthorised                      = errors.New("unauthorised access to API")
	ErrVersionMissingState               = errors.New("missing state from version")
	ErrVersionNotFound                   = errors.New("version not found")
	ErrInvalidVersion                    = errors.New("invalid version requested")
	ErrVersionAlreadyExists              = errors.New("an unpublished version of this dataset already exists")
	ErrNotFound                          = errors.New("not found")

	ErrExpectedResourceStateOfCreated          = errors.New("unable to update resource, expected resource to have a state of created")
	ErrExpectedResourceStateOfSubmitted        = errors.New("unable to update resource, expected resource to have a state of submitted")
	ErrExpectedResourceStateOfCompleted        = errors.New("unable to update resource, expected resource to have a state of completed")
	ErrExpectedResourceStateOfEditionConfirmed = errors.New("unable to update resource, expected resource to have a state of edition-confirmed")
	ErrExpectedResourceStateOfAssociated       = errors.New("unable to update resource, expected resource to have a state of associated")

	NotFoundMap = map[error]bool{
		ErrDatasetNotFound:         true,
		ErrDimensionNotFound:       true,
		ErrDimensionsNotFound:      true,
		ErrDimensionNodeNotFound:   true,
		ErrDimensionOptionNotFound: true,
		ErrEditionNotFound:         true,
		ErrInstanceNotFound:        true,
		ErrVersionNotFound:         true,
	}

	BadRequestMap = map[error]bool{
		ErrInsertedObservationsInvalidSyntax: true,
		ErrInvalidBody:                       true,
		ErrInvalidQueryParameter:             true,
		ErrTooManyQueryParameters:            true,
		ErrMissingJobProperties:              true,
		ErrMissingParameters:                 true,
		ErrUnableToParseJSON:                 true,
		ErrUnableToReadMessage:               true,
		ErrTypeMismatch:                      true,
		ErrDatasetTypeInvalid:                true,
		ErrInvalidVersion:                    true,
	}

	ConflictRequestMap = map[error]bool{
		ErrConflictUpdatingInstance: true,
		ErrInstanceConflict:         true,
	}

	ForbiddenMap = map[error]bool{
		ErrExpectedResourceStateOfCreated:          true,
		ErrExpectedResourceStateOfSubmitted:        true,
		ErrExpectedResourceStateOfCompleted:        true,
		ErrExpectedResourceStateOfEditionConfirmed: true,
		ErrExpectedResourceStateOfAssociated:       true,

		ErrResourcePublished: true,
	}
)

A list of error messages for Dataset API

Types

type ErrInvalidPatch

type ErrInvalidPatch struct {
	Msg string
}

ErrInvalidPatch represents an error due to an invalid HTTP PATCH request

func (ErrInvalidPatch) Error

func (e ErrInvalidPatch) Error() string