v1

Documentation

Index

• Constants
• type Descriptor
• type Manifest

Constants

const (
	// MediaTypeDescriptor specifies the media type for a content descriptor.
	MediaTypeDescriptor = "application/vnd.cncf.oras.artifact.descriptor.v1+json"

	// MediaTypeArtifactManifest specifies the media type for an ORAS artifact reference type manifest.
	MediaTypeArtifactManifest = "application/vnd.cncf.oras.artifact.manifest.v1+json"
)

const AnnotationArtifactCreated = "io.cncf.oras.artifact.created"

AnnotationArtifactCreated is the annotation key representing the UTC date and time on which the artifact was created, in RFC 3339 format. Reference: https://datatracker.ietf.org/doc/html/rfc3339#section-5.6

Types

type Descriptor

type Descriptor struct {
	// MediaType is the media type of the object this schema refers to.
	MediaType string `json:"mediaType,omitempty"`

	// ArtifactType is the artifact type of the object this schema refers to.
	//
	// When the descriptor is used for blobs, this property must be empty.
	ArtifactType string `json:"artifactType,omitempty"`

	// Digest is the digest of the targeted content.
	Digest digest.Digest `json:"digest"`

	// Size specifies the size in bytes of the blob.
	Size int64 `json:"size"`

	// URLs specifies a list of URLs from which this object MAY be downloaded
	URLs []string `json:"urls,omitempty"`

	// Annotations contains arbitrary metadata relating to the targeted content.
	Annotations map[string]string `json:"annotations,omitempty"`
}

Descriptor describes the disposition of targeted content.

type Manifest

type Manifest struct {
	// MediaType is the media type of the object this schema refers to.
	MediaType string `json:"mediaType"`

	// ArtifactType is the artifact type of the object this schema refers to.
	ArtifactType string `json:"artifactType"`

	// Blobs is a collection of blobs referenced by this manifest.
	Blobs []Descriptor `json:"blobs"`

	// Subject is an optional reference to any existing manifest within the repository.
	// When specified, the artifact is said to be dependent upon the referenced subject.
	Subject *Descriptor `json:"subject,omitempty"`

	// Annotations contains arbitrary metadata for the artifact manifest.
	Annotations map[string]string `json:"annotations,omitempty"`
}

Manifest describes an ORAS artifact. This structure provides `application/vnd.oras.artifact.manifest.v1+json` mediatype when marshalled to JSON.