apiutil

Documentation

Index

• Variables
• func IsLibpodRequest(r *http.Request) bool
• func SupportedVersion(r *http.Request, condition string) (semver.Version, error)
• func SupportedVersionWithDefaults(r *http.Request) (semver.Version, error)

Variables

var (
	// ErrVersionNotGiven returned when version not given by client
	ErrVersionNotGiven = errors.New("version not given in URL path")
	// ErrVersionNotSupported returned when given version is too old
	ErrVersionNotSupported = errors.New("given version is not supported")
)

Functions

func IsLibpodRequest

func IsLibpodRequest(r *http.Request) bool

IsLibpodRequest returns true if the request related to a libpod endpoint (e.g., /v2/libpod/...).

func SupportedVersion

func SupportedVersion(r *http.Request, condition string) (semver.Version, error)

SupportedVersion validates that the version provided by client is included in the given condition https://github.com/blang/semver#ranges provides the details for writing conditions If a version is not given in URL path, ErrVersionNotGiven is returned

func SupportedVersionWithDefaults

func SupportedVersionWithDefaults(r *http.Request) (semver.Version, error)

SupportedVersionWithDefaults validates that the version provided by client valid is supported by server minimal API version <= client path version <= maximum API version focused on the endpoint tree from URL