Moby Files

The first release candidate of a Go module github.com/moby/moby/client dedicated for the Moby API client making the old github.com/docker/docker/client package obsolete.

Changelog

• api/pkg/progress and api/pkg/streamformatter have been removed. [#51153]
• api/types/versions has moved to the client and daemon. [#51284]
• client.ConfigCreate, client.ConfigList, client.ConfigInspectWithRaw, client.ConfigUpdate, and client.ConfigRemove methods now accept option structs instead of positional arguments, and return dedicated result structs. [#51078]
• client.ImageBuild, client.BuildCancel, client.ImageList, client.ImageRemove, client.ImageTag, and client.ImageSearch methods now accept option structs instead of positional arguments, and return dedicated result structs. [#51227]
• client/pkg/jsonmessage: remove deprecated ProgressMessage, ErrorMessage, DisplayJSONMessagesToStream and Stream interface. [#49264]
• client: ContainerExec... methods were renamed to Exec.... [#51262]
• client: Wrap return values of ImageInspect, ImageHistory, ImageLoad and ImageSave in a struct. [#51236]
• events API now reports content-type as application/x-ndjson for newline-delimited JSON event stream. [#50953]
• ImagePull now returns an object with JSONMessages method returning iterator over the message objects. [#50935]
• ImagePush now returns an object with JSONMessages method returning iterator over the message objects. [#51148]
• api/types/build: move CachePruneOptions type to client.BuildCachePruneOptions. [#50772]
• api/types/build: move build options to client and backend. [#50907]
• api/types/checkpoint: move checkpoint options to client module. [#50905]
• api/types/container: merge InspectResponse and ContainerJSONBase. [#50809]
• api/types/container: move ResizeOptions type to ContainerResizeOptions in the client. [#50773]
• api/types/container: move StatsResponseReader to client package. [#50521]
• api/types/container: move container options to client. [#50897]
• api/types/container: move ExecInspect type to client. [#50991]
• api/types/container: remove deprecated Config.MacAddress. [#51194]
• api/types/container: StatsResponse: add OSType field. [#51305]
• api/types/events: move ListOptions type to the client EventsListOptions. [#50774]
• api/types/filters: remove deprecated ToParamWithVersion. [#50561]
• api/types/image: move image options out to the client. [#50776]
• api/types/image: move LoadResponse to client. [#50909]
• api/types/network: CreateRequest: remove deprecated CheckDuplicate field. [#50998]
• api/types/network: define ConnectRequest and DisconnectRequest. [#51324]
• api/types/network: move CreateOptions, ConnectOptions and DisconnectOptions to the client module. [#50817]
• api/types/network: move the ListOptions and InspectOptions types to the client. [#50786]
• api/types/plugin: change ListResponse to a non-pointer slice. [#51440]
• api/types/registry: move SearchOptions to ImageSearchOptions in the client. [#50787]
• api/types/registry: rename AuthenticateOKBody to AuthResponse. [#51334]
• api/types/strslice: deprecate StrSlice in favor of using a regular []string. [#50292]
• api/types/swarm: create types for enum-consts. [#51399]
• api/types/swarm: move option types to the client module. [#50794]
• api/types/swarm: move the SecretListOptions type to the client module. [#50816]
• api/types/system: deprecated top level DiskUsage fields for type specific fields. [#51235]
• api/types/system: move DiskUsageOptions to the client. [#50788]
• api/types/system: move SecurityOpt and DecodeSecurityOptions to client module. [#50825]
• api/types/volume: change ListResponse.Volumes to a non-pointer slice. [#51454]
• api/types/volume: move CreateOptions to client.VolumeCreateOptions. [#51211]
• api/types/volume: move the ListOptions type to the client module. [#50789]
• api/types/volume: moved UpdateOptions into client module. [#51205]
• api/types: move client.go contents into moby/moby/client. [#50510]
• api/types: move disk usage structs to per type packages. [#51406]
• api/types: move ErrorResponse to common/ErrorResponse. [#50632]
• api/types: move Ping and swarm.Status to client. [#51258]
• api/types: move plugin types to api/types/plugin. [#48114]
• api/types: move Version to api/types/system. [#51359]
• api/types: use regular slices for disk usage types. [#51412]
• api: move "DiskUsage" related types to the right location. [#50518]
• api: remove / internalize LegacyDiskUsage. [#51437]
• api: remove unused DefaultVersion, MinSupportedAPIVersion consts. [#50587]
• Bump api version in client and main module to v1.52.0-alpha.1. [#50641]
• chore: enable use-any rule from revive. [#50672]
• client, integration-cli: adjust for go1.25, TLS1.3 handshake. [#51055]
• client, api: update go.mod to go1.24. [#51460]
• client/build_*: Add options struct, wrap result. [#51076]
• client/checkpoint_list: Wrap result in a struct. [#51050]
• client/container_copy: Wrap options and result struct. [#51328]
• client/container_exec: Separate structs for Start and Attach. [#51289]
• client/container_update: Wrap options and result. [#51326]
• client/distribution_inspect: Wrap options and result. [#51264]
• client/node: Wrap options and output. [#51260]
• client/pkg/jsonmessage: refactor in terms of api/types/jsonstream. [#51156]
• client/pkg/jsonmessage: remove unused fields. [#50759]
• client/pkg/security: simplify. [#51381]
• client/secrets: Wrap results and options. [#51251]
• client/volume: refactor volume options and responses. [#51210]
• client: ContainerCommitOptions: remove Pause field in favor of NoPause. [#51019]
• client: add DefaultAPIVersion const, which defines the default (and maximum) API version supported by the client. [#50433]
• client: add ExecAPIClient interface for exec methods provided by the client. [#50997]
• client: add option and output structs for various container methods. [#51308]
• client: assorted fixes and refactor. [#51285]
• client: change Raw fields to be json.RawMessage. [#51288]
• client: check for Digested reference instead of Canonical. [#50798]
• client: checkpoint: add output structs and fix naming. [#51450]
• client: cleanup and re-group interfaces. [#51402]
• client: cleanup encoding body and add test-coverage. [#50432]
• client: Client.addHeaders: remove special handling for api < 1.25. [#50246]
• client: Client.ContainerCreate: fix panic when passing a nil config. [#51001]
• client: Client.negotiateAPIVersionPing: trim v-prefix before handling. [#51020]
• client: Client.Ping: improve error handling and fallback, and assorted fixes/cleanups. [#50709]
• client: Client.PluginList: add options-struct. [#51207]
• client: ContainerExecAttach: update GoDoc links. [#50411]
• client: ContainersPrune: rewrite to use option structs and result. [#51200]
• client: ContainerStats: add option, output-structs, remove ContainerStatsOneShot. [#51293]
• client: ContainerWait: touch-up GoDoc, and remove legacy code, and use singular for channels (ContainerWaitResult). [#51323]
• client: deprecate NewClientWithOpts in favor of New. [#51333]
• client: ExecCreate: rename Tty to TTY, change ConsoleSize to a ConsoleSize type. [#51400]
• client: Filters: add Clone method. [#51163]
• client: fix example, and add runnable example. [#51330]
• client: fix example, and update refs to old modules. [#50484]
• client: fix ImageLoadResult GoDoc. [#51296]
• client: fix some version-related handling. [#51005]
• client: gofumpt. [#51265]
• client: ImageBuildResponse: remove OSType field. [#50995]
• client: ImagePullResponse: don't panic without reader. [#51159]
• client: ImagePullResponse: use sync.OnceValue. [#51160]
• client: ImagesPrune: rewrite to use option structs and result. [#51200]
• client: merge ContainerInspectWithRaw with ContainerInspect. [#51290]
• client: Migrate tests to use functional opts and extract clientConfig. [#50847]
• client: move ExecStartOptions, ExecAttachOptions, ExecOptions to client. [#50978]
• client: NetworkInspect, NetworkList: wrap output structs, and remove NetworkInspectWithRaw. [#51245]
• client: NetworksPrune: rewrite to use option structs and result. [#51200]
• client: omit empty auth headers and use registry.RequestAuthConfig. [#50256]
• client: pkg/streamformatter: un-export unused utilities. [#51429]
• client: please the linters. [#51266]
• client: PluginInspectWithRaw: refactor and rename to PluginInspect. [#51254]
• client: PluginListResult: change Items field to a non-pointer slice. [#51440]
• client: prepare option-structs for multiple platforms. [#51342]
• client: reduce uses of obsolete API versions in tests. [#51071]
• client: refactor ContainerExport to wrap options/result structs. [#51316]
• client: refactor ContainerList to wrap result. [#51314]
• client: refactor ContainerLogs to wrap result. [#51317]
• client: refactor ContainerRename to wrap options/result structs. [#51315]
• client: refactor ContainerTop to wrap options and results. [#51313]
• client: refactor ContainerWait to use client defined options/results structs. [#51312]
• client: refactor create network api implementation to define options/result struct. [#51269]
• client: refactor Events, Info, RegistryLogin. [#51320]
• client: refactor NetworkConnect, NetworkDisconnect, NetworkRemove. [#51325]
• client: refactor plugin api client functions to define options/result…. [#51256]
• client: refactor ServerVersion to return ServerVersionResult. [#51233]
• client: refactor service api client functions for defined options/res…. [#51252]
• client: refactor ServiceCreate, ServiceUpdate, SwarmUpdate. [#51279]
• client: refactor swarm api functions to wrap params/responses. [#51244]
• client: refactor task responses. [#51234]
• client: remove APIClient.ImageInspectWithRaw from the APIClient interface. [#50485]
• client: remove ImageAPIClient.ImageInspectWithRaw from the ImageAPIClient interface. [#50485]
• client: remove ImageAPIClientDeprecated.ImageInspectWithRaw from the ImageAPIClientDeprecated. [#50485]
• client: Remove ImageCreate method - useImagePull or ImageImport instead. [#51366]
• client: remove API-version compatibility for API < v1.44. [#51120]
• client: remove client.ContainerStatsResult.OSType field. [#51305]
• client: remove deprecated ErrorConnectionFailed and IsErrNotFound functions. [#50485]
• client: remove deprecated ImageListOptions.ContainerCount. [#51006]
• client: remove deprecated NewClient and NewEnvClient functions. [#50485]
• client: remove ImageInspectWithAPIOpts function. [#50930]
• client: remove ImageLoadResult.JSON. [#51297]
• client: remove legacy CBC cipher suites from client config. [#50126]
• client: remove NegotiateAPIVersion, NegotiateAPIVersionPing. [#51307]
• client: remove support for API < v1.22 (docker < 1.10) filter format. [#50984]
• client: remove support for negotiating API version < v1.44 (docker 25.0). [#51119]
• client: remove the CommonAPIClient interface. [#50485]
• client: remove the ImageAPIClientDeprecated interface. [#50485]
• client: remove the deprecated Client.ImageInspectWithRaw method. [#50485]
• client: remove unused Client.HTTPClient() method. [#51011]
• client: remove unused hasEndpointSpecificMacAddress utility. [#51275]
• client: remove unused import. [#51332]
• client: remove uses of deprecated NewClientWithOpts. [#51431]
• client: remove VolumeInspectWithRaw, merge with VolumeInspect. [#51247]
• client: rename ServiceListResult.Services to ServiceListResult.Items. [#51273]
• client: rename ConfigListResult.Configs to ConfigListResult.Items. [#51249]
• client: Rename ContainerUnPause to ContainerUnpause. [#51322]
• client: rename validateAPIVersion to validateServiceSpecForAPIVersion. [#51003]
• client: rename VolumeListResult.List to VolumeListResult.Items. [#51246]
• client: ServerVersionResult: add back legacy fields. [#51358]
• client: simplify test with mock-responses. [#51277]
• client: singularize prune methods. [#51403]
• client: SwarmInspect, VolumeInspect: add options struct. [#51255]
• client: TestContainerInspectWithEmptyID test both inspect variants. [#50385]
• client: tidy go.mod. [#50979], [#50629]
• client: tidy-up test/mock-utilities. [#51276]
• client: touch-up godoc. [#50611]
• client: un-export NewVersionError, rename to requiresVersion. [#51327]
• client: use cancelReadCloser for readers. [#51306]
• client: use interface for return types. [#51383]
• client: use stdlib errors. [#50630]
• client: use sub-tests for ContainerLogs, ServiceLogs tests. [#51340]
• client: VolumePruneOptions: add "All" option. [#51208]
• client: VolumeRemove, VolumeUpdate: add output struct. [#51310]
• client: VolumesPrune: rewrite to use option structs and result. [#51200]
• client: WithMockClient: match version behavior of actual client. [#51002]
• client_(attach,commit,create,diff): Wrap result and options. [#51278]
• Copy the api/types/time package to internal client/daemon packages. [#50722]
• Create github.com/moby/moby/api and github.com/moby/moby/client module. [#50280]
• daemon, client: remove version-gate for daemon-side AutoRemove. [#51073]
• daemon: improve validation for container rename. [#51336]
• deprecate pkg/stdcopy, which was moved to api/stdcopy. [#50462]
• deprecate pkg/stringid in favour of github.com/moby/moby/client/pkg/stringid. [#50504]
• docs(client/ContainerExecAttach): add a mention to stdcopy.StdCopy. [#50119]
• Fix data race in ContainerExecStart, ContainerList, and Events. [#50448]
• Fix some faulty defers in tests. [#51304]
• fix: client vendor with config struct changes. [#50886]
• fix: easiest revive rules. [#50262]
• Improve errors when failing to connect to the API to provide more context to the user. [#50285]
• move endpoint API version constraints to API server. [#50987]
• Move jsonmessage, streamformatter, and progress. [#50565]
• Remove buildkit.ClientOpts. [#50318]
• Remove dependency on httputil for client hijack test. [#50270]
• Remove dependency on testutil from client. [#50271]
• remove deprecated types/plugins/logdriver and types/swarm/runtime packages; plugin-runtime spec is now exposed as types/swarm.RuntimeSpec and types/swarm.RuntimePrivilege. [#50554]
• Remove support for deprecated kernel memory limit. [#50989]
• Rename disk usage API fields. [#51428]
• Replace use of env test util with standard library call. [#50317]
• the client now uses its own client.Filters type for filtering API requests, with a more ergonomic interface. Users of the github.com/docker/docker/api/types/filters package will need to refactor when they upgrade to the v29 client. [#51115]
• Types "github.com/moby/moby/api/types/network".Summary and "github.com/moby/moby/api/types/network".Inspect are no longer aliases, and most of their fields have been moved into an embedded struct. Engine API clients may require some source-level changes when migrating to the new github.com/moby/moby/api module. [#50878]