Search or ask Docker

ImageManifestSummary

ImageManifestSummary schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

ImageManifestSummary represents a summary of an image manifest.
AttestationData

Type: object

The image data for the attestation manifest. This field is only populated when Kind is "attestation".
For · required

Type: string

The digest of the image manifest that this attestation is for.
All schema constraints and annotations
{
  "description": "The digest of the image manifest that this attestation is for.\n",
  "example": "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "The image data for the attestation manifest.\nThis field is only populated when Kind is \"attestation\".\n",
  "properties": {
    "For": {
      "description": "The digest of the image manifest that this attestation is for.\n",
      "example": "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f",
      "type": "string"
    }
  },
  "required": [
    "For"
  ],
  "type": "object",
  "x-nullable": true,
  "x-omitempty": true
}
Available · required

Type: boolean

Indicates whether all the child content (image config, layers) is fully available locally.
All schema constraints and annotations
{
  "description": "Indicates whether all the child content (image config, layers) is fully available locally.",
  "example": true,
  "type": "boolean"
}
Descriptor · required

Schema: OCIDescriptor

ID · required

Type: string

ID is the content-addressable ID of an image and is the same as the digest of the image manifest.
All schema constraints and annotations
{
  "description": "ID is the content-addressable ID of an image and is the same as the\ndigest of the image manifest.\n",
  "example": "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f",
  "type": "string"
}
ImageData

Type: object

The image data for the image manifest. This field is only populated when Kind is "image".
Containers · required

Type: array

The IDs of the containers that are using this image.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "The IDs of the containers that are using this image.\n",
  "example": [
    "ede54ee1fda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c7430",
    "abadbce344c096744d8d6071a90d474d28af8f1034b5ea9fb03c3f4bfc6d005e"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Identity

Schema: Identity

Identity holds information about the identity and origin of this image. For image list responses, this can duplicate Build/Pull fields across image manifests, because those parts are image-level metadata.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Identity",
  "description": "Identity holds information about the identity and origin of this image.\nFor image list responses, this can duplicate Build/Pull fields across\nimage manifests, because those parts are image-level metadata.\n",
  "x-nullable": true
}
Platform · required

Schema: OCIPlatform

OCI platform of the image. This will be the platform specified in the manifest descriptor from the index/manifest list. If it's not available, it will be obtained from the image config.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/OCIPlatform",
  "description": "OCI platform of the image. This will be the platform specified in the\nmanifest descriptor from the index/manifest list.\nIf it's not available, it will be obtained from the image config.\n"
}
Size · required

Type: object

Unpacked · required

Type: integer

Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image content that's directly usable by the containers running this image. It's independent of the distributable content - e.g. the image might still have an unpacked data that's still used by some container even when the distributable/compressed content is already gone.
All schema constraints and annotations
{
  "description": "Unpacked is the size (in bytes) of the locally unpacked\n(uncompressed) image content that's directly usable by the containers\nrunning this image.\nIt's independent of the distributable content - e.g.\nthe image might still have an unpacked data that's still used by\nsome container even when the distributable/compressed content is\nalready gone.\n",
  "example": 3987495,
  "format": "int64",
  "type": "integer"
}
All schema constraints and annotations
{
  "properties": {
    "Unpacked": {
      "description": "Unpacked is the size (in bytes) of the locally unpacked\n(uncompressed) image content that's directly usable by the containers\nrunning this image.\nIt's independent of the distributable content - e.g.\nthe image might still have an unpacked data that's still used by\nsome container even when the distributable/compressed content is\nalready gone.\n",
      "example": 3987495,
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "Unpacked"
  ],
  "type": "object",
  "x-nullable": false
}
All schema constraints and annotations
{
  "description": "The image data for the image manifest.\nThis field is only populated when Kind is \"image\".\n",
  "properties": {
    "Containers": {
      "description": "The IDs of the containers that are using this image.\n",
      "example": [
        "ede54ee1fda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c7430",
        "abadbce344c096744d8d6071a90d474d28af8f1034b5ea9fb03c3f4bfc6d005e"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Identity": {
      "$ref": "#/components/schemas/Identity",
      "description": "Identity holds information about the identity and origin of this image.\nFor image list responses, this can duplicate Build/Pull fields across\nimage manifests, because those parts are image-level metadata.\n",
      "x-nullable": true
    },
    "Platform": {
      "$ref": "#/components/schemas/OCIPlatform",
      "description": "OCI platform of the image. This will be the platform specified in the\nmanifest descriptor from the index/manifest list.\nIf it's not available, it will be obtained from the image config.\n"
    },
    "Size": {
      "properties": {
        "Unpacked": {
          "description": "Unpacked is the size (in bytes) of the locally unpacked\n(uncompressed) image content that's directly usable by the containers\nrunning this image.\nIt's independent of the distributable content - e.g.\nthe image might still have an unpacked data that's still used by\nsome container even when the distributable/compressed content is\nalready gone.\n",
          "example": 3987495,
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "Unpacked"
      ],
      "type": "object",
      "x-nullable": false
    }
  },
  "required": [
    "Platform",
    "Containers",
    "Size"
  ],
  "type": "object",
  "x-nullable": true,
  "x-omitempty": true
}
Kind · required

Type: string

The kind of the manifest.

kinddescription
imageImage manifest that can be used to start a container.
attestationAttestation manifest produced by the Buildkit builder for a specific image manifest.
All schema constraints and annotations
{
  "description": "The kind of the manifest.\n\nkind         | description\n-------------|-----------------------------------------------------------\nimage        | Image manifest that can be used to start a container.\nattestation  | Attestation manifest produced by the Buildkit builder for a specific image manifest.\n",
  "enum": [
    "image",
    "attestation",
    "unknown"
  ],
  "example": "image",
  "type": "string"
}
Size · required

Type: object

Content · required

Type: integer

Content is the size (in bytes) of all the locally present content in the content store (e.g. image config, layers) referenced by this manifest and its children. This only includes blobs in the content store.
All schema constraints and annotations
{
  "description": "Content is the size (in bytes) of all the locally present\ncontent in the content store (e.g. image config, layers)\nreferenced by this manifest and its children.\nThis only includes blobs in the content store.\n",
  "example": 3987495,
  "format": "int64",
  "type": "integer"
}
Total · required

Type: integer

Total is the total size (in bytes) of all the locally present data (both distributable and non-distributable) that's related to this manifest and its children. This equal to the sum of [Content] size AND all the sizes in the [Size] struct present in the Kind-specific data struct. For example, for an image kind (Kind == "image") this would include the size of the image content and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]).
All schema constraints and annotations
{
  "description": "Total is the total size (in bytes) of all the locally present\ndata (both distributable and non-distributable) that's related to\nthis manifest and its children.\nThis equal to the sum of [Content] size AND all the sizes in the\n[Size] struct present in the Kind-specific data struct.\nFor example, for an image kind (Kind == \"image\")\nthis would include the size of the image content and unpacked\nimage snapshots ([Size.Content] + [ImageData.Size.Unpacked]).\n",
  "example": 8213251,
  "format": "int64",
  "type": "integer"
}
All schema constraints and annotations
{
  "properties": {
    "Content": {
      "description": "Content is the size (in bytes) of all the locally present\ncontent in the content store (e.g. image config, layers)\nreferenced by this manifest and its children.\nThis only includes blobs in the content store.\n",
      "example": 3987495,
      "format": "int64",
      "type": "integer"
    },
    "Total": {
      "description": "Total is the total size (in bytes) of all the locally present\ndata (both distributable and non-distributable) that's related to\nthis manifest and its children.\nThis equal to the sum of [Content] size AND all the sizes in the\n[Size] struct present in the Kind-specific data struct.\nFor example, for an image kind (Kind == \"image\")\nthis would include the size of the image content and unpacked\nimage snapshots ([Size.Content] + [ImageData.Size.Unpacked]).\n",
      "example": 8213251,
      "format": "int64",
      "type": "integer"
    }
  },
  "required": [
    "Content",
    "Total"
  ],
  "type": "object",
  "x-nullable": false
}
All schema constraints and annotations
{
  "description": "ImageManifestSummary represents a summary of an image manifest.\n",
  "properties": {
    "AttestationData": {
      "description": "The image data for the attestation manifest.\nThis field is only populated when Kind is \"attestation\".\n",
      "properties": {
        "For": {
          "description": "The digest of the image manifest that this attestation is for.\n",
          "example": "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f",
          "type": "string"
        }
      },
      "required": [
        "For"
      ],
      "type": "object",
      "x-nullable": true,
      "x-omitempty": true
    },
    "Available": {
      "description": "Indicates whether all the child content (image config, layers) is fully available locally.",
      "example": true,
      "type": "boolean"
    },
    "Descriptor": {
      "$ref": "#/components/schemas/OCIDescriptor"
    },
    "ID": {
      "description": "ID is the content-addressable ID of an image and is the same as the\ndigest of the image manifest.\n",
      "example": "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f",
      "type": "string"
    },
    "ImageData": {
      "description": "The image data for the image manifest.\nThis field is only populated when Kind is \"image\".\n",
      "properties": {
        "Containers": {
          "description": "The IDs of the containers that are using this image.\n",
          "example": [
            "ede54ee1fda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c7430",
            "abadbce344c096744d8d6071a90d474d28af8f1034b5ea9fb03c3f4bfc6d005e"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "Identity": {
          "$ref": "#/components/schemas/Identity",
          "description": "Identity holds information about the identity and origin of this image.\nFor image list responses, this can duplicate Build/Pull fields across\nimage manifests, because those parts are image-level metadata.\n",
          "x-nullable": true
        },
        "Platform": {
          "$ref": "#/components/schemas/OCIPlatform",
          "description": "OCI platform of the image. This will be the platform specified in the\nmanifest descriptor from the index/manifest list.\nIf it's not available, it will be obtained from the image config.\n"
        },
        "Size": {
          "properties": {
            "Unpacked": {
              "description": "Unpacked is the size (in bytes) of the locally unpacked\n(uncompressed) image content that's directly usable by the containers\nrunning this image.\nIt's independent of the distributable content - e.g.\nthe image might still have an unpacked data that's still used by\nsome container even when the distributable/compressed content is\nalready gone.\n",
              "example": 3987495,
              "format": "int64",
              "type": "integer"
            }
          },
          "required": [
            "Unpacked"
          ],
          "type": "object",
          "x-nullable": false
        }
      },
      "required": [
        "Platform",
        "Containers",
        "Size"
      ],
      "type": "object",
      "x-nullable": true,
      "x-omitempty": true
    },
    "Kind": {
      "description": "The kind of the manifest.\n\nkind         | description\n-------------|-----------------------------------------------------------\nimage        | Image manifest that can be used to start a container.\nattestation  | Attestation manifest produced by the Buildkit builder for a specific image manifest.\n",
      "enum": [
        "image",
        "attestation",
        "unknown"
      ],
      "example": "image",
      "type": "string"
    },
    "Size": {
      "properties": {
        "Content": {
          "description": "Content is the size (in bytes) of all the locally present\ncontent in the content store (e.g. image config, layers)\nreferenced by this manifest and its children.\nThis only includes blobs in the content store.\n",
          "example": 3987495,
          "format": "int64",
          "type": "integer"
        },
        "Total": {
          "description": "Total is the total size (in bytes) of all the locally present\ndata (both distributable and non-distributable) that's related to\nthis manifest and its children.\nThis equal to the sum of [Content] size AND all the sizes in the\n[Size] struct present in the Kind-specific data struct.\nFor example, for an image kind (Kind == \"image\")\nthis would include the size of the image content and unpacked\nimage snapshots ([Size.Content] + [ImageData.Size.Unpacked]).\n",
          "example": 8213251,
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "Content",
        "Total"
      ],
      "type": "object",
      "x-nullable": false
    }
  },
  "required": [
    "ID",
    "Descriptor",
    "Available",
    "Size",
    "Kind"
  ],
  "type": "object",
  "x-go-name": "ManifestSummary"
}