xerrors

Documentation

Index

• Variables
• func NewDSError(c echo.Context, code ErrCode) error
• func NewHTTPError(c echo.Context, errCode ErrCode, message ...string) error
• type ErrCode
  • func GenDSErrCodeResourceCountQuotaExceedNamespaceRepository(name string, limit int64) ErrCode
  • func GenDSErrCodeResourceCountQuotaExceedNamespaceTag(name string, limit int64) ErrCode
  • func GenDSErrCodeResourceCountQuotaExceedRepository(name string, limit int64) ErrCode
  • func GenDSErrCodeResourceNotFound(err error) ErrCode
  • func GenDSErrCodeResourceSizeQuotaExceedNamespace(name string, current, limit, increase int64) ErrCode
  • func GenDSErrCodeResourceSizeQuotaExceedRepository(name string, current, limit, increase int64) ErrCode
  • func (e *ErrCode) Detail(desc string) ErrCode
  • func (e ErrCode) Error() string

Variables

var (
	// DSErrCodeUnknown is a generic error that can be used as a last
	// resort if there is no situation-specific error message that can be used
	DSErrCodeUnknown = ErrCode{
		Code:           "UNKNOWN",
		Title:          "unknown error",
		Description:    `Generic error returned when the error does not have an API classification.`,
		HTTPStatusCode: http.StatusInternalServerError,
	}

	// DSErrCodeUnsupported is returned when an operation is not supported.
	DSErrCodeUnsupported = ErrCode{
		Code:           "UNSUPPORTED",
		Title:          "The operation is unsupported.",
		Description:    `The operation was unsupported due to a missing implementation or invalid set of parameters.`,
		HTTPStatusCode: http.StatusMethodNotAllowed,
	}

	// DSErrCodeUnauthorized is returned if a request requires
	// authentication.
	DSErrCodeUnauthorized = ErrCode{
		Code:           "UNAUTHORIZED",
		Title:          "authentication required",
		Description:    `The access controller was unable to authenticate the client. Often this will be accompanied by a Www-Authenticate HTTP response header indicating how to authenticate.`,
		HTTPStatusCode: http.StatusUnauthorized,
	}

	// DSErrCodeDenied is returned if a client does not have sufficient
	// permission to perform an action.
	DSErrCodeDenied = ErrCode{
		Code:           "DENIED",
		Title:          "requested access to the resource is denied",
		Description:    `The access controller denied access for the operation on a resource.`,
		HTTPStatusCode: http.StatusForbidden,
	}

	DSErrCodeResourceQuotaExceed = ErrCode{
		Code:           "DENIED",
		Title:          "requested access to the resource quota is exceed",
		Description:    `The access controller denied access for the operation on a resource.`,
		HTTPStatusCode: http.StatusForbidden,
	}

	// DSErrCodeUnavailable provides a common error to report unavailability
	// of a service or endpoint.
	DSErrCodeUnavailable = ErrCode{
		Code:           "UNAVAILABLE",
		Title:          "service unavailable",
		Description:    "Returned when a service is not available",
		HTTPStatusCode: http.StatusServiceUnavailable,
	}

	// DSErrCodeTooManyRequests is returned if a client attempts too many
	// times to contact a service endpoint.
	DSErrCodeTooManyRequests = ErrCode{
		Code:           "TOOMANYREQUESTS",
		Title:          "too many requests",
		Description:    `Returned when a client attempts to contact a service too many times`,
		HTTPStatusCode: http.StatusTooManyRequests,
	}

	// DSErrCodeDigestInvalid is returned when uploading a blob if the
	// provided digest does not match the blob contents.
	DSErrCodeDigestInvalid = ErrCode{
		Code:           "DIGEST_INVALID",
		Title:          "provided digest did not match uploaded content",
		Description:    `When a blob is uploaded, the registry will check that the content matches the digest provided by the client. The error may include a detail structure with the key "digest", including the invalid digest string. This error may also be returned when a manifest includes an invalid layer digest.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeSizeInvalid is returned when uploading a blob if the provided
	DSErrCodeSizeInvalid = ErrCode{
		Code:           "SIZE_INVALID",
		Title:          "provided length did not match content length",
		Description:    `When a layer is uploaded, the provided size will be checked against the uploaded content. If they do not match, this error will be returned.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeRangeInvalid is returned when uploading a blob if the provided
	// content range is invalid.
	DSErrCodeRangeInvalid = ErrCode{
		Code:           "RANGE_INVALID",
		Title:          "invalid content range",
		Description:    `When a layer is uploaded, the provided range is checked against the uploaded chunk. This error is returned if the range is out of order.`,
		HTTPStatusCode: http.StatusRequestedRangeNotSatisfiable,
	}

	// DSErrCodeNameInvalid is returned when the name in the manifest does not
	// match the provided name.
	DSErrCodeNameInvalid = ErrCode{
		Code:           "NAME_INVALID",
		Title:          "invalid repository name",
		Description:    `Invalid repository name encountered either during manifest validation or any API operation.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeTagInvalid is returned when the tag in the manifest does not
	// match the provided tag.
	DSErrCodeTagInvalid = ErrCode{
		Code:           "TAG_INVALID",
		Title:          "manifest tag did not match URI",
		Description:    `During a manifest upload, if the tag in the manifest does not match the uri tag, this error will be returned.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeNameUnknown when the repository name is not known.
	DSErrCodeNameUnknown = ErrCode{
		Code:           "NAME_UNKNOWN",
		Title:          "repository name not known to registry",
		Description:    `This is returned if the name used during an operation is unknown to the registry.`,
		HTTPStatusCode: http.StatusNotFound,
	}

	// DSErrCodeManifestUnknown returned when image manifest is unknown.
	DSErrCodeManifestUnknown = ErrCode{
		Code:           "MANIFEST_UNKNOWN",
		Title:          "manifest unknown",
		Description:    `This error is returned when the manifest, identified by name and tag is unknown to the repository.`,
		HTTPStatusCode: http.StatusNotFound,
	}

	// DSErrCodeManifestInvalid returned when an image manifest is invalid,
	// typically during a PUT operation. This error encompasses all errors
	// encountered during manifest validation that aren't signature errors.
	DSErrCodeManifestInvalid = ErrCode{
		Code:           "MANIFEST_INVALID",
		Title:          "manifest invalid",
		Description:    `During upload, manifests undergo several checks ensuring validity. If those checks fail, this error may be returned, unless a more specific error is included. The detail will contain information the failed validation.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeManifestUnverified is returned when the manifest fails
	// signature verification.
	DSErrCodeManifestUnverified = ErrCode{
		Code:           "MANIFEST_UNVERIFIED",
		Title:          "manifest failed signature verification",
		Description:    `During manifest upload, if the manifest fails signature verification, this error will be returned.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeManifestBlobUnknown is returned when a manifest blob is
	// unknown to the registry.
	DSErrCodeManifestBlobUnknown = ErrCode{
		Code:           "MANIFEST_BLOB_UNKNOWN",
		Title:          "blob unknown to registry",
		Description:    `This error may be returned when a manifest blob is unknown to the registry.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeManifestWithNamespace is returned when a manifest name is
	// invalid because it must contain a valid namespace.
	DSErrCodeManifestWithNamespace = ErrCode{
		Code:           "MANIFEST_WITH_NAMESPACE",
		Title:          "manifest name must contain a namespace",
		Description:    `This error may be returned when a manifest name is invalid because it is not contain a valid namespace, the image name must be like 'test.com/library/nginx:latest' or 'test.com/public/busybox:latest', but 'test.com/nginx:latest' is not allowed.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeBlobUnknown is returned when a blob is unknown to the
	// registry. This can happen when the manifest references a nonexistent
	// layer or the result is not found by a blob fetch.
	DSErrCodeBlobUnknown = ErrCode{
		Code:           "BLOB_UNKNOWN",
		Title:          "blob unknown to registry",
		Description:    `This error may be returned when a blob is unknown to the registry in a specified repository. This can be returned with a standard get or if a manifest references an unknown layer during upload.`,
		HTTPStatusCode: http.StatusNotFound,
	}

	// DSErrCodeBlobAssociated is returned when a blob upload is attempted
	// for a blob that is already referenced by another manifest.
	DSErrCodeBlobAssociated = ErrCode{
		Code:           "BLOB_ASSOCIATED",
		Title:          "blob associated with multiple manifests",
		Description:    `This error is returned when a blob is uploaded that is already referenced by another manifest in the repository.`,
		HTTPStatusCode: http.StatusBadRequest,
	}

	// DSErrCodeBlobUploadUnknown is returned when an upload is unknown.
	DSErrCodeBlobUploadUnknown = ErrCode{
		Code:           "BLOB_UPLOAD_UNKNOWN",
		Title:          "blob upload unknown to registry",
		Description:    `If a blob upload has been cancelled or was never started, this error code may be returned.`,
		HTTPStatusCode: http.StatusNotFound,
	}

	// DSErrCodeBlobUploadInvalid is returned when an upload is invalid.
	DSErrCodeBlobUploadInvalid = ErrCode{
		Code:           "BLOB_UPLOAD_INVALID",
		Title:          "blob upload invalid",
		Description:    `The blob upload encountered an error and can no longer proceed.`,
		HTTPStatusCode: http.StatusNotFound,
	}

	// DSErrCodeBlobUploadDigestMismatch is returned when an upload digest mismatch.
	DSErrCodeBlobUploadDigestMismatch = ErrCode{
		Code:           "BLOB_UPLOAD_DIGEST_MISMATCH",
		Title:          "blob upload digest mismatch",
		Description:    `The blob upload digest mismatch.`,
		HTTPStatusCode: http.StatusNotFound,
	}

	// DSErrCodePaginationNumberInvalid is returned when the `n` parameter is
	// not an integer, or `n` is negative.
	DSErrCodePaginationNumberInvalid = ErrCode{
		Code:           "PAGINATION_NUMBER_INVALID",
		Title:          "invalid number of results requested",
		Description:    `Returned when the "n" parameter (number of results to return) is not an integer, or "n" is negative.`,
		HTTPStatusCode: http.StatusBadRequest,
	}
)

var (
	// HTTPErrCodeOK is an OK error.
	HTTPErrCodeOK = ErrCode{HTTPStatusCode: http.StatusOK, Code: "OK", Title: "Ok"}
	// HTTPErrCodeCreated is a created error.
	HTTPErrCodeCreated = ErrCode{HTTPStatusCode: http.StatusCreated, Code: "CREATED", Title: "Created"}
	// HTTPErrCodeBadRequest is a bad request error.
	HTTPErrCodeBadRequest = ErrCode{HTTPStatusCode: http.StatusBadRequest, Code: "BAD_REQUEST", Title: "Bad request"}
	// HTTPErrCodeUnauthorized is an unauthorized error.
	HTTPErrCodeUnauthorized = ErrCode{HTTPStatusCode: http.StatusUnauthorized, Code: "UNAUTHORIZED", Title: "Unauthorized"}
	// HTTPErrCodeForbidden is a forbidden error.
	HTTPErrCodeForbidden = ErrCode{HTTPStatusCode: http.StatusForbidden, Code: "FORBIDDEN", Title: "Forbidden"}
	// HTTPErrCodeNotFound is a not found error.
	HTTPErrCodeNotFound = ErrCode{HTTPStatusCode: http.StatusNotFound, Code: "NOT_FOUND", Title: "Not found"}
	// HTTPErrCodeMethodNotAllowed is a method not allowed error.
	HTTPErrCodeMethodNotAllowed = ErrCode{HTTPStatusCode: http.StatusMethodNotAllowed, Code: "METHOD_NOT_ALLOWED", Title: "Method not allowed"}
	// HTTPErrCodeNotAcceptable is a not acceptable error.
	HTTPErrCodeNotAcceptable = ErrCode{HTTPStatusCode: http.StatusNotAcceptable, Code: "NOT_ACCEPTABLE", Title: "Not acceptable"}
	// HTTPErrCodeConflict is a conflict error.
	HTTPErrCodeConflict = ErrCode{HTTPStatusCode: http.StatusConflict, Code: "CONFLICT", Title: "Conflict"}
	// HTTPErrCodePaginationInvalid is a pagination invalid error.
	HTTPErrCodePaginationInvalid = ErrCode{HTTPStatusCode: http.StatusBadRequest, Code: "PAGINATION_INVALID", Title: "Pagination invalid"}
	// HTTPErrCodeInternalError is an internal error.
	HTTPErrCodeInternalError = ErrCode{HTTPStatusCode: http.StatusInternalServerError, Code: "INTERNAL_ERROR", Title: "Internal server error"}
	// HTTPErrCodeVerificationCodeInvalid is a verification code error.
	HTTPErrCodeVerificationCodeInvalid = ErrCode{HTTPStatusCode: http.StatusBadRequest, Code: "VERIFICATION_CODE_INVALID", Title: "Verification code invalid"}
)

Functions

func NewDSError

func NewDSError(c echo.Context, code ErrCode) error

NewDSError generates a distribution-spec error response

func NewHTTPError

func NewHTTPError(c echo.Context, errCode ErrCode, message ...string) error

NewHTTPError creates a new HTTPError instance.

Types

type ErrCode

type ErrCode struct {
	// Code provides a unique, string key, often capitalized with
	// underscores, to identify the error code. This value is used as the
	// keyed value when serializing api errors.
	Code string `json:"code" example:"UNAUTHORIZED"`

	// Title is a short, human readable description of the error condition
	// included in API responses.
	Title string `json:"title" example:"Authentication required"`

	// Description provides a complete account of the errors purpose, suitable
	// for use in documentation.
	Description string `` /* 195-byte string literal not displayed */

	// HTTPStatusCode provides the http status code that is associated with
	// this error condition.
	HTTPStatusCode int `json:"http_status_code" example:"401"`
}

ErrCode provides relevant information about a given error code.

func GenDSErrCodeResourceCountQuotaExceedNamespaceRepository

func GenDSErrCodeResourceCountQuotaExceedNamespaceRepository(name string, limit int64) ErrCode

GenDSErrCodeResourceCountQuotaExceedNamespaceRepository ...

func GenDSErrCodeResourceCountQuotaExceedNamespaceTag

func GenDSErrCodeResourceCountQuotaExceedNamespaceTag(name string, limit int64) ErrCode

GenDSErrCodeResourceCountQuotaExceedNamespaceTag ...

func GenDSErrCodeResourceCountQuotaExceedRepository

func GenDSErrCodeResourceCountQuotaExceedRepository(name string, limit int64) ErrCode

GenDSErrCodeResourceCountQuotaExceedRepository ...

func GenDSErrCodeResourceNotFound

func GenDSErrCodeResourceNotFound(err error) ErrCode

GenDSErrCodeResourceNotFound ...

func GenDSErrCodeResourceSizeQuotaExceedNamespace

func GenDSErrCodeResourceSizeQuotaExceedNamespace(name string, current, limit, increase int64) ErrCode

GenDSErrCodeResourceSizeQuotaExceedNamespace ...

func GenDSErrCodeResourceSizeQuotaExceedRepository

func GenDSErrCodeResourceSizeQuotaExceedRepository(name string, current, limit, increase int64) ErrCode

GenDSErrCodeResourceSizeQuotaExceedRepository ...

func (*ErrCode) Detail

func (e *ErrCode) Detail(desc string) ErrCode

Detail ...

func (ErrCode) Error

func (e ErrCode) Error() string

Error ...