Documentation
¶
Index ¶
Constants ¶
View Source
const ApiBasePathV1 = "api/v1"
ApiBasePathV1 is the base path for version 1 of the API.
View Source
const DeltaApiPath = "delta"
DeltaApiPath is the sub path for the delta creation API.
Variables ¶
View Source
var ErrImagesIdentical = APIError{InnerError: APIErrorInner{
Message: "artifacts are not compatible",
ErrorContext: "from and to image are identical",
}}
ErrImagesIdentical is returned by the API when the delta would have to be created from identical images.
View Source
var ErrImagesIncompatible = APIError{InnerError: APIErrorInner{
Message: "artifacts are not compatible",
ErrorContext: "cannot build a delta from images",
}}
ErrImagesIncompatible is returned by the API when the delta would have to be created from identical images.
Functions ¶
This section is empty.
Types ¶
type APIError ¶
type APIError struct {
InnerError APIErrorInner `json:"error"`
}
APIError wraps around the actual error for easier JSON parsing.
type APIErrorInner ¶
type APIErrorInner struct {
Code int `json:"code"`
Message string `json:"message,omitempty"`
ErrorContext string `json:"context,omitempty"`
}
APIErrorInner represents an error from the API.
func (APIErrorInner) Error ¶ added in v0.10.2
func (a APIErrorInner) Error() string
type ReadDeltaRequest ¶
type ReadDeltaResponse ¶
type SuccessResponse ¶
type SuccessResponse[T any] struct { Success T `json:"success"` }
Click to show internal directories.
Click to hide internal directories.