api

Documentation

Index

• Variables
• type Error
  • func InvalidApiVersion(v string) Error
  • func (e Error) Render(w http.ResponseWriter, statuscode int)
• type ErrorSource

Variables

var BadImageIDError = Error{
	ID:     "bad_request",
	Code:   "bad_request",
	Status: "400",
	Title:  "Bad Request",
	Detail: "The image ID provided is not valid",
	Source: ErrorSource{
		Parameter: "image_id",
	},
}

var CannotDeleteImageWithInstancesError = Error{
	ID:     "unprocessable_entity",
	Code:   "unprocessable_entity",
	Status: "422",
	Title:  "Image Has Instances",
	Detail: "Cannot delete an image that has instances",
}

var ImageNotFoundError = Error{
	ID:     "resource_not_found",
	Code:   "resource_not_found",
	Status: "404",
	Title:  "Image Not Found",
	Detail: "The image you specified could not be found",
}

var InternalServerError = Error{
	ID:     "internal_server_error",
	Code:   "internal_server_error",
	Status: "500",
	Title:  "Internal Server Error",
	Detail: "Something went wrong :(",
}

var InvalidJSONError = Error{
	ID:     "bad_request",
	Code:   "bad_request",
	Status: "400",
	Title:  "Invalid JSON",
	Detail: "Your JSON is malformed",
}

var MissingApiVersion = Error{
	ID:     "missing_api_version_header",
	Code:   "missing_api_version_header",
	Status: "400",
	Title:  "Missing API Version Header",
	Detail: "No API version specified in Draupnir-Version header",
}

var NotFoundError = Error{
	ID:     "resource_not_found",
	Code:   "resource_not_found",
	Status: "404",
	Title:  "Resource Not Found",
	Detail: "The resource you requested could not be found",
}

var OauthError = Error{
	ID:     "bad_request",
	Code:   "bad_request",
	Status: "400",
	Title:  "OAuth Error",
	Detail: "There was some oauth error",
}

var UnauthorizedError = Error{
	ID:     "unauthorized",
	Code:   "unauthorized",
	Status: "401",
	Title:  "Unauthorized",
	Detail: "You do not have permission to view this resource",
}

var UnreadyImageError = Error{
	ID:     "unprocessable_entity",
	Code:   "unprocessable_entity",
	Status: "422",
	Title:  "Image Not Ready",
	Detail: "The specified image is not ready to be used",
	Source: ErrorSource{
		Parameter: "image_id",
	},
}

Types

type Error

type Error struct {
	ID     string      `json:"id"`
	Status string      `json:"status"`
	Code   string      `json:"code"`
	Title  string      `json:"title"`
	Detail string      `json:"detail"`
	Source ErrorSource `json:"source,omitempty"`
}

func InvalidApiVersion

func InvalidApiVersion(v string) Error

func (Error) Render

func (e Error) Render(w http.ResponseWriter, statuscode int)

type ErrorSource

type ErrorSource struct {
	Pointer   string `json:"pointer,omitempty"`
	Parameter string `json:"parameter,omitempty"`
}