Expand description
OCI distribution spec types and definitions.
The Open Container Initiative Distribution Specification (a.k.a. “OCI Distribution Spec”) defines an API protocol to facilitate and standardize the distribution of content.
While OCI Image is the most prominent, the specification is designed to be agnostic of content types. Concepts such as “manifests” and “digests”, are currently defined in the Open Container Initiative Image Format Specification (a.k.a. “OCI Image Spec”).
To support other artifact types, please see the Open Container Initiative Artifact Authors Guide (a.k.a. “OCI Artifacts”).
Structs§
- Error
Info - Describes a server error returned from a registry.
- Error
Info Builder - Builder for
ErrorInfo. - Error
Response - ErrorResponse is returned by a registry on an invalid request.
- Error
Response Builder - Builder for
ErrorResponse. - Reference
- Reference provides a general type to represent any way of referencing images within an OCI registry.
- Repository
List - RepositoryList returns a catalog of repositories maintained on the registry.
- Repository
List Builder - Builder for
RepositoryList. - TagList
- A list of tags for a given repository.
- TagList
Builder - Builder for
TagList.
Enums§
- Error
Code - Unique identifier representing error code.
- Parse
Error - Reasons that parsing a string as a Reference can fail.
Constants§
- ERR_
REGISTRY - The string returned by and ErrorResponse error.
- VERSION_
DEV - Indicates development branch. Releases will be empty string.
- VERSION_
MAJOR - API incompatible changes.
- VERSION_
MINOR - Changing functionality in a backwards-compatible manner
- VERSION_
PATCH - Backwards-compatible bug fixes.
Functions§
- version
- Retrieve the version as string representation.