Catalog / Moby

api 1.52.0

10 months agoaddedchangeddeprecatedOriginal notes

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

This release continues the 1.x line of API compatibility with the 52nd minor release of the 1.x API.

Changelog

  • api/pkg/progress and api/pkg/streamformatter have been removed. moby/moby#51153
  • api/types/registry: EncodeAuthConfig: use empty string for zero value. moby/moby#50426
  • api/types/versions has moved to the client and daemon. moby/moby#51284
  • client/pkg/jsonmessage: remove deprecated ProgressMessage, ErrorMessage, DisplayJSONMessagesToStream and Stream interface. moby/moby#49264
  • events API now reports content-type as application/x-ndjson for newline-delimited JSON event stream. moby/moby#50953
  • GET /containers/json now includes a Health field describing container healthcheck status. moby/moby#50281
  • GET /events no longer includes the deprecated status, id, and from fields. These fields were removed in API v1.22, but still included in the response. These fields are now omitted when using API v1.52 or higher. moby/moby#50832
  • GET /images/{name}/get and POST /images/load now accept multiple platform query parameters, allowing export and load of images for multiple platforms. moby/moby#50166
  • GET /images/{name}/json now omits the following fields if their value is empty: Parent, Comment, DockerVersion, Author. moby/moby#51072
  • GET /images/{name}/json: omit empty Config fields when not set. moby/moby#50915
  • POST /images/{name:}/push: remove compatibility with API v1.4 auth-config in body. moby/moby#50371
  • Add progress aux emitter to build backend. moby/moby#50278
  • Add support for memory swappiness in Swarm services. moby/moby#51114
    • GET /services now returns SwapBytes and MemorySwappiness fields as part of the Resource requirements
    • GET /services/{id} now returns SwapBytes and MemorySwappiness fields as part of the Resource requirements
    • POST /services/create now accepts SwapBytes and MemorySwappiness fields as part of the Resource requirements
    • POST /services/{id}/update now accepts SwapBytes and MemorySwappiness fields as part of the Resource requirements
    • GET /tasks now returns SwapBytes and MemorySwappiness fields as part of the Resource requirements
    • GET /tasks/{id} now returns SwapBytes and MemorySwappiness fields as part of the Resource requirements
  • api/docs: add v1.52 swagger. moby/moby#50626
  • api/docs: fix events example response. moby/moby#50949
  • api/docs: remove links to docs.docker.com from changelog. moby/moby#51457
  • api/docs: sync swagger and update changelog. moby/moby#50980
  • api/docs: sync v1.52 docs with latest. moby/moby#50911
  • api/docs: sync v1.52 swagger with current version. moby/moby#50643
  • api/docs: update v1.52 docs with current swagger. moby/moby#50899
  • api/pkg/stdcopy: move stdWriter to daemon/internal. moby/moby#51157
  • api/templates: align with go-swagger v1.32.3. moby/moby#51168
  • api/types/build: move CachePruneOptions type to client.BuildCachePruneOptions. moby/moby#50772
  • api/types/build: move build options to client and backend. moby/moby#50907
  • api/types/build: remove deprecated BuildCache.Parent field. moby/moby#51185
  • api/types/checkpoint: move checkpoint options to client module. moby/moby#50905
  • api/types/container: OnBuild will now be omitted if its value is empty or zero. moby/moby#51154
  • api/types/container: add aliases for go-connections/nat types. moby/moby#50573
  • api/types/container: add missing type for exec-inspect response. moby/moby#50482
  • api/types/container: make ContainerState, HealthStatus concrete types. moby/moby#51439
  • api/types/container: make the container config MacAddress obsolete for v1.52 and onwards. Use network endpoint settings instead. moby/moby#51189
  • api/types/container: merge InspectResponse and ContainerJSONBase. moby/moby#50809
  • api/types/container: move ResizeOptions type to ContainerResizeOptions in the client. moby/moby#50773
  • api/types/container: move StatsResponseReader to client package. moby/moby#50521
  • api/types/container: move container options to client. moby/moby#50897
  • api/types/container: move ExecInspect type to client. moby/moby#50991
  • api/types/container: move StateStatus, NewStateStatus internal again. moby/moby#50495
  • api/types/container: remove deprecated ContainerTopOKBody alias. moby/moby#50400
  • api/types/container: remove deprecated ContainerUpdateOKBody alias. moby/moby#50400
  • api/types/container: remove deprecated Stats type. moby/moby#50492
  • api/types/container: remove deprecated Config.MacAddress. moby/moby#51194
  • api/types/container: remove deprecated ExecOptions.Detach. moby/moby#50959
  • api/types/container: rename Port to PortSummary. moby/moby#50711
  • api/types/container: StatsResponse: add OSType field. moby/moby#51305
  • api/types/container: StatsResponse: cleanup fields and GoDoc. moby/moby#51299
  • api/types/events: move ListOptions type to the client EventsListOptions. moby/moby#50774
  • api/types/filters: remove deprecated ToParamWithVersion. moby/moby#50561
  • api/types/image: InspectResponse: remove deprecated VirtualSize, Container, ContainerConfig, Parent, and DockerVersion fields. moby/moby#51103
  • api/types/image: move image options out to the client. moby/moby#50776
  • api/types/image: move LoadResponse to client. moby/moby#50909
  • api/types/image: remove deprecated Summary.VirtualSize field. moby/moby#51190
  • api/types/network: CreateRequest: remove deprecated CheckDuplicate field. moby/moby#50998
  • api/types/network: define ConnectRequest and DisconnectRequest. moby/moby#51324
  • api/types/network: EndpointSettings: make MacAddress "operational data". moby/moby#51203
  • api/types/network: modernize EndpointIPAMConfig.Copy, EndpointSettings.Copy. moby/moby#50690
  • api/types/network: move CreateOptions, ConnectOptions and DisconnectOptions to the client module. moby/moby#50817
  • api/types/network: move the ListOptions and InspectOptions types to the client. moby/moby#50786
  • api/types/plugin: change ListResponse to a non-pointer slice. moby/moby#51440
  • api/types/plugin: deprecate Config.DockerVersion field. moby/moby#51109
  • api/types/plugin: remove deprecated Config.DockerVersion. moby/moby#51458
  • api/types/registry: add some tests for encoding/decoding authconfig. moby/moby#50392
  • api/types/registry: DecodeAuthConfig: add early returns and improve errors. moby/moby#50425
  • api/types/registry: move SearchOptions to ImageSearchOptions in the client. moby/moby#50787
  • api/types/registry: moved ServiceConfig legacy field marshaling support into daemon backend. moby/moby#50826
  • api/types/registry: moved encode/decode auth config functions into reference utility package. moby/moby#50785
  • api/types/registry: remove deprecated ServiceConfig.AllowNondistributableArtifactsCIDRs and ServiceConfig.AllowNondistributableArtifactsHostnames fields. moby/moby#50375
  • api/types/registry: remove deprecated AuthConfig.Email field. moby/moby#51059
  • api/types/registry: rename AuthenticateOKBody to AuthResponse. moby/moby#51334
  • api/types/storage: add Storage type and integrate in container inspect. moby/moby#50857
  • api/types/strslice: deprecate StrSlice in favor of using a regular []string. moby/moby#50292
  • api/types/strslice: use slices.Equal. moby/moby#50608
  • api/types/swarm: add documentation to clarify virtual IP address type. moby/moby#51155
  • api/types/swarm: create types for enum-consts. moby/moby#51399
  • api/types/swarm: deprecated and dropped support for PortConfigProtocol; use network.IPProtocol instead. moby/moby#51094
  • api/types/swarm: move option types to the client module. moby/moby#50794
  • api/types/swarm: move the SecretListOptions type to the client module. moby/moby#50816
  • api/types/swarm: remove deprecated ServiceSpec.Networks field. moby/moby#51184
  • api/types/system: deprecated top level DiskUsage fields for type specific fields. moby/moby#51235
  • api/types/system: move DiskUsageOptions to the client. moby/moby#50788
  • api/types/system: move SecurityOpt and DecodeSecurityOptions to client module. moby/moby#50825
  • api/types/sytem: remove deprecated DiskUsage.BuilderSize. moby/moby#51180
  • api/types/volume: change ListResponse.Volumes to a non-pointer slice. moby/moby#51454
  • api/types/volume: move CreateOptions to client.VolumeCreateOptions. moby/moby#51211
  • api/types/volume: move the ListOptions type to the client module. moby/moby#50789
  • api/types/volume: moved UpdateOptions into client module. moby/moby#51205
  • api/types: daemon: move the disk usage structs to the backend server. moby/moby#50764
  • api/types: fix godoc. moby/moby#51261
  • api/types: fix Plugin.Config.Interface.Types Swagger definition. moby/moby#50519
  • api/types: move backend types to daemon/server. moby/moby#50534
  • api/types: move client.go contents into moby/moby/client. moby/moby#50510
  • api/types: move disk usage structs to per type packages. moby/moby#51406
  • api/types: move ErrorResponse to common/ErrorResponse. moby/moby#50632
  • api/types: move Ping and swarm.Status to client. moby/moby#51258
  • api/types: move plugin types to api/types/plugin. moby/moby#48114
  • api/types: move Version to api/types/system. moby/moby#51359
  • api/types: remove deprecated aliases. moby/moby#50452
  • api/types: remove PushResult type, and move internal. moby/moby#51357
  • api/types: use regular slices for disk usage types. moby/moby#51412
  • api: bump github.com/google/go-cmp v0.7.0. moby/moby#50723
  • api: deprecate NoBaseImageSpecifier const. This const is no longer used and will be removed in the next release. moby/moby#50437
  • API: Deprecation: the Engine was automatically backfilling empty PortBindings lists with a PortBinding with an empty HostIP and HostPort when starting a container. This behavior is deprecated for API 1.52, and will be dropped in API 1.53. moby/moby#50874
  • api: docs: sync v1.52 yaml. moby/moby#51095
  • api: docs: update v1.52 swagger with latest changes. moby/moby#50796
  • api: fix swarm network field from addr to prefix. moby/moby#51150
  • api: make GraphDriver field in image.InspectResponse optional. This field will continue to be emitted when using the legacy graph drivers and will be omitted when using the containerd image backend. moby/moby#50893
  • api: move "DiskUsage" related types to the right location. moby/moby#50518
  • api: move docs to api module. moby/moby#50491
  • api: redefine container network port types. moby/moby#50710
  • api: remove / internalize LegacyDiskUsage. moby/moby#51437
  • api: remove NoBaseImageSpecifier. moby/moby#50574
  • api: remove image inspect Parent, DockerVersion from swagger docs. moby/moby#51196
  • api: remove references to old module name. moby/moby#50474
  • api: remove unused DefaultVersion, MinSupportedAPIVersion consts. moby/moby#50587
  • api: update "interface{}" to "any". moby/moby#50609
  • apk/pkg/stdcopy: remove use of iota, improve docs, and add example. moby/moby#50612
  • cli/ is not in moby repo (anymore). moby/moby#50537
  • client, api: update go.mod to go1.24. moby/moby#51460
  • client: move ExecStartOptions, ExecAttachOptions, ExecOptions to client. moby/moby#50978
  • client: PluginListResult: change Items field to a non-pointer slice. moby/moby#51440
  • client: remove client.ContainerStatsResult.OSType field. moby/moby#51305
  • client: remove legacy CBC cipher suites from client config. moby/moby#50126
  • Copy the api/types/time package to internal client/daemon packages. moby/moby#50722
  • Create github.com/moby/moby/api and github.com/moby/moby/client module. moby/moby#50280
  • daemon: filter networks before converting to API types. moby/moby#50860
  • deprecate pkg/stdcopy, which was moved to api/stdcopy. moby/moby#50462
  • Deprecate field NetworkSettingsBase.Bridge, struct NetworkSettingsBase, all the fields of DefaultNetworkSettings, and struct DefaultNetworkSettings. moby/moby#50848
  • Dockerfile: update to go-swagger v0.33.1 (for go1.25). moby/moby#51167
  • docs: api: improve the docs of the outputs parameter. moby/moby#50338
  • fix: easiest revive rules. moby/moby#50262
  • GO SDK: api/types/system: remove deprecated Commit.Expected field. moby/moby#51127
  • Inspecting networks with API v1.52 and newer provides statistics about IPAM allocations for the subnets assigned to the network. moby/moby#50917
  • IP addresses and subnets are now of type netip.Addr and netip.Prefix, respectively. moby/moby#50956
  • MAC address fields are represented as byte slices compatible with the standard library net.HardwareAddr type instead of strings. moby/moby#51355
  • Move api server packages to daemon. moby/moby#50004
  • Move jsonmessage, streamformatter, and progress. moby/moby#50565
  • Prefer explicit device driver name over GPU capabilities when selecting the device driver with docker run --gpus. moby/moby#50717
  • Prepare release notes for api/v1.52.0-beta.0. moby/moby#50904
  • Prepare release notes for v1.52.0-alpha.0. moby/moby#50625
  • README: update, add badges. moby/moby#50665
  • remove deprecated types/plugins/logdriver and types/swarm/runtime packages; plugin-runtime spec is now exposed as types/swarm.RuntimeSpec and types/swarm.RuntimePrivilege. moby/moby#50554
  • Remove structs NetworkSettingsBase and DefaultNetworkSettings. Fields in NetworkSettingsBase that were not deprecated are now directly in NetworkSettings. moby/moby#50846
  • Remove support for deprecated kernel memory limit. moby/moby#50989
  • Rename disk usage API fields. moby/moby#51428
  • Revert "api/types/registry: EncodeAuthConfig: use empty string for zero value". moby/moby#50583
  • Swagger definitions for NetworkSummary and NetworkInspect have been added to the Swagger spec describing the Engine API. moby/moby#50855
  • 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. moby/moby#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. moby/moby#50878
  • Update API version to 1.52. moby/moby#50418
  • update github and pkg.go.dev links. moby/moby#50590