mirror of
https://github.com/moby/moby.git
synced 2026-08-03 22:51:03 +00:00
f85394dd5d
commit 4dc961d0e9 removed deprecated
fields from the image inspect response for API v1.50 and up. As
part of that change, it changed the type used for the Config field
to use the docker image spect structs, which embeds the OCI image
spec structs.
While the OCI image spect struct contains the same fields as we
used before, those fields also have "omitempty" set, which means
they are now omitted when empty.
We should probably consider deprecating that behavior in the API,
and call out that these fields are omitted if not set, but in the
meantime, we can add them back with their default (zero) value.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
89 lines
2.3 KiB
Go
89 lines
2.3 KiB
Go
// FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
|
|
//go:build go1.23
|
|
|
|
package image
|
|
|
|
import (
|
|
"encoding/json"
|
|
"maps"
|
|
|
|
"github.com/docker/docker/api/types/image"
|
|
)
|
|
|
|
// legacyConfigFields defines legacy image-config fields to include in
|
|
// API responses on older API versions.
|
|
var legacyConfigFields = map[string]map[string]any{
|
|
// Legacy fields for API v1.49 and lower. These fields are deprecated
|
|
// and omitted in newer API versions; see https://github.com/moby/moby/pull/48457
|
|
"v1.49": {
|
|
"AttachStderr": false,
|
|
"AttachStdin": false,
|
|
"AttachStdout": false,
|
|
"Cmd": nil,
|
|
"Domainname": "",
|
|
"Entrypoint": nil,
|
|
"Env": nil,
|
|
"Hostname": "",
|
|
"Image": "",
|
|
"Labels": nil,
|
|
"OnBuild": nil,
|
|
"OpenStdin": false,
|
|
"StdinOnce": false,
|
|
"Tty": false,
|
|
"User": "",
|
|
"Volumes": nil,
|
|
"WorkingDir": "",
|
|
},
|
|
// Legacy fields for current API versions (v1.50 and up). These fields
|
|
// did not have an "omitempty" and were always included in the response,
|
|
// even if not set; see https://github.com/moby/moby/issues/50134
|
|
"current": {
|
|
"Cmd": nil,
|
|
"Entrypoint": nil,
|
|
"Env": nil,
|
|
"Labels": nil,
|
|
"OnBuild": nil,
|
|
"User": "",
|
|
"Volumes": nil,
|
|
"WorkingDir": "",
|
|
},
|
|
}
|
|
|
|
// inspectCompatResponse is a wrapper around [image.InspectResponse] with a
|
|
// custom marshal function for legacy [api/types/container.Config} fields
|
|
// that have been removed, or did not have omitempty.
|
|
type inspectCompatResponse struct {
|
|
*image.InspectResponse
|
|
legacyConfig map[string]any
|
|
}
|
|
|
|
// MarshalJSON implements a custom marshaler to include legacy fields
|
|
// in API responses.
|
|
func (ir *inspectCompatResponse) MarshalJSON() ([]byte, error) {
|
|
type tmp *image.InspectResponse
|
|
base, err := json.Marshal((tmp)(ir.InspectResponse))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(ir.legacyConfig) == 0 {
|
|
return base, nil
|
|
}
|
|
|
|
type resp struct {
|
|
*image.InspectResponse
|
|
Config map[string]any
|
|
}
|
|
|
|
var merged resp
|
|
err = json.Unmarshal(base, &merged)
|
|
if err != nil {
|
|
return base, nil
|
|
}
|
|
|
|
// prevent mutating legacyConfigFields.
|
|
cfg := maps.Clone(ir.legacyConfig)
|
|
maps.Copy(cfg, merged.Config)
|
|
merged.Config = cfg
|
|
return json.Marshal(merged)
|
|
}
|