Merge pull request #43300 from thaJeztah/api_update_imageinspect_docs
API: improve swagger and go-doc for ImageInspect structs
This commit is contained in:
commit
3c6c9fa180
297
api/swagger.yaml
297
api/swagger.yaml
|
@ -1109,14 +1109,18 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
description: "Configuration for a container that is portable between hosts"
|
description: |
|
||||||
|
Configuration for a container that is portable between hosts.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
Hostname:
|
Hostname:
|
||||||
description: "The hostname to use for the container, as a valid RFC 1123 hostname."
|
description: |
|
||||||
|
The hostname to use for the container, as a valid RFC 1123 hostname.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "439f4e91bd1d"
|
||||||
Domainname:
|
Domainname:
|
||||||
description: "The domain name to use for the container."
|
description: |
|
||||||
|
The domain name to use for the container.
|
||||||
type: "string"
|
type: "string"
|
||||||
User:
|
User:
|
||||||
description: "The user that commands are run as inside the container."
|
description: "The user that commands are run as inside the container."
|
||||||
|
@ -1139,11 +1143,16 @@ definitions:
|
||||||
|
|
||||||
`{"<port>/<tcp|udp|sctp>": {}}`
|
`{"<port>/<tcp|udp|sctp>": {}}`
|
||||||
type: "object"
|
type: "object"
|
||||||
|
x-nullable: true
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "object"
|
type: "object"
|
||||||
enum:
|
enum:
|
||||||
- {}
|
- {}
|
||||||
default: {}
|
default: {}
|
||||||
|
example: {
|
||||||
|
"80/tcp": {},
|
||||||
|
"443/tcp": {}
|
||||||
|
}
|
||||||
Tty:
|
Tty:
|
||||||
description: |
|
description: |
|
||||||
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
||||||
|
@ -1165,21 +1174,29 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
||||||
Cmd:
|
Cmd:
|
||||||
description: |
|
description: |
|
||||||
Command to run specified as a string or an array of strings.
|
Command to run specified as a string or an array of strings.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh"]
|
||||||
Healthcheck:
|
Healthcheck:
|
||||||
$ref: "#/definitions/HealthConfig"
|
$ref: "#/definitions/HealthConfig"
|
||||||
ArgsEscaped:
|
ArgsEscaped:
|
||||||
description: "Command is already escaped (Windows only)"
|
description: "Command is already escaped (Windows only)"
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
default: false
|
||||||
|
example: false
|
||||||
|
x-nullable: true
|
||||||
Image:
|
Image:
|
||||||
description: |
|
description: |
|
||||||
The name of the image to use when creating the container/
|
The name (or reference) of the image to use when creating the container,
|
||||||
|
or which was used when the container was created.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "example-image:1.0"
|
||||||
Volumes:
|
Volumes:
|
||||||
description: |
|
description: |
|
||||||
An object mapping mount point paths inside the container to empty
|
An object mapping mount point paths inside the container to empty
|
||||||
|
@ -1193,6 +1210,7 @@ definitions:
|
||||||
WorkingDir:
|
WorkingDir:
|
||||||
description: "The working directory for commands to run in."
|
description: "The working directory for commands to run in."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "/public/"
|
||||||
Entrypoint:
|
Entrypoint:
|
||||||
description: |
|
description: |
|
||||||
The entry point for the container as a string or an array of strings.
|
The entry point for the container as a string or an array of strings.
|
||||||
|
@ -1203,38 +1221,50 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
NetworkDisabled:
|
NetworkDisabled:
|
||||||
description: "Disable networking for the container."
|
description: "Disable networking for the container."
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
x-nullable: true
|
||||||
MacAddress:
|
MacAddress:
|
||||||
description: "MAC address of the container."
|
description: "MAC address of the container."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
OnBuild:
|
OnBuild:
|
||||||
description: |
|
description: |
|
||||||
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
Labels:
|
Labels:
|
||||||
description: "User-defined key/value metadata."
|
description: "User-defined key/value metadata."
|
||||||
type: "object"
|
type: "object"
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
com.example.some-label: "some-value"
|
||||||
|
com.example.some-other-label: "some-other-value"
|
||||||
StopSignal:
|
StopSignal:
|
||||||
description: |
|
description: |
|
||||||
Signal to stop a container as a string or unsigned integer.
|
Signal to stop a container as a string or unsigned integer.
|
||||||
type: "string"
|
type: "string"
|
||||||
default: "SIGTERM"
|
example: "SIGTERM"
|
||||||
|
x-nullable: true
|
||||||
StopTimeout:
|
StopTimeout:
|
||||||
description: "Timeout to stop a container in seconds."
|
description: "Timeout to stop a container in seconds."
|
||||||
type: "integer"
|
type: "integer"
|
||||||
default: 10
|
default: 10
|
||||||
|
x-nullable: true
|
||||||
Shell:
|
Shell:
|
||||||
description: |
|
description: |
|
||||||
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh", "-c"]
|
||||||
|
|
||||||
NetworkingConfig:
|
NetworkingConfig:
|
||||||
description: |
|
description: |
|
||||||
|
@ -1491,107 +1521,219 @@ definitions:
|
||||||
example: "4443"
|
example: "4443"
|
||||||
|
|
||||||
GraphDriverData:
|
GraphDriverData:
|
||||||
description: "Information about a container's graph driver."
|
description: |
|
||||||
|
Information about the storage driver used to store the container's and
|
||||||
|
image's filesystem.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Name, Data]
|
required: [Name, Data]
|
||||||
properties:
|
properties:
|
||||||
Name:
|
Name:
|
||||||
|
description: "Name of the storage driver."
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "overlay2"
|
||||||
Data:
|
Data:
|
||||||
|
description: |
|
||||||
|
Low-level storage metadata, provided as key/value pairs.
|
||||||
|
|
||||||
|
This information is driver-specific, and depends on the storage-driver
|
||||||
|
in use, and should be used for informational purposes only.
|
||||||
type: "object"
|
type: "object"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: {
|
||||||
|
"MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged",
|
||||||
|
"UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff",
|
||||||
|
"WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
|
||||||
|
}
|
||||||
|
|
||||||
Image:
|
ImageInspect:
|
||||||
|
description: |
|
||||||
|
Information about an image in the local image cache.
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
|
||||||
- Id
|
|
||||||
- Parent
|
|
||||||
- Comment
|
|
||||||
- Created
|
|
||||||
- Container
|
|
||||||
- DockerVersion
|
|
||||||
- Author
|
|
||||||
- Architecture
|
|
||||||
- Os
|
|
||||||
- Size
|
|
||||||
- VirtualSize
|
|
||||||
- GraphDriver
|
|
||||||
- RootFS
|
|
||||||
properties:
|
properties:
|
||||||
Id:
|
Id:
|
||||||
|
description: |
|
||||||
|
ID is the content-addressable ID of an image.
|
||||||
|
|
||||||
|
This identified is a content-addressable digest calculated from the
|
||||||
|
image's configuration (which includes the digests of layers used by
|
||||||
|
the image).
|
||||||
|
|
||||||
|
Note that this digest differs from the `RepoDigests` below, which
|
||||||
|
holds digests of image manifests that reference the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710"
|
||||||
RepoTags:
|
RepoTags:
|
||||||
|
description: |
|
||||||
|
List of image names/tags in the local image cache that reference this
|
||||||
|
image.
|
||||||
|
|
||||||
|
Multiple image tags can refer to the same imagem and this list may be
|
||||||
|
empty if no tags reference the image, in which case the image is
|
||||||
|
"untagged", in which case it can still be referenced by its ID.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example:1.0"
|
||||||
|
- "example:latest"
|
||||||
|
- "example:stable"
|
||||||
|
- "internal.registry.example.com:5000/example:1.0"
|
||||||
RepoDigests:
|
RepoDigests:
|
||||||
|
description: |
|
||||||
|
List of content-addressable digests of locally available image manifests
|
||||||
|
that the image is referenced from. Multiple manifests can refer to the
|
||||||
|
same image.
|
||||||
|
|
||||||
|
These digests are usually only available if the image was either pulled
|
||||||
|
from a registry, or if the image was pushed to a registry, which is when
|
||||||
|
the manifest is generated and its digest calculated.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb"
|
||||||
|
- "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
|
||||||
Parent:
|
Parent:
|
||||||
|
description: |
|
||||||
|
ID of the parent image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty and
|
||||||
|
is only set for images that were built/created locally. This field
|
||||||
|
is empty if the image was pulled from an image registry.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Comment:
|
Comment:
|
||||||
|
description: |
|
||||||
|
Optional message that was set when committing or importing the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Created:
|
Created:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was created, formatted in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "2022-02-04T21:20:12.497794809Z"
|
||||||
Container:
|
Container:
|
||||||
|
description: |
|
||||||
|
The ID of the container that was used to create the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "65974bc86f1770ae4bff79f651ebdbce166ae9aada632ee3fa9af3a264911735"
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
DockerVersion:
|
DockerVersion:
|
||||||
|
description: |
|
||||||
|
The version of Docker that was used to build the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "20.10.7"
|
||||||
Author:
|
Author:
|
||||||
|
description: |
|
||||||
|
Name of the author that was specified when committing the image, or as
|
||||||
|
specified through MAINTAINER (deprecated) in the Dockerfile.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Config:
|
Config:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
Architecture:
|
Architecture:
|
||||||
|
description: |
|
||||||
|
Hardware CPU architecture that the image runs on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "arm"
|
||||||
|
Variant:
|
||||||
|
description: |
|
||||||
|
CPU architecture variant (presently ARM-only).
|
||||||
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: "v7"
|
||||||
Os:
|
Os:
|
||||||
|
description: |
|
||||||
|
Operating System the image is built to run on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "linux"
|
||||||
OsVersion:
|
OsVersion:
|
||||||
|
description: |
|
||||||
|
Operating System version the image is built to run on (especially
|
||||||
|
for Windows).
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ""
|
||||||
|
x-nullable: true
|
||||||
Size:
|
Size:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
VirtualSize:
|
VirtualSize:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
|
|
||||||
|
In versions of Docker before v1.10, this field was calculated from
|
||||||
|
the image itself and all of its parent images. Docker v1.10 and up
|
||||||
|
store images self-contained, and no longer use a parent-chain, making
|
||||||
|
this field an equivalent of the Size field.
|
||||||
|
|
||||||
|
This field is kept for backward compatibility, but may be removed in
|
||||||
|
a future version of the API.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
GraphDriver:
|
GraphDriver:
|
||||||
$ref: "#/definitions/GraphDriverData"
|
$ref: "#/definitions/GraphDriverData"
|
||||||
RootFS:
|
RootFS:
|
||||||
|
description: |
|
||||||
|
Information about the image's RootFS, including the layer IDs.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Type]
|
required: [Type]
|
||||||
properties:
|
properties:
|
||||||
Type:
|
Type:
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "layers"
|
||||||
Layers:
|
Layers:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
||||||
|
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
||||||
BaseLayer:
|
BaseLayer:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: ""
|
||||||
Metadata:
|
Metadata:
|
||||||
|
description: |
|
||||||
|
Additional metadata of the image in the local cache. This information
|
||||||
|
is local to the daemon, and not part of the image itself.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
LastTagTime:
|
LastTagTime:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was last tagged in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
|
|
||||||
|
This information is only available if the image was tagged locally,
|
||||||
|
and omitted otherwise.
|
||||||
type: "string"
|
type: "string"
|
||||||
format: "dateTime"
|
format: "dateTime"
|
||||||
|
example: "2022-02-28T14:40:02.623929178Z"
|
||||||
|
x-nullable: true
|
||||||
ImageSummary:
|
ImageSummary:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
@ -5292,22 +5434,22 @@ definitions:
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
example: 3987495
|
example: 3987495
|
||||||
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
|
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
|
||||||
# urls:
|
# urls:
|
||||||
# description: |
|
# description: |
|
||||||
# List of URLs from which this object MAY be downloaded.
|
# List of URLs from which this object MAY be downloaded.
|
||||||
# type: "array"
|
# type: "array"
|
||||||
# items:
|
# items:
|
||||||
# type: "string"
|
# type: "string"
|
||||||
# format: "uri"
|
# format: "uri"
|
||||||
# annotations:
|
# annotations:
|
||||||
# description: |
|
# description: |
|
||||||
# Arbitrary metadata relating to the targeted content.
|
# Arbitrary metadata relating to the targeted content.
|
||||||
# type: "object"
|
# type: "object"
|
||||||
# additionalProperties:
|
# additionalProperties:
|
||||||
# type: "string"
|
# type: "string"
|
||||||
# platform:
|
# platform:
|
||||||
# $ref: "#/definitions/OCIPlatform"
|
# $ref: "#/definitions/OCIPlatform"
|
||||||
|
|
||||||
OCIPlatform:
|
OCIPlatform:
|
||||||
type: "object"
|
type: "object"
|
||||||
|
@ -7725,84 +7867,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: "No error"
|
description: "No error"
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/definitions/Image"
|
$ref: "#/definitions/ImageInspect"
|
||||||
examples:
|
|
||||||
application/json:
|
|
||||||
Id: "sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c"
|
|
||||||
Container: "cb91e48a60d01f1e27028b4fc6819f4f290b3cf12496c8176ec714d0d390984a"
|
|
||||||
Comment: ""
|
|
||||||
Os: "linux"
|
|
||||||
Architecture: "amd64"
|
|
||||||
Parent: "sha256:91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
ContainerConfig:
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
StdinOnce: false
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
User: ""
|
|
||||||
WorkingDir: ""
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
Labels:
|
|
||||||
com.example.license: "GPL"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/sh"
|
|
||||||
- "-c"
|
|
||||||
- "#(nop) LABEL com.example.vendor=Acme com.example.license=GPL com.example.version=1.0"
|
|
||||||
DockerVersion: "1.9.0-dev"
|
|
||||||
VirtualSize: 188359297
|
|
||||||
Size: 0
|
|
||||||
Author: ""
|
|
||||||
Created: "2015-09-10T08:30:53.26995814Z"
|
|
||||||
GraphDriver:
|
|
||||||
Name: "aufs"
|
|
||||||
Data: {}
|
|
||||||
RepoDigests:
|
|
||||||
- "localhost:5000/test/busybox/example@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf"
|
|
||||||
RepoTags:
|
|
||||||
- "example:1.0"
|
|
||||||
- "example:latest"
|
|
||||||
- "example:stable"
|
|
||||||
Config:
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
StdinOnce: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/bash"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Labels:
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.license: "GPL"
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
WorkingDir: ""
|
|
||||||
User: ""
|
|
||||||
RootFS:
|
|
||||||
Type: "layers"
|
|
||||||
Layers:
|
|
||||||
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
|
||||||
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
|
||||||
404:
|
404:
|
||||||
description: "No such image"
|
description: "No such image"
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -3,15 +3,21 @@ package types
|
||||||
// This file was generated by the swagger tool.
|
// This file was generated by the swagger tool.
|
||||||
// Editing this file might prove futile when you re-run the swagger generate command
|
// Editing this file might prove futile when you re-run the swagger generate command
|
||||||
|
|
||||||
// GraphDriverData Information about a container's graph driver.
|
// GraphDriverData Information about the storage driver used to store the container's and
|
||||||
|
// image's filesystem.
|
||||||
|
//
|
||||||
// swagger:model GraphDriverData
|
// swagger:model GraphDriverData
|
||||||
type GraphDriverData struct {
|
type GraphDriverData struct {
|
||||||
|
|
||||||
// data
|
// Low-level storage metadata, provided as key/value pairs.
|
||||||
|
//
|
||||||
|
// This information is driver-specific, and depends on the storage-driver
|
||||||
|
// in use, and should be used for informational purposes only.
|
||||||
|
//
|
||||||
// Required: true
|
// Required: true
|
||||||
Data map[string]string `json:"Data"`
|
Data map[string]string `json:"Data"`
|
||||||
|
|
||||||
// name
|
// Name of the storage driver.
|
||||||
// Required: true
|
// Required: true
|
||||||
Name string `json:"Name"`
|
Name string `json:"Name"`
|
||||||
}
|
}
|
||||||
|
|
|
@ -27,30 +27,112 @@ type RootFS struct {
|
||||||
// ImageInspect contains response of Engine API:
|
// ImageInspect contains response of Engine API:
|
||||||
// GET "/images/{name:.*}/json"
|
// GET "/images/{name:.*}/json"
|
||||||
type ImageInspect struct {
|
type ImageInspect struct {
|
||||||
ID string `json:"Id"`
|
// ID is the content-addressable ID of an image.
|
||||||
RepoTags []string
|
//
|
||||||
RepoDigests []string
|
// This identified is a content-addressable digest calculated from the
|
||||||
Parent string
|
// image's configuration (which includes the digests of layers used by
|
||||||
Comment string
|
// the image).
|
||||||
Created string
|
//
|
||||||
Container string
|
// Note that this digest differs from the `RepoDigests` below, which
|
||||||
|
// holds digests of image manifests that reference the image.
|
||||||
|
ID string `json:"Id"`
|
||||||
|
|
||||||
|
// RepoTags is a list of image names/tags in the local image cache that
|
||||||
|
// reference this image.
|
||||||
|
//
|
||||||
|
// Multiple image tags can refer to the same imagem and this list may be
|
||||||
|
// empty if no tags reference the image, in which case the image is
|
||||||
|
// "untagged", in which case it can still be referenced by its ID.
|
||||||
|
RepoTags []string
|
||||||
|
|
||||||
|
// RepoDigests is a list of content-addressable digests of locally available
|
||||||
|
// image manifests that the image is referenced from. Multiple manifests can
|
||||||
|
// refer to the same image.
|
||||||
|
//
|
||||||
|
// These digests are usually only available if the image was either pulled
|
||||||
|
// from a registry, or if the image was pushed to a registry, which is when
|
||||||
|
// the manifest is generated and its digest calculated.
|
||||||
|
RepoDigests []string
|
||||||
|
|
||||||
|
// Parent is the ID of the parent image.
|
||||||
|
//
|
||||||
|
// Depending on how the image was created, this field may be empty and
|
||||||
|
// is only set for images that were built/created locally. This field
|
||||||
|
// is empty if the image was pulled from an image registry.
|
||||||
|
Parent string
|
||||||
|
|
||||||
|
// Comment is an optional message that can be set when committing or
|
||||||
|
// importing the image.
|
||||||
|
Comment string
|
||||||
|
|
||||||
|
// Created is the date and time at which the image was created, formatted in
|
||||||
|
// RFC 3339 nano-seconds (time.RFC3339Nano).
|
||||||
|
Created string
|
||||||
|
|
||||||
|
// Container is the ID of the container that was used to create the image.
|
||||||
|
//
|
||||||
|
// Depending on how the image was created, this field may be empty.
|
||||||
|
Container string
|
||||||
|
|
||||||
|
// ContainerConfig is the configuration of the container that was committed
|
||||||
|
// into the image.
|
||||||
ContainerConfig *container.Config
|
ContainerConfig *container.Config
|
||||||
DockerVersion string
|
|
||||||
Author string
|
// DockerVersion is the version of Docker that was used to build the image.
|
||||||
Config *container.Config
|
//
|
||||||
Architecture string
|
// Depending on how the image was created, this field may be empty.
|
||||||
Variant string `json:",omitempty"`
|
DockerVersion string
|
||||||
Os string
|
|
||||||
OsVersion string `json:",omitempty"`
|
// Author is the name of the author that was specified when committing the
|
||||||
Size int64
|
// image, or as specified through MAINTAINER (deprecated) in the Dockerfile.
|
||||||
VirtualSize int64
|
Author string
|
||||||
GraphDriver GraphDriverData
|
Config *container.Config
|
||||||
RootFS RootFS
|
|
||||||
Metadata ImageMetadata
|
// Architecture is the hardware CPU architecture that the image runs on.
|
||||||
|
Architecture string
|
||||||
|
|
||||||
|
// Variant is the CPU architecture variant (presently ARM-only).
|
||||||
|
Variant string `json:",omitempty"`
|
||||||
|
|
||||||
|
// OS is the Operating System the image is built to run on.
|
||||||
|
Os string
|
||||||
|
|
||||||
|
// OsVersion is the version of the Operating System the image is built to
|
||||||
|
// run on (especially for Windows).
|
||||||
|
OsVersion string `json:",omitempty"`
|
||||||
|
|
||||||
|
// Size is the total size of the image including all layers it is composed of.
|
||||||
|
Size int64
|
||||||
|
|
||||||
|
// VirtualSize is the total size of the image including all layers it is
|
||||||
|
// composed of.
|
||||||
|
//
|
||||||
|
// In versions of Docker before v1.10, this field was calculated from
|
||||||
|
// the image itself and all of its parent images. Docker v1.10 and up
|
||||||
|
// store images self-contained, and no longer use a parent-chain, making
|
||||||
|
// this field an equivalent of the Size field.
|
||||||
|
//
|
||||||
|
// This field is kept for backward compatibility, but may be removed in
|
||||||
|
// a future version of the API.
|
||||||
|
VirtualSize int64 // TODO(thaJeztah): deprecate this field
|
||||||
|
|
||||||
|
// GraphDriver holds information about the storage driver used to store the
|
||||||
|
// container's and image's filesystem.
|
||||||
|
GraphDriver GraphDriverData
|
||||||
|
|
||||||
|
// RootFS contains information about the image's RootFS, including the
|
||||||
|
// layer IDs.
|
||||||
|
RootFS RootFS
|
||||||
|
|
||||||
|
// Metadata of the image in the local cache.
|
||||||
|
//
|
||||||
|
// This information is local to the daemon, and not part of the image itself.
|
||||||
|
Metadata ImageMetadata
|
||||||
}
|
}
|
||||||
|
|
||||||
// ImageMetadata contains engine-local data about the image
|
// ImageMetadata contains engine-local data about the image
|
||||||
type ImageMetadata struct {
|
type ImageMetadata struct {
|
||||||
|
// LastTagTime is the date and time at which the image was last tagged.
|
||||||
LastTagTime time.Time `json:",omitempty"`
|
LastTagTime time.Time `json:",omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -1016,14 +1016,18 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
description: "Configuration for a container that is portable between hosts"
|
description: |
|
||||||
|
Configuration for a container that is portable between hosts.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
Hostname:
|
Hostname:
|
||||||
description: "The hostname to use for the container, as a valid RFC 1123 hostname."
|
description: |
|
||||||
|
The hostname to use for the container, as a valid RFC 1123 hostname.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "439f4e91bd1d"
|
||||||
Domainname:
|
Domainname:
|
||||||
description: "The domain name to use for the container."
|
description: |
|
||||||
|
The domain name to use for the container.
|
||||||
type: "string"
|
type: "string"
|
||||||
User:
|
User:
|
||||||
description: "The user that commands are run as inside the container."
|
description: "The user that commands are run as inside the container."
|
||||||
|
@ -1046,11 +1050,16 @@ definitions:
|
||||||
|
|
||||||
`{"<port>/<tcp|udp|sctp>": {}}`
|
`{"<port>/<tcp|udp|sctp>": {}}`
|
||||||
type: "object"
|
type: "object"
|
||||||
|
x-nullable: true
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "object"
|
type: "object"
|
||||||
enum:
|
enum:
|
||||||
- {}
|
- {}
|
||||||
default: {}
|
default: {}
|
||||||
|
example: {
|
||||||
|
"80/tcp": {},
|
||||||
|
"443/tcp": {}
|
||||||
|
}
|
||||||
Tty:
|
Tty:
|
||||||
description: |
|
description: |
|
||||||
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
||||||
|
@ -1072,21 +1081,29 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
||||||
Cmd:
|
Cmd:
|
||||||
description: |
|
description: |
|
||||||
Command to run specified as a string or an array of strings.
|
Command to run specified as a string or an array of strings.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh"]
|
||||||
Healthcheck:
|
Healthcheck:
|
||||||
$ref: "#/definitions/HealthConfig"
|
$ref: "#/definitions/HealthConfig"
|
||||||
ArgsEscaped:
|
ArgsEscaped:
|
||||||
description: "Command is already escaped (Windows only)"
|
description: "Command is already escaped (Windows only)"
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
default: false
|
||||||
|
example: false
|
||||||
|
x-nullable: true
|
||||||
Image:
|
Image:
|
||||||
description: |
|
description: |
|
||||||
The name of the image to use when creating the container/
|
The name (or reference) of the image to use when creating the container,
|
||||||
|
or which was used when the container was created.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "example-image:1.0"
|
||||||
Volumes:
|
Volumes:
|
||||||
description: |
|
description: |
|
||||||
An object mapping mount point paths inside the container to empty
|
An object mapping mount point paths inside the container to empty
|
||||||
|
@ -1100,6 +1117,7 @@ definitions:
|
||||||
WorkingDir:
|
WorkingDir:
|
||||||
description: "The working directory for commands to run in."
|
description: "The working directory for commands to run in."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "/public/"
|
||||||
Entrypoint:
|
Entrypoint:
|
||||||
description: |
|
description: |
|
||||||
The entry point for the container as a string or an array of strings.
|
The entry point for the container as a string or an array of strings.
|
||||||
|
@ -1110,38 +1128,50 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
NetworkDisabled:
|
NetworkDisabled:
|
||||||
description: "Disable networking for the container."
|
description: "Disable networking for the container."
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
x-nullable: true
|
||||||
MacAddress:
|
MacAddress:
|
||||||
description: "MAC address of the container."
|
description: "MAC address of the container."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
OnBuild:
|
OnBuild:
|
||||||
description: |
|
description: |
|
||||||
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
Labels:
|
Labels:
|
||||||
description: "User-defined key/value metadata."
|
description: "User-defined key/value metadata."
|
||||||
type: "object"
|
type: "object"
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
com.example.some-label: "some-value"
|
||||||
|
com.example.some-other-label: "some-other-value"
|
||||||
StopSignal:
|
StopSignal:
|
||||||
description: |
|
description: |
|
||||||
Signal to stop a container as a string or unsigned integer.
|
Signal to stop a container as a string or unsigned integer.
|
||||||
type: "string"
|
type: "string"
|
||||||
default: "SIGTERM"
|
example: "SIGTERM"
|
||||||
|
x-nullable: true
|
||||||
StopTimeout:
|
StopTimeout:
|
||||||
description: "Timeout to stop a container in seconds."
|
description: "Timeout to stop a container in seconds."
|
||||||
type: "integer"
|
type: "integer"
|
||||||
default: 10
|
default: 10
|
||||||
|
x-nullable: true
|
||||||
Shell:
|
Shell:
|
||||||
description: |
|
description: |
|
||||||
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh", "-c"]
|
||||||
|
|
||||||
NetworkingConfig:
|
NetworkingConfig:
|
||||||
description: |
|
description: |
|
||||||
|
@ -1398,107 +1428,219 @@ definitions:
|
||||||
example: "4443"
|
example: "4443"
|
||||||
|
|
||||||
GraphDriverData:
|
GraphDriverData:
|
||||||
description: "Information about a container's graph driver."
|
description: |
|
||||||
|
Information about the storage driver used to store the container's and
|
||||||
|
image's filesystem.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Name, Data]
|
required: [Name, Data]
|
||||||
properties:
|
properties:
|
||||||
Name:
|
Name:
|
||||||
|
description: "Name of the storage driver."
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "overlay2"
|
||||||
Data:
|
Data:
|
||||||
|
description: |
|
||||||
|
Low-level storage metadata, provided as key/value pairs.
|
||||||
|
|
||||||
|
This information is driver-specific, and depends on the storage-driver
|
||||||
|
in use, and should be used for informational purposes only.
|
||||||
type: "object"
|
type: "object"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: {
|
||||||
|
"MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged",
|
||||||
|
"UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff",
|
||||||
|
"WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
|
||||||
|
}
|
||||||
|
|
||||||
Image:
|
ImageInspect:
|
||||||
|
description: |
|
||||||
|
Information about an image in the local image cache.
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
|
||||||
- Id
|
|
||||||
- Parent
|
|
||||||
- Comment
|
|
||||||
- Created
|
|
||||||
- Container
|
|
||||||
- DockerVersion
|
|
||||||
- Author
|
|
||||||
- Architecture
|
|
||||||
- Os
|
|
||||||
- Size
|
|
||||||
- VirtualSize
|
|
||||||
- GraphDriver
|
|
||||||
- RootFS
|
|
||||||
properties:
|
properties:
|
||||||
Id:
|
Id:
|
||||||
|
description: |
|
||||||
|
ID is the content-addressable ID of an image.
|
||||||
|
|
||||||
|
This identified is a content-addressable digest calculated from the
|
||||||
|
image's configuration (which includes the digests of layers used by
|
||||||
|
the image).
|
||||||
|
|
||||||
|
Note that this digest differs from the `RepoDigests` below, which
|
||||||
|
holds digests of image manifests that reference the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710"
|
||||||
RepoTags:
|
RepoTags:
|
||||||
|
description: |
|
||||||
|
List of image names/tags in the local image cache that reference this
|
||||||
|
image.
|
||||||
|
|
||||||
|
Multiple image tags can refer to the same imagem and this list may be
|
||||||
|
empty if no tags reference the image, in which case the image is
|
||||||
|
"untagged", in which case it can still be referenced by its ID.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example:1.0"
|
||||||
|
- "example:latest"
|
||||||
|
- "example:stable"
|
||||||
|
- "internal.registry.example.com:5000/example:1.0"
|
||||||
RepoDigests:
|
RepoDigests:
|
||||||
|
description: |
|
||||||
|
List of content-addressable digests of locally available image manifests
|
||||||
|
that the image is referenced from. Multiple manifests can refer to the
|
||||||
|
same image.
|
||||||
|
|
||||||
|
These digests are usually only available if the image was either pulled
|
||||||
|
from a registry, or if the image was pushed to a registry, which is when
|
||||||
|
the manifest is generated and its digest calculated.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb"
|
||||||
|
- "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
|
||||||
Parent:
|
Parent:
|
||||||
|
description: |
|
||||||
|
ID of the parent image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty and
|
||||||
|
is only set for images that were built/created locally. This field
|
||||||
|
is empty if the image was pulled from an image registry.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Comment:
|
Comment:
|
||||||
|
description: |
|
||||||
|
Optional message that was set when committing or importing the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Created:
|
Created:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was created, formatted in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "2022-02-04T21:20:12.497794809Z"
|
||||||
Container:
|
Container:
|
||||||
|
description: |
|
||||||
|
The ID of the container that was used to create the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "65974bc86f1770ae4bff79f651ebdbce166ae9aada632ee3fa9af3a264911735"
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
DockerVersion:
|
DockerVersion:
|
||||||
|
description: |
|
||||||
|
The version of Docker that was used to build the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "20.10.7"
|
||||||
Author:
|
Author:
|
||||||
|
description: |
|
||||||
|
Name of the author that was specified when committing the image, or as
|
||||||
|
specified through MAINTAINER (deprecated) in the Dockerfile.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Config:
|
Config:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
Architecture:
|
Architecture:
|
||||||
|
description: |
|
||||||
|
Hardware CPU architecture that the image runs on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "arm"
|
||||||
|
Variant:
|
||||||
|
description: |
|
||||||
|
CPU architecture variant (presently ARM-only).
|
||||||
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: "v7"
|
||||||
Os:
|
Os:
|
||||||
|
description: |
|
||||||
|
Operating System the image is built to run on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "linux"
|
||||||
OsVersion:
|
OsVersion:
|
||||||
|
description: |
|
||||||
|
Operating System version the image is built to run on (especially
|
||||||
|
for Windows).
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ""
|
||||||
|
x-nullable: true
|
||||||
Size:
|
Size:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
VirtualSize:
|
VirtualSize:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
|
|
||||||
|
In versions of Docker before v1.10, this field was calculated from
|
||||||
|
the image itself and all of its parent images. Docker v1.10 and up
|
||||||
|
store images self-contained, and no longer use a parent-chain, making
|
||||||
|
this field an equivalent of the Size field.
|
||||||
|
|
||||||
|
This field is kept for backward compatibility, but may be removed in
|
||||||
|
a future version of the API.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
GraphDriver:
|
GraphDriver:
|
||||||
$ref: "#/definitions/GraphDriverData"
|
$ref: "#/definitions/GraphDriverData"
|
||||||
RootFS:
|
RootFS:
|
||||||
|
description: |
|
||||||
|
Information about the image's RootFS, including the layer IDs.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Type]
|
required: [Type]
|
||||||
properties:
|
properties:
|
||||||
Type:
|
Type:
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "layers"
|
||||||
Layers:
|
Layers:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
||||||
|
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
||||||
BaseLayer:
|
BaseLayer:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: ""
|
||||||
Metadata:
|
Metadata:
|
||||||
|
description: |
|
||||||
|
Additional metadata of the image in the local cache. This information
|
||||||
|
is local to the daemon, and not part of the image itself.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
LastTagTime:
|
LastTagTime:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was last tagged in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
|
|
||||||
|
This information is only available if the image was tagged locally,
|
||||||
|
and omitted otherwise.
|
||||||
type: "string"
|
type: "string"
|
||||||
format: "dateTime"
|
format: "dateTime"
|
||||||
|
example: "2022-02-28T14:40:02.623929178Z"
|
||||||
|
x-nullable: true
|
||||||
ImageSummary:
|
ImageSummary:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
@ -7214,84 +7356,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: "No error"
|
description: "No error"
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/definitions/Image"
|
$ref: "#/definitions/ImageInspect"
|
||||||
examples:
|
|
||||||
application/json:
|
|
||||||
Id: "sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c"
|
|
||||||
Container: "cb91e48a60d01f1e27028b4fc6819f4f290b3cf12496c8176ec714d0d390984a"
|
|
||||||
Comment: ""
|
|
||||||
Os: "linux"
|
|
||||||
Architecture: "amd64"
|
|
||||||
Parent: "sha256:91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
ContainerConfig:
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
StdinOnce: false
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
User: ""
|
|
||||||
WorkingDir: ""
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
Labels:
|
|
||||||
com.example.license: "GPL"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/sh"
|
|
||||||
- "-c"
|
|
||||||
- "#(nop) LABEL com.example.vendor=Acme com.example.license=GPL com.example.version=1.0"
|
|
||||||
DockerVersion: "1.9.0-dev"
|
|
||||||
VirtualSize: 188359297
|
|
||||||
Size: 0
|
|
||||||
Author: ""
|
|
||||||
Created: "2015-09-10T08:30:53.26995814Z"
|
|
||||||
GraphDriver:
|
|
||||||
Name: "aufs"
|
|
||||||
Data: {}
|
|
||||||
RepoDigests:
|
|
||||||
- "localhost:5000/test/busybox/example@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf"
|
|
||||||
RepoTags:
|
|
||||||
- "example:1.0"
|
|
||||||
- "example:latest"
|
|
||||||
- "example:stable"
|
|
||||||
Config:
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
StdinOnce: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/bash"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Labels:
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.license: "GPL"
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
WorkingDir: ""
|
|
||||||
User: ""
|
|
||||||
RootFS:
|
|
||||||
Type: "layers"
|
|
||||||
Layers:
|
|
||||||
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
|
||||||
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
|
||||||
404:
|
404:
|
||||||
description: "No such image"
|
description: "No such image"
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -1077,14 +1077,18 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
description: "Configuration for a container that is portable between hosts"
|
description: |
|
||||||
|
Configuration for a container that is portable between hosts.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
Hostname:
|
Hostname:
|
||||||
description: "The hostname to use for the container, as a valid RFC 1123 hostname."
|
description: |
|
||||||
|
The hostname to use for the container, as a valid RFC 1123 hostname.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "439f4e91bd1d"
|
||||||
Domainname:
|
Domainname:
|
||||||
description: "The domain name to use for the container."
|
description: |
|
||||||
|
The domain name to use for the container.
|
||||||
type: "string"
|
type: "string"
|
||||||
User:
|
User:
|
||||||
description: "The user that commands are run as inside the container."
|
description: "The user that commands are run as inside the container."
|
||||||
|
@ -1107,11 +1111,16 @@ definitions:
|
||||||
|
|
||||||
`{"<port>/<tcp|udp|sctp>": {}}`
|
`{"<port>/<tcp|udp|sctp>": {}}`
|
||||||
type: "object"
|
type: "object"
|
||||||
|
x-nullable: true
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "object"
|
type: "object"
|
||||||
enum:
|
enum:
|
||||||
- {}
|
- {}
|
||||||
default: {}
|
default: {}
|
||||||
|
example: {
|
||||||
|
"80/tcp": {},
|
||||||
|
"443/tcp": {}
|
||||||
|
}
|
||||||
Tty:
|
Tty:
|
||||||
description: |
|
description: |
|
||||||
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
||||||
|
@ -1133,21 +1142,29 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
||||||
Cmd:
|
Cmd:
|
||||||
description: |
|
description: |
|
||||||
Command to run specified as a string or an array of strings.
|
Command to run specified as a string or an array of strings.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh"]
|
||||||
Healthcheck:
|
Healthcheck:
|
||||||
$ref: "#/definitions/HealthConfig"
|
$ref: "#/definitions/HealthConfig"
|
||||||
ArgsEscaped:
|
ArgsEscaped:
|
||||||
description: "Command is already escaped (Windows only)"
|
description: "Command is already escaped (Windows only)"
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
default: false
|
||||||
|
example: false
|
||||||
|
x-nullable: true
|
||||||
Image:
|
Image:
|
||||||
description: |
|
description: |
|
||||||
The name of the image to use when creating the container/
|
The name (or reference) of the image to use when creating the container,
|
||||||
|
or which was used when the container was created.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "example-image:1.0"
|
||||||
Volumes:
|
Volumes:
|
||||||
description: |
|
description: |
|
||||||
An object mapping mount point paths inside the container to empty
|
An object mapping mount point paths inside the container to empty
|
||||||
|
@ -1161,6 +1178,7 @@ definitions:
|
||||||
WorkingDir:
|
WorkingDir:
|
||||||
description: "The working directory for commands to run in."
|
description: "The working directory for commands to run in."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "/public/"
|
||||||
Entrypoint:
|
Entrypoint:
|
||||||
description: |
|
description: |
|
||||||
The entry point for the container as a string or an array of strings.
|
The entry point for the container as a string or an array of strings.
|
||||||
|
@ -1171,38 +1189,50 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
NetworkDisabled:
|
NetworkDisabled:
|
||||||
description: "Disable networking for the container."
|
description: "Disable networking for the container."
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
x-nullable: true
|
||||||
MacAddress:
|
MacAddress:
|
||||||
description: "MAC address of the container."
|
description: "MAC address of the container."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
OnBuild:
|
OnBuild:
|
||||||
description: |
|
description: |
|
||||||
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
Labels:
|
Labels:
|
||||||
description: "User-defined key/value metadata."
|
description: "User-defined key/value metadata."
|
||||||
type: "object"
|
type: "object"
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
com.example.some-label: "some-value"
|
||||||
|
com.example.some-other-label: "some-other-value"
|
||||||
StopSignal:
|
StopSignal:
|
||||||
description: |
|
description: |
|
||||||
Signal to stop a container as a string or unsigned integer.
|
Signal to stop a container as a string or unsigned integer.
|
||||||
type: "string"
|
type: "string"
|
||||||
default: "SIGTERM"
|
example: "SIGTERM"
|
||||||
|
x-nullable: true
|
||||||
StopTimeout:
|
StopTimeout:
|
||||||
description: "Timeout to stop a container in seconds."
|
description: "Timeout to stop a container in seconds."
|
||||||
type: "integer"
|
type: "integer"
|
||||||
default: 10
|
default: 10
|
||||||
|
x-nullable: true
|
||||||
Shell:
|
Shell:
|
||||||
description: |
|
description: |
|
||||||
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh", "-c"]
|
||||||
|
|
||||||
NetworkingConfig:
|
NetworkingConfig:
|
||||||
description: |
|
description: |
|
||||||
|
@ -1459,107 +1489,219 @@ definitions:
|
||||||
example: "4443"
|
example: "4443"
|
||||||
|
|
||||||
GraphDriverData:
|
GraphDriverData:
|
||||||
description: "Information about a container's graph driver."
|
description: |
|
||||||
|
Information about the storage driver used to store the container's and
|
||||||
|
image's filesystem.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Name, Data]
|
required: [Name, Data]
|
||||||
properties:
|
properties:
|
||||||
Name:
|
Name:
|
||||||
|
description: "Name of the storage driver."
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "overlay2"
|
||||||
Data:
|
Data:
|
||||||
|
description: |
|
||||||
|
Low-level storage metadata, provided as key/value pairs.
|
||||||
|
|
||||||
|
This information is driver-specific, and depends on the storage-driver
|
||||||
|
in use, and should be used for informational purposes only.
|
||||||
type: "object"
|
type: "object"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: {
|
||||||
|
"MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged",
|
||||||
|
"UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff",
|
||||||
|
"WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
|
||||||
|
}
|
||||||
|
|
||||||
Image:
|
ImageInspect:
|
||||||
|
description: |
|
||||||
|
Information about an image in the local image cache.
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
|
||||||
- Id
|
|
||||||
- Parent
|
|
||||||
- Comment
|
|
||||||
- Created
|
|
||||||
- Container
|
|
||||||
- DockerVersion
|
|
||||||
- Author
|
|
||||||
- Architecture
|
|
||||||
- Os
|
|
||||||
- Size
|
|
||||||
- VirtualSize
|
|
||||||
- GraphDriver
|
|
||||||
- RootFS
|
|
||||||
properties:
|
properties:
|
||||||
Id:
|
Id:
|
||||||
|
description: |
|
||||||
|
ID is the content-addressable ID of an image.
|
||||||
|
|
||||||
|
This identified is a content-addressable digest calculated from the
|
||||||
|
image's configuration (which includes the digests of layers used by
|
||||||
|
the image).
|
||||||
|
|
||||||
|
Note that this digest differs from the `RepoDigests` below, which
|
||||||
|
holds digests of image manifests that reference the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710"
|
||||||
RepoTags:
|
RepoTags:
|
||||||
|
description: |
|
||||||
|
List of image names/tags in the local image cache that reference this
|
||||||
|
image.
|
||||||
|
|
||||||
|
Multiple image tags can refer to the same imagem and this list may be
|
||||||
|
empty if no tags reference the image, in which case the image is
|
||||||
|
"untagged", in which case it can still be referenced by its ID.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example:1.0"
|
||||||
|
- "example:latest"
|
||||||
|
- "example:stable"
|
||||||
|
- "internal.registry.example.com:5000/example:1.0"
|
||||||
RepoDigests:
|
RepoDigests:
|
||||||
|
description: |
|
||||||
|
List of content-addressable digests of locally available image manifests
|
||||||
|
that the image is referenced from. Multiple manifests can refer to the
|
||||||
|
same image.
|
||||||
|
|
||||||
|
These digests are usually only available if the image was either pulled
|
||||||
|
from a registry, or if the image was pushed to a registry, which is when
|
||||||
|
the manifest is generated and its digest calculated.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb"
|
||||||
|
- "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
|
||||||
Parent:
|
Parent:
|
||||||
|
description: |
|
||||||
|
ID of the parent image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty and
|
||||||
|
is only set for images that were built/created locally. This field
|
||||||
|
is empty if the image was pulled from an image registry.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Comment:
|
Comment:
|
||||||
|
description: |
|
||||||
|
Optional message that was set when committing or importing the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Created:
|
Created:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was created, formatted in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "2022-02-04T21:20:12.497794809Z"
|
||||||
Container:
|
Container:
|
||||||
|
description: |
|
||||||
|
The ID of the container that was used to create the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "65974bc86f1770ae4bff79f651ebdbce166ae9aada632ee3fa9af3a264911735"
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
DockerVersion:
|
DockerVersion:
|
||||||
|
description: |
|
||||||
|
The version of Docker that was used to build the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "20.10.7"
|
||||||
Author:
|
Author:
|
||||||
|
description: |
|
||||||
|
Name of the author that was specified when committing the image, or as
|
||||||
|
specified through MAINTAINER (deprecated) in the Dockerfile.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Config:
|
Config:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
Architecture:
|
Architecture:
|
||||||
|
description: |
|
||||||
|
Hardware CPU architecture that the image runs on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "arm"
|
||||||
|
Variant:
|
||||||
|
description: |
|
||||||
|
CPU architecture variant (presently ARM-only).
|
||||||
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: "v7"
|
||||||
Os:
|
Os:
|
||||||
|
description: |
|
||||||
|
Operating System the image is built to run on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "linux"
|
||||||
OsVersion:
|
OsVersion:
|
||||||
|
description: |
|
||||||
|
Operating System version the image is built to run on (especially
|
||||||
|
for Windows).
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ""
|
||||||
|
x-nullable: true
|
||||||
Size:
|
Size:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
VirtualSize:
|
VirtualSize:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
|
|
||||||
|
In versions of Docker before v1.10, this field was calculated from
|
||||||
|
the image itself and all of its parent images. Docker v1.10 and up
|
||||||
|
store images self-contained, and no longer use a parent-chain, making
|
||||||
|
this field an equivalent of the Size field.
|
||||||
|
|
||||||
|
This field is kept for backward compatibility, but may be removed in
|
||||||
|
a future version of the API.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
GraphDriver:
|
GraphDriver:
|
||||||
$ref: "#/definitions/GraphDriverData"
|
$ref: "#/definitions/GraphDriverData"
|
||||||
RootFS:
|
RootFS:
|
||||||
|
description: |
|
||||||
|
Information about the image's RootFS, including the layer IDs.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Type]
|
required: [Type]
|
||||||
properties:
|
properties:
|
||||||
Type:
|
Type:
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "layers"
|
||||||
Layers:
|
Layers:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
||||||
|
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
||||||
BaseLayer:
|
BaseLayer:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: ""
|
||||||
Metadata:
|
Metadata:
|
||||||
|
description: |
|
||||||
|
Additional metadata of the image in the local cache. This information
|
||||||
|
is local to the daemon, and not part of the image itself.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
LastTagTime:
|
LastTagTime:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was last tagged in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
|
|
||||||
|
This information is only available if the image was tagged locally,
|
||||||
|
and omitted otherwise.
|
||||||
type: "string"
|
type: "string"
|
||||||
format: "dateTime"
|
format: "dateTime"
|
||||||
|
example: "2022-02-28T14:40:02.623929178Z"
|
||||||
|
x-nullable: true
|
||||||
ImageSummary:
|
ImageSummary:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
@ -5133,22 +5275,22 @@ definitions:
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
example: 3987495
|
example: 3987495
|
||||||
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
|
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
|
||||||
# urls:
|
# urls:
|
||||||
# description: |
|
# description: |
|
||||||
# List of URLs from which this object MAY be downloaded.
|
# List of URLs from which this object MAY be downloaded.
|
||||||
# type: "array"
|
# type: "array"
|
||||||
# items:
|
# items:
|
||||||
# type: "string"
|
# type: "string"
|
||||||
# format: "uri"
|
# format: "uri"
|
||||||
# annotations:
|
# annotations:
|
||||||
# description: |
|
# description: |
|
||||||
# Arbitrary metadata relating to the targeted content.
|
# Arbitrary metadata relating to the targeted content.
|
||||||
# type: "object"
|
# type: "object"
|
||||||
# additionalProperties:
|
# additionalProperties:
|
||||||
# type: "string"
|
# type: "string"
|
||||||
# platform:
|
# platform:
|
||||||
# $ref: "#/definitions/OCIPlatform"
|
# $ref: "#/definitions/OCIPlatform"
|
||||||
|
|
||||||
OCIPlatform:
|
OCIPlatform:
|
||||||
type: "object"
|
type: "object"
|
||||||
|
@ -7537,84 +7679,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: "No error"
|
description: "No error"
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/definitions/Image"
|
$ref: "#/definitions/ImageInspect"
|
||||||
examples:
|
|
||||||
application/json:
|
|
||||||
Id: "sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c"
|
|
||||||
Container: "cb91e48a60d01f1e27028b4fc6819f4f290b3cf12496c8176ec714d0d390984a"
|
|
||||||
Comment: ""
|
|
||||||
Os: "linux"
|
|
||||||
Architecture: "amd64"
|
|
||||||
Parent: "sha256:91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
ContainerConfig:
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
StdinOnce: false
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
User: ""
|
|
||||||
WorkingDir: ""
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
Labels:
|
|
||||||
com.example.license: "GPL"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/sh"
|
|
||||||
- "-c"
|
|
||||||
- "#(nop) LABEL com.example.vendor=Acme com.example.license=GPL com.example.version=1.0"
|
|
||||||
DockerVersion: "1.9.0-dev"
|
|
||||||
VirtualSize: 188359297
|
|
||||||
Size: 0
|
|
||||||
Author: ""
|
|
||||||
Created: "2015-09-10T08:30:53.26995814Z"
|
|
||||||
GraphDriver:
|
|
||||||
Name: "aufs"
|
|
||||||
Data: {}
|
|
||||||
RepoDigests:
|
|
||||||
- "localhost:5000/test/busybox/example@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf"
|
|
||||||
RepoTags:
|
|
||||||
- "example:1.0"
|
|
||||||
- "example:latest"
|
|
||||||
- "example:stable"
|
|
||||||
Config:
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
StdinOnce: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/bash"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Labels:
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.license: "GPL"
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
WorkingDir: ""
|
|
||||||
User: ""
|
|
||||||
RootFS:
|
|
||||||
Type: "layers"
|
|
||||||
Layers:
|
|
||||||
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
|
||||||
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
|
||||||
404:
|
404:
|
||||||
description: "No such image"
|
description: "No such image"
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -746,6 +746,7 @@ definitions:
|
||||||
description: |
|
description: |
|
||||||
Health stores information about the container's healthcheck results.
|
Health stores information about the container's healthcheck results.
|
||||||
type: "object"
|
type: "object"
|
||||||
|
x-nullable: true
|
||||||
properties:
|
properties:
|
||||||
Status:
|
Status:
|
||||||
description: |
|
description: |
|
||||||
|
@ -1108,14 +1109,18 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
description: "Configuration for a container that is portable between hosts"
|
description: |
|
||||||
|
Configuration for a container that is portable between hosts.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
Hostname:
|
Hostname:
|
||||||
description: "The hostname to use for the container, as a valid RFC 1123 hostname."
|
description: |
|
||||||
|
The hostname to use for the container, as a valid RFC 1123 hostname.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "439f4e91bd1d"
|
||||||
Domainname:
|
Domainname:
|
||||||
description: "The domain name to use for the container."
|
description: |
|
||||||
|
The domain name to use for the container.
|
||||||
type: "string"
|
type: "string"
|
||||||
User:
|
User:
|
||||||
description: "The user that commands are run as inside the container."
|
description: "The user that commands are run as inside the container."
|
||||||
|
@ -1138,11 +1143,16 @@ definitions:
|
||||||
|
|
||||||
`{"<port>/<tcp|udp|sctp>": {}}`
|
`{"<port>/<tcp|udp|sctp>": {}}`
|
||||||
type: "object"
|
type: "object"
|
||||||
|
x-nullable: true
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "object"
|
type: "object"
|
||||||
enum:
|
enum:
|
||||||
- {}
|
- {}
|
||||||
default: {}
|
default: {}
|
||||||
|
example: {
|
||||||
|
"80/tcp": {},
|
||||||
|
"443/tcp": {}
|
||||||
|
}
|
||||||
Tty:
|
Tty:
|
||||||
description: |
|
description: |
|
||||||
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
Attach standard streams to a TTY, including `stdin` if it is not closed.
|
||||||
|
@ -1164,21 +1174,29 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
||||||
Cmd:
|
Cmd:
|
||||||
description: |
|
description: |
|
||||||
Command to run specified as a string or an array of strings.
|
Command to run specified as a string or an array of strings.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh"]
|
||||||
Healthcheck:
|
Healthcheck:
|
||||||
$ref: "#/definitions/HealthConfig"
|
$ref: "#/definitions/HealthConfig"
|
||||||
ArgsEscaped:
|
ArgsEscaped:
|
||||||
description: "Command is already escaped (Windows only)"
|
description: "Command is already escaped (Windows only)"
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
default: false
|
||||||
|
example: false
|
||||||
|
x-nullable: true
|
||||||
Image:
|
Image:
|
||||||
description: |
|
description: |
|
||||||
The name of the image to use when creating the container/
|
The name (or reference) of the image to use when creating the container,
|
||||||
|
or which was used when the container was created.
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "example-image:1.0"
|
||||||
Volumes:
|
Volumes:
|
||||||
description: |
|
description: |
|
||||||
An object mapping mount point paths inside the container to empty
|
An object mapping mount point paths inside the container to empty
|
||||||
|
@ -1192,6 +1210,7 @@ definitions:
|
||||||
WorkingDir:
|
WorkingDir:
|
||||||
description: "The working directory for commands to run in."
|
description: "The working directory for commands to run in."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: "/public/"
|
||||||
Entrypoint:
|
Entrypoint:
|
||||||
description: |
|
description: |
|
||||||
The entry point for the container as a string or an array of strings.
|
The entry point for the container as a string or an array of strings.
|
||||||
|
@ -1202,38 +1221,50 @@ definitions:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
NetworkDisabled:
|
NetworkDisabled:
|
||||||
description: "Disable networking for the container."
|
description: "Disable networking for the container."
|
||||||
type: "boolean"
|
type: "boolean"
|
||||||
|
x-nullable: true
|
||||||
MacAddress:
|
MacAddress:
|
||||||
description: "MAC address of the container."
|
description: "MAC address of the container."
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
OnBuild:
|
OnBuild:
|
||||||
description: |
|
description: |
|
||||||
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
`ONBUILD` metadata that were defined in the image's `Dockerfile`.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: []
|
||||||
Labels:
|
Labels:
|
||||||
description: "User-defined key/value metadata."
|
description: "User-defined key/value metadata."
|
||||||
type: "object"
|
type: "object"
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
com.example.some-label: "some-value"
|
||||||
|
com.example.some-other-label: "some-other-value"
|
||||||
StopSignal:
|
StopSignal:
|
||||||
description: |
|
description: |
|
||||||
Signal to stop a container as a string or unsigned integer.
|
Signal to stop a container as a string or unsigned integer.
|
||||||
type: "string"
|
type: "string"
|
||||||
default: "SIGTERM"
|
example: "SIGTERM"
|
||||||
|
x-nullable: true
|
||||||
StopTimeout:
|
StopTimeout:
|
||||||
description: "Timeout to stop a container in seconds."
|
description: "Timeout to stop a container in seconds."
|
||||||
type: "integer"
|
type: "integer"
|
||||||
default: 10
|
default: 10
|
||||||
|
x-nullable: true
|
||||||
Shell:
|
Shell:
|
||||||
description: |
|
description: |
|
||||||
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
|
||||||
type: "array"
|
type: "array"
|
||||||
|
x-nullable: true
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ["/bin/sh", "-c"]
|
||||||
|
|
||||||
NetworkingConfig:
|
NetworkingConfig:
|
||||||
description: |
|
description: |
|
||||||
|
@ -1490,107 +1521,219 @@ definitions:
|
||||||
example: "4443"
|
example: "4443"
|
||||||
|
|
||||||
GraphDriverData:
|
GraphDriverData:
|
||||||
description: "Information about a container's graph driver."
|
description: |
|
||||||
|
Information about the storage driver used to store the container's and
|
||||||
|
image's filesystem.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Name, Data]
|
required: [Name, Data]
|
||||||
properties:
|
properties:
|
||||||
Name:
|
Name:
|
||||||
|
description: "Name of the storage driver."
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "overlay2"
|
||||||
Data:
|
Data:
|
||||||
|
description: |
|
||||||
|
Low-level storage metadata, provided as key/value pairs.
|
||||||
|
|
||||||
|
This information is driver-specific, and depends on the storage-driver
|
||||||
|
in use, and should be used for informational purposes only.
|
||||||
type: "object"
|
type: "object"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: {
|
||||||
|
"MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged",
|
||||||
|
"UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff",
|
||||||
|
"WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
|
||||||
|
}
|
||||||
|
|
||||||
Image:
|
ImageInspect:
|
||||||
|
description: |
|
||||||
|
Information about an image in the local image cache.
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
|
||||||
- Id
|
|
||||||
- Parent
|
|
||||||
- Comment
|
|
||||||
- Created
|
|
||||||
- Container
|
|
||||||
- DockerVersion
|
|
||||||
- Author
|
|
||||||
- Architecture
|
|
||||||
- Os
|
|
||||||
- Size
|
|
||||||
- VirtualSize
|
|
||||||
- GraphDriver
|
|
||||||
- RootFS
|
|
||||||
properties:
|
properties:
|
||||||
Id:
|
Id:
|
||||||
|
description: |
|
||||||
|
ID is the content-addressable ID of an image.
|
||||||
|
|
||||||
|
This identified is a content-addressable digest calculated from the
|
||||||
|
image's configuration (which includes the digests of layers used by
|
||||||
|
the image).
|
||||||
|
|
||||||
|
Note that this digest differs from the `RepoDigests` below, which
|
||||||
|
holds digests of image manifests that reference the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710"
|
||||||
RepoTags:
|
RepoTags:
|
||||||
|
description: |
|
||||||
|
List of image names/tags in the local image cache that reference this
|
||||||
|
image.
|
||||||
|
|
||||||
|
Multiple image tags can refer to the same imagem and this list may be
|
||||||
|
empty if no tags reference the image, in which case the image is
|
||||||
|
"untagged", in which case it can still be referenced by its ID.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example:1.0"
|
||||||
|
- "example:latest"
|
||||||
|
- "example:stable"
|
||||||
|
- "internal.registry.example.com:5000/example:1.0"
|
||||||
RepoDigests:
|
RepoDigests:
|
||||||
|
description: |
|
||||||
|
List of content-addressable digests of locally available image manifests
|
||||||
|
that the image is referenced from. Multiple manifests can refer to the
|
||||||
|
same image.
|
||||||
|
|
||||||
|
These digests are usually only available if the image was either pulled
|
||||||
|
from a registry, or if the image was pushed to a registry, which is when
|
||||||
|
the manifest is generated and its digest calculated.
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb"
|
||||||
|
- "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
|
||||||
Parent:
|
Parent:
|
||||||
|
description: |
|
||||||
|
ID of the parent image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty and
|
||||||
|
is only set for images that were built/created locally. This field
|
||||||
|
is empty if the image was pulled from an image registry.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Comment:
|
Comment:
|
||||||
|
description: |
|
||||||
|
Optional message that was set when committing or importing the image.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Created:
|
Created:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was created, formatted in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "2022-02-04T21:20:12.497794809Z"
|
||||||
Container:
|
Container:
|
||||||
|
description: |
|
||||||
|
The ID of the container that was used to create the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "65974bc86f1770ae4bff79f651ebdbce166ae9aada632ee3fa9af3a264911735"
|
||||||
ContainerConfig:
|
ContainerConfig:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
DockerVersion:
|
DockerVersion:
|
||||||
|
description: |
|
||||||
|
The version of Docker that was used to build the image.
|
||||||
|
|
||||||
|
Depending on how the image was created, this field may be empty.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "20.10.7"
|
||||||
Author:
|
Author:
|
||||||
|
description: |
|
||||||
|
Name of the author that was specified when committing the image, or as
|
||||||
|
specified through MAINTAINER (deprecated) in the Dockerfile.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: ""
|
||||||
Config:
|
Config:
|
||||||
$ref: "#/definitions/ContainerConfig"
|
$ref: "#/definitions/ContainerConfig"
|
||||||
Architecture:
|
Architecture:
|
||||||
|
description: |
|
||||||
|
Hardware CPU architecture that the image runs on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "arm"
|
||||||
|
Variant:
|
||||||
|
description: |
|
||||||
|
CPU architecture variant (presently ARM-only).
|
||||||
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: "v7"
|
||||||
Os:
|
Os:
|
||||||
|
description: |
|
||||||
|
Operating System the image is built to run on.
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "linux"
|
||||||
OsVersion:
|
OsVersion:
|
||||||
|
description: |
|
||||||
|
Operating System version the image is built to run on (especially
|
||||||
|
for Windows).
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example: ""
|
||||||
|
x-nullable: true
|
||||||
Size:
|
Size:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
VirtualSize:
|
VirtualSize:
|
||||||
|
description: |
|
||||||
|
Total size of the image including all layers it is composed of.
|
||||||
|
|
||||||
|
In versions of Docker before v1.10, this field was calculated from
|
||||||
|
the image itself and all of its parent images. Docker v1.10 and up
|
||||||
|
store images self-contained, and no longer use a parent-chain, making
|
||||||
|
this field an equivalent of the Size field.
|
||||||
|
|
||||||
|
This field is kept for backward compatibility, but may be removed in
|
||||||
|
a future version of the API.
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: 1239828
|
||||||
GraphDriver:
|
GraphDriver:
|
||||||
$ref: "#/definitions/GraphDriverData"
|
$ref: "#/definitions/GraphDriverData"
|
||||||
RootFS:
|
RootFS:
|
||||||
|
description: |
|
||||||
|
Information about the image's RootFS, including the layer IDs.
|
||||||
type: "object"
|
type: "object"
|
||||||
required: [Type]
|
required: [Type]
|
||||||
properties:
|
properties:
|
||||||
Type:
|
Type:
|
||||||
type: "string"
|
type: "string"
|
||||||
x-nullable: false
|
x-nullable: false
|
||||||
|
example: "layers"
|
||||||
Layers:
|
Layers:
|
||||||
type: "array"
|
type: "array"
|
||||||
items:
|
items:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
example:
|
||||||
|
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
||||||
|
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
||||||
BaseLayer:
|
BaseLayer:
|
||||||
type: "string"
|
type: "string"
|
||||||
|
x-nullable: true
|
||||||
|
example: ""
|
||||||
Metadata:
|
Metadata:
|
||||||
|
description: |
|
||||||
|
Additional metadata of the image in the local cache. This information
|
||||||
|
is local to the daemon, and not part of the image itself.
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
LastTagTime:
|
LastTagTime:
|
||||||
|
description: |
|
||||||
|
Date and time at which the image was last tagged in
|
||||||
|
[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
|
||||||
|
|
||||||
|
This information is only available if the image was tagged locally,
|
||||||
|
and omitted otherwise.
|
||||||
type: "string"
|
type: "string"
|
||||||
format: "dateTime"
|
format: "dateTime"
|
||||||
|
example: "2022-02-28T14:40:02.623929178Z"
|
||||||
|
x-nullable: true
|
||||||
ImageSummary:
|
ImageSummary:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
@ -5291,22 +5434,22 @@ definitions:
|
||||||
type: "integer"
|
type: "integer"
|
||||||
format: "int64"
|
format: "int64"
|
||||||
example: 3987495
|
example: 3987495
|
||||||
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
|
# TODO Not yet including these fields for now, as they are nil / omitted in our response.
|
||||||
# urls:
|
# urls:
|
||||||
# description: |
|
# description: |
|
||||||
# List of URLs from which this object MAY be downloaded.
|
# List of URLs from which this object MAY be downloaded.
|
||||||
# type: "array"
|
# type: "array"
|
||||||
# items:
|
# items:
|
||||||
# type: "string"
|
# type: "string"
|
||||||
# format: "uri"
|
# format: "uri"
|
||||||
# annotations:
|
# annotations:
|
||||||
# description: |
|
# description: |
|
||||||
# Arbitrary metadata relating to the targeted content.
|
# Arbitrary metadata relating to the targeted content.
|
||||||
# type: "object"
|
# type: "object"
|
||||||
# additionalProperties:
|
# additionalProperties:
|
||||||
# type: "string"
|
# type: "string"
|
||||||
# platform:
|
# platform:
|
||||||
# $ref: "#/definitions/OCIPlatform"
|
# $ref: "#/definitions/OCIPlatform"
|
||||||
|
|
||||||
OCIPlatform:
|
OCIPlatform:
|
||||||
type: "object"
|
type: "object"
|
||||||
|
@ -7705,84 +7848,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: "No error"
|
description: "No error"
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/definitions/Image"
|
$ref: "#/definitions/ImageInspect"
|
||||||
examples:
|
|
||||||
application/json:
|
|
||||||
Id: "sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c"
|
|
||||||
Container: "cb91e48a60d01f1e27028b4fc6819f4f290b3cf12496c8176ec714d0d390984a"
|
|
||||||
Comment: ""
|
|
||||||
Os: "linux"
|
|
||||||
Architecture: "amd64"
|
|
||||||
Parent: "sha256:91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
ContainerConfig:
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
StdinOnce: false
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
User: ""
|
|
||||||
WorkingDir: ""
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
Labels:
|
|
||||||
com.example.license: "GPL"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/sh"
|
|
||||||
- "-c"
|
|
||||||
- "#(nop) LABEL com.example.vendor=Acme com.example.license=GPL com.example.version=1.0"
|
|
||||||
DockerVersion: "1.9.0-dev"
|
|
||||||
VirtualSize: 188359297
|
|
||||||
Size: 0
|
|
||||||
Author: ""
|
|
||||||
Created: "2015-09-10T08:30:53.26995814Z"
|
|
||||||
GraphDriver:
|
|
||||||
Name: "aufs"
|
|
||||||
Data: {}
|
|
||||||
RepoDigests:
|
|
||||||
- "localhost:5000/test/busybox/example@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf"
|
|
||||||
RepoTags:
|
|
||||||
- "example:1.0"
|
|
||||||
- "example:latest"
|
|
||||||
- "example:stable"
|
|
||||||
Config:
|
|
||||||
Image: "91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c"
|
|
||||||
NetworkDisabled: false
|
|
||||||
OnBuild: []
|
|
||||||
StdinOnce: false
|
|
||||||
PublishService: ""
|
|
||||||
AttachStdin: false
|
|
||||||
OpenStdin: false
|
|
||||||
Domainname: ""
|
|
||||||
AttachStdout: false
|
|
||||||
Tty: false
|
|
||||||
Hostname: "e611e15f9c9d"
|
|
||||||
Cmd:
|
|
||||||
- "/bin/bash"
|
|
||||||
Env:
|
|
||||||
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
|
||||||
Labels:
|
|
||||||
com.example.vendor: "Acme"
|
|
||||||
com.example.version: "1.0"
|
|
||||||
com.example.license: "GPL"
|
|
||||||
MacAddress: ""
|
|
||||||
AttachStderr: false
|
|
||||||
WorkingDir: ""
|
|
||||||
User: ""
|
|
||||||
RootFS:
|
|
||||||
Type: "layers"
|
|
||||||
Layers:
|
|
||||||
- "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6"
|
|
||||||
- "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
|
|
||||||
404:
|
404:
|
||||||
description: "No such image"
|
description: "No such image"
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -36,40 +36,75 @@ func IDFromDigest(digest digest.Digest) ID {
|
||||||
type V1Image struct {
|
type V1Image struct {
|
||||||
// ID is a unique 64 character identifier of the image
|
// ID is a unique 64 character identifier of the image
|
||||||
ID string `json:"id,omitempty"`
|
ID string `json:"id,omitempty"`
|
||||||
// Parent is the ID of the parent image
|
|
||||||
|
// Parent is the ID of the parent image.
|
||||||
|
//
|
||||||
|
// Depending on how the image was created, this field may be empty and
|
||||||
|
// is only set for images that were built/created locally. This field
|
||||||
|
// is empty if the image was pulled from an image registry.
|
||||||
Parent string `json:"parent,omitempty"`
|
Parent string `json:"parent,omitempty"`
|
||||||
// Comment is the commit message that was set when committing the image
|
|
||||||
|
// Comment is an optional message that can be set when committing or
|
||||||
|
// importing the image.
|
||||||
Comment string `json:"comment,omitempty"`
|
Comment string `json:"comment,omitempty"`
|
||||||
|
|
||||||
// Created is the timestamp at which the image was created
|
// Created is the timestamp at which the image was created
|
||||||
Created time.Time `json:"created"`
|
Created time.Time `json:"created"`
|
||||||
// Container is the id of the container used to commit
|
|
||||||
|
// Container is the ID of the container that was used to create the image.
|
||||||
|
//
|
||||||
|
// Depending on how the image was created, this field may be empty.
|
||||||
Container string `json:"container,omitempty"`
|
Container string `json:"container,omitempty"`
|
||||||
// ContainerConfig is the configuration of the container that is committed into the image
|
|
||||||
|
// ContainerConfig is the configuration of the container that was committed
|
||||||
|
// into the image.
|
||||||
ContainerConfig container.Config `json:"container_config,omitempty"`
|
ContainerConfig container.Config `json:"container_config,omitempty"`
|
||||||
// DockerVersion specifies the version of Docker that was used to build the image
|
|
||||||
|
// DockerVersion is the version of Docker that was used to build the image.
|
||||||
|
//
|
||||||
|
// Depending on how the image was created, this field may be empty.
|
||||||
DockerVersion string `json:"docker_version,omitempty"`
|
DockerVersion string `json:"docker_version,omitempty"`
|
||||||
// Author is the name of the author that was specified when committing the image
|
|
||||||
|
// Author is the name of the author that was specified when committing the
|
||||||
|
// image, or as specified through MAINTAINER (deprecated) in the Dockerfile.
|
||||||
Author string `json:"author,omitempty"`
|
Author string `json:"author,omitempty"`
|
||||||
// Config is the configuration of the container received from the client
|
|
||||||
|
// Config is the configuration of the container received from the client.
|
||||||
Config *container.Config `json:"config,omitempty"`
|
Config *container.Config `json:"config,omitempty"`
|
||||||
// Architecture is the hardware that the image is built and runs on
|
|
||||||
|
// Architecture is the hardware CPU architecture that the image runs on.
|
||||||
Architecture string `json:"architecture,omitempty"`
|
Architecture string `json:"architecture,omitempty"`
|
||||||
// Variant is the CPU architecture variant (presently ARM-only)
|
|
||||||
|
// Variant is the CPU architecture variant (presently ARM-only).
|
||||||
Variant string `json:"variant,omitempty"`
|
Variant string `json:"variant,omitempty"`
|
||||||
// OS is the operating system used to build and run the image
|
|
||||||
|
// OS is the Operating System the image is built to run on.
|
||||||
OS string `json:"os,omitempty"`
|
OS string `json:"os,omitempty"`
|
||||||
// Size is the total size of the image including all layers it is composed of
|
|
||||||
|
// Size is the total size of the image including all layers it is composed of.
|
||||||
Size int64 `json:",omitempty"`
|
Size int64 `json:",omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Image stores the image configuration
|
// Image stores the image configuration
|
||||||
type Image struct {
|
type Image struct {
|
||||||
V1Image
|
V1Image
|
||||||
Parent ID `json:"parent,omitempty"` //nolint:govet
|
|
||||||
RootFS *RootFS `json:"rootfs,omitempty"`
|
// Parent is the ID of the parent image.
|
||||||
History []History `json:"history,omitempty"`
|
//
|
||||||
OSVersion string `json:"os.version,omitempty"`
|
// Depending on how the image was created, this field may be empty and
|
||||||
OSFeatures []string `json:"os.features,omitempty"`
|
// is only set for images that were built/created locally. This field
|
||||||
|
// is empty if the image was pulled from an image registry.
|
||||||
|
Parent ID `json:"parent,omitempty"` //nolint:govet
|
||||||
|
|
||||||
|
// RootFS contains information about the image's RootFS, including the
|
||||||
|
// layer IDs.
|
||||||
|
RootFS *RootFS `json:"rootfs,omitempty"`
|
||||||
|
History []History `json:"history,omitempty"`
|
||||||
|
|
||||||
|
// OsVersion is the version of the Operating System the image is built to
|
||||||
|
// run on (especially for Windows).
|
||||||
|
OSVersion string `json:"os.version,omitempty"`
|
||||||
|
OSFeatures []string `json:"os.features,omitempty"`
|
||||||
|
|
||||||
// rawJSON caches the immutable JSON associated with this image.
|
// rawJSON caches the immutable JSON associated with this image.
|
||||||
rawJSON []byte
|
rawJSON []byte
|
||||||
|
@ -195,7 +230,8 @@ func NewChildImage(img *Image, child ChildConfig, os string) *Image {
|
||||||
type History struct {
|
type History struct {
|
||||||
// Created is the timestamp at which the image was created
|
// Created is the timestamp at which the image was created
|
||||||
Created time.Time `json:"created"`
|
Created time.Time `json:"created"`
|
||||||
// Author is the name of the author that was specified when committing the image
|
// Author is the name of the author that was specified when committing the
|
||||||
|
// image, or as specified through MAINTAINER (deprecated) in the Dockerfile.
|
||||||
Author string `json:"author,omitempty"`
|
Author string `json:"author,omitempty"`
|
||||||
// CreatedBy keeps the Dockerfile command used while building the image
|
// CreatedBy keeps the Dockerfile command used while building the image
|
||||||
CreatedBy string `json:"created_by,omitempty"`
|
CreatedBy string `json:"created_by,omitempty"`
|
||||||
|
|
Loading…
Reference in New Issue