Search or ask Docker

OCIDescriptor

OCIDescriptor schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

A descriptor struct containing digest, media type, and size, as defined in the OCI Content Descriptors Specification.
annotations

Type: object

Arbitrary metadata relating to the targeted content.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "Arbitrary metadata relating to the targeted content.",
  "example": {
    "com.docker.official-images.bashbrew.arch": "amd64",
    "org.opencontainers.image.base.digest": "sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8",
    "org.opencontainers.image.base.name": "scratch",
    "org.opencontainers.image.created": "2025-01-27T00:00:00Z",
    "org.opencontainers.image.revision": "9fabb4bad5138435b01857e2fe9363e2dc5f6a79",
    "org.opencontainers.image.source": "https://git.launchpad.net/cloud-images/+oci/ubuntu-base",
    "org.opencontainers.image.url": "https://hub.docker.com/_/ubuntu",
    "org.opencontainers.image.version": "24.04"
  },
  "type": "object",
  "x-nullable": true
}
artifactType

Type: string

ArtifactType is the IANA media type of this artifact.
All schema constraints and annotations
{
  "description": "ArtifactType is the IANA media type of this artifact.",
  "example": null,
  "type": "string",
  "x-nullable": true
}
data

Type: string

Data is an embedding of the targeted content. This is encoded as a base64 string when marshalled to JSON (automatically, by encoding/json). If present, Data can be used directly to avoid fetching the targeted content.
All schema constraints and annotations
{
  "description": "Data is an embedding of the targeted content. This is encoded as a base64\nstring when marshalled to JSON (automatically, by encoding/json). If\npresent, Data can be used directly to avoid fetching the targeted content.",
  "example": null,
  "type": "string",
  "x-nullable": true
}
digest

Type: string

The digest of the targeted content.
All schema constraints and annotations
{
  "description": "The digest of the targeted content.\n",
  "example": "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96",
  "type": "string"
}
mediaType

Type: string

The media type of the object this schema refers to.
All schema constraints and annotations
{
  "description": "The media type of the object this schema refers to.\n",
  "example": "application/vnd.oci.image.manifest.v1+json",
  "type": "string"
}
platform

Schema: OCIPlatform

size

Type: integer

The size in bytes of the blob.
All schema constraints and annotations
{
  "description": "The size in bytes of the blob.\n",
  "example": 424,
  "format": "int64",
  "type": "integer"
}
urls

Type: array

List of URLs from which this object MAY be downloaded.
Array item

Type: string

All schema constraints and annotations
{
  "format": "uri",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of URLs from which this object MAY be downloaded.",
  "items": {
    "format": "uri",
    "type": "string"
  },
  "type": "array",
  "x-nullable": true
}
All schema constraints and annotations
{
  "description": "A descriptor struct containing digest, media type, and size, as defined in\nthe [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).\n",
  "properties": {
    "annotations": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Arbitrary metadata relating to the targeted content.",
      "example": {
        "com.docker.official-images.bashbrew.arch": "amd64",
        "org.opencontainers.image.base.digest": "sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8",
        "org.opencontainers.image.base.name": "scratch",
        "org.opencontainers.image.created": "2025-01-27T00:00:00Z",
        "org.opencontainers.image.revision": "9fabb4bad5138435b01857e2fe9363e2dc5f6a79",
        "org.opencontainers.image.source": "https://git.launchpad.net/cloud-images/+oci/ubuntu-base",
        "org.opencontainers.image.url": "https://hub.docker.com/_/ubuntu",
        "org.opencontainers.image.version": "24.04"
      },
      "type": "object",
      "x-nullable": true
    },
    "artifactType": {
      "description": "ArtifactType is the IANA media type of this artifact.",
      "example": null,
      "type": "string",
      "x-nullable": true
    },
    "data": {
      "description": "Data is an embedding of the targeted content. This is encoded as a base64\nstring when marshalled to JSON (automatically, by encoding/json). If\npresent, Data can be used directly to avoid fetching the targeted content.",
      "example": null,
      "type": "string",
      "x-nullable": true
    },
    "digest": {
      "description": "The digest of the targeted content.\n",
      "example": "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96",
      "type": "string"
    },
    "mediaType": {
      "description": "The media type of the object this schema refers to.\n",
      "example": "application/vnd.oci.image.manifest.v1+json",
      "type": "string"
    },
    "platform": {
      "$ref": "#/components/schemas/OCIPlatform"
    },
    "size": {
      "description": "The size in bytes of the blob.\n",
      "example": 424,
      "format": "int64",
      "type": "integer"
    },
    "urls": {
      "description": "List of URLs from which this object MAY be downloaded.",
      "items": {
        "format": "uri",
        "type": "string"
      },
      "type": "array",
      "x-nullable": true
    }
  },
  "type": "object",
  "x-go-name": "Descriptor"
}