Regc.Manifest (regc v0.0.2)

View Source

Reusable manifest body and metadata operations.

get/3 retrieves and verifies manifest bytes. head/3 retrieves metadata; set require_digest: true to permit a verified GET fallback when a registry omits the digest header. Platform resolution uses exact matching by default; pass platform_match: :compatible_best for regclient-compatible ranking.

Summary

Functions

delete(client, reference, opts \\ [])

Deletes a manifest by digest. Deleting by tag is intentionally handled by Regc.Tag.delete/3.

get(client, reference, opts \\ [])
head(client, reference, opts \\ [])
put(client, reference, manifest, opts \\ [])

Pushes exact manifest bytes.

Functions

delete(client, reference, opts \\ [])

@spec delete(Regc.Client.t(), String.t() | Regc.Oci.Reference.t(), keyword()) ::
  :ok | {:error, Regc.Error.t()}

Deletes a manifest by digest. Deleting by tag is intentionally handled by Regc.Tag.delete/3.

get(client, reference, opts \\ [])

@spec get(Regc.Client.t(), String.t() | Regc.Oci.Reference.t(), keyword()) ::
  {:ok, Regc.Oci.Manifest.t()} | {:error, Regc.Error.t()}

head(client, reference, opts \\ [])

@spec head(Regc.Client.t(), String.t() | Regc.Oci.Reference.t(), keyword()) ::
  {:ok, Regc.Manifest.Metadata.t()} | {:error, Regc.Error.t()}

put(client, reference, manifest, opts \\ [])

@spec put(
  Regc.Client.t(),
  String.t() | Regc.Oci.Reference.t(),
  Regc.Oci.Manifest.t() | binary() | map(),
  keyword()
) :: {:ok, Regc.Manifest.Metadata.t()} | {:error, Regc.Error.t()}

Pushes exact manifest bytes.

A decoded Regc.Oci.Manifest preserves its original bytes and media type. Binary or map inputs require :media_type unless the map contains a mediaType field.