api/types: migrate more types to separate packages by thaJeztah · Pull Request #48057 · moby/moby

thaJeztah · 2024-06-25T22:14:06Z

follow-up to / stacked on api/types: deprecate ContainerJSONBase.Node, ContainerNode #48055

api/types: move container-networksettings types to api/types/container

This moves the NetworkSettings, NetworkSettingsBase, DefaultNetworkSettings,
and SummaryNetworkSettings types to the api/types/container package, and
deprecates the old location.

api/types: move container Health types to api/types/container

This moves the Health and HealthcheckResult types to the container package,
as well as the related NoHealthcheck, Starting, Healthy, and Unhealthy
consts.

api/types: move MountPoint to api/types/container

This moves the MountPoint type to the container package, and
deprecates the old location.

api/types: move Port to api/types/container

This moves the Port type to the container package, and
deprecates the old location.

api/types: move GraphDriverData to api/types/storage

The GraphDriverData type is shared between images and containers, and
putting it in either package would result in a circular import, so adding
a new package for this type.

api/types: move ImageInspect and RootFS to api/types/image

This moves the ImageInspect and RootFS types to the image package,
and deprecates the old location.

api/types: move ContainerState to api/types/image

This moves the ContainerState type to the container package,
renames it to State, and deprecates the old location.

api/types: move Container to api/types/container

This moves the Container type to the image package, rename it to
Summary, and deprecates the old location.

api/types: move container-inspect types to api/types/container

This moves the ContainerJSONBase, ContainerJSON and ContainerNode
types to the api/types/container package and deprecates the old location.

ContainerJSONBase was renamed to Base
ContainerJSON was rnamed to InspectResponse

- What I did

- How I did it

- How to verify it

- Description for the changelog

- move `api/types.NetworkSettings` to `api/types/container.NetworkSettings`
- move `api/types.NetworkSettingsBase` to `api/types/container.NetworkSettingsBase`
- move `api/types.DefaultNetworkSettings` to `api/types/container.DefaultNetworkSettings`
- move `api/types.SummaryNetworkSettings` to `api/types/container.NetworkSettingsSummary`
- move `api/types.Health` to `api/types/container.Health`
- move `api/types.HealthcheckResult` to `api/types/container.HealthcheckResult`
  move the `NoHealthcheck`, `Starting`, `Healthy`, and `Unhealthy` consts
  from api/types to api/types/container
- move `api/types.MountPoint` to `api/types/container.MountPoint`
- move `api/types.Port` to `api/types/container.Port`
- move `api/types.GraphDriverData` type to`api/types/storage.DriverData`
- move `api/types.ImageInspect` to `api/types/image.InspectResponse`
- move `api/types.RootFS` to `api/types/image.RootFS`
- move `api/types.ContainerState` to `api/types/container.State`
- move `api/types.Container` to `api/types/container.Summary`
- move `api/types.ContainerJSONBase` to `api/types/container.InspectBase`
- move `api/types.ContainerJSON` to `api/types/container.InspectResponse`
- move `api/types.ContainerNode` to `api/types/container`. This type is deprecated
  and will be removed in the next release.

- A picture of a cute animal (not mandatory but encouraged)

api/types/types_deprecated.go

vvoland · 2024-07-02T08:09:53Z

api/types/container/network_settings.go

+
+// DefaultNetworkSettings holds network information
+// during the 2 release deprecation period.
+// It will be removed in Docker 1.11.


🙈
Should we remove that comment?

LOL, I kept it as a reminding "why the h*ck didn't we still do that?". I know Albin was working on some of that, so I kept it for now.

Yeah, we need to discuss what we do with #45945. Ideally, we should not include this struct in newer API versions as it polutes the output of docker inspect.

vvoland · 2024-07-02T08:32:10Z

api/types/container/container.go

+// ContainerJSONBase contained all fields for API < 1.19, and InspectResponse
+// held fields that were added in API 1.19 and up. Given that the minimum
+// supported API version is now 1.24, we no longer use the separate type.
+type Base struct {


Nit: InspectBase would be slightly better IMO. Mainly because it's coupled with InspectResponse and we'd like to combine them anyway.

Good suggestion!

Updated 👍

vvoland · 2024-07-02T08:33:36Z

api/types/container/container.go

+// for API version 1.18 and older.
+//
+// TODO(thaJeztah): combine Base and InspectResponse into a single struct.
+// The split between Base (ContainerJSONBase) and InspecResponse (InspectResponse)


Suggested change

// The split between Base (ContainerJSONBase) and InspecResponse (InspectResponse)

// The split between Base (ContainerJSONBase) and InspectResponse (InspectResponse)

nit: typo

laurazard

LGTM! (+1 on @vvoland's nits)

This moves the NetworkSettings, NetworkSettingsBase, DefaultNetworkSettings, and SummaryNetworkSettings types to the api/types/container package, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

This moves the `Health` and `HealthcheckResult` types to the container package, as well as the related `NoHealthcheck`, `Starting`, `Healthy`, and `Unhealthy` consts. Signed-off-by: Sebastiaan van Stijn <[email protected]>

This moves the `MountPoint` type to the container package, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

This moves the `Port` type to the container package, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

The `GraphDriverData` type is shared between images and containers, and putting it in either package would result in a circular import, so adding a new package for this type. Signed-off-by: Sebastiaan van Stijn <[email protected]>

This moves the `ImageInspect` and `RootFS` types to the image package, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

This moves the `ContainerState` type to the container package, renames it to `State`, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

This moves the `Container` type to the containere package, rename it to `Summary`, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

This moves the `ContainerJSONBase`, `ContainerJSON` and `ContainerNode` types to the api/types/container package and deprecates the old location. - `ContainerJSONBase` was renamed to `InspectBase` - `ContainerJSON` was rnamed to `InspectResponse` Signed-off-by: Sebastiaan van Stijn <[email protected]>

thaJeztah changed the title ~~Migrate more types~~ api/types: migrate more types to separate packages Jun 25, 2024

thaJeztah commented Jun 25, 2024

View reviewed changes

api/types/types_deprecated.go Outdated Show resolved Hide resolved

thaJeztah force-pushed the migrate_more_types branch 3 times, most recently from d46c4f3 to a4f4283 Compare June 26, 2024 21:05

thaJeztah added area/api API area/go-sdk impact/go-sdk Noteworthy (compatibility changes) in the Go SDK status/2-code-review impact/deprecation labels Jun 26, 2024

thaJeztah modified the milestone: 28.0.0 Jun 26, 2024

thaJeztah marked this pull request as ready for review June 26, 2024 21:06

thaJeztah requested a review from tianon as a code owner June 26, 2024 21:06

thaJeztah self-assigned this Jun 27, 2024

thaJeztah mentioned this pull request Jul 1, 2024

api/types: remove aliases for deprecated types #48107

Merged

1 task

thaJeztah added the kind/refactor PR's that refactor, or clean-up code label Jul 1, 2024

vvoland approved these changes Jul 2, 2024

View reviewed changes

laurazard approved these changes Jul 2, 2024

View reviewed changes

thaJeztah added 6 commits July 2, 2024 12:46

api/types: move container Health types to api/types/container

c130ce1

This moves the `Health` and `HealthcheckResult` types to the container package, as well as the related `NoHealthcheck`, `Starting`, `Healthy`, and `Unhealthy` consts. Signed-off-by: Sebastiaan van Stijn <[email protected]>

api/types: move MountPoint to api/types/container

5517322

This moves the `MountPoint` type to the container package, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

api/types: move Port to api/types/container

e12b749

This moves the `Port` type to the container package, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

api/types: move GraphDriverData to api/types/storage

da039ca

The `GraphDriverData` type is shared between images and containers, and putting it in either package would result in a circular import, so adding a new package for this type. Signed-off-by: Sebastiaan van Stijn <[email protected]>

api/types: move ImageInspect and RootFS to api/types/image

7053007

This moves the `ImageInspect` and `RootFS` types to the image package, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

thaJeztah added 3 commits July 2, 2024 12:46

api/types: move ContainerState to api/types/image

84ffc64

This moves the `ContainerState` type to the container package, renames it to `State`, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

api/types: move Container to api/types/container

05b0e65

This moves the `Container` type to the containere package, rename it to `Summary`, and deprecates the old location. Signed-off-by: Sebastiaan van Stijn <[email protected]>

thaJeztah force-pushed the migrate_more_types branch from a4f4283 to 1abc8f6 Compare July 2, 2024 10:50

krissetto approved these changes Jul 2, 2024

View reviewed changes

vvoland approved these changes Jul 2, 2024

View reviewed changes

vvoland merged commit d071d70 into moby:master Jul 2, 2024

thaJeztah deleted the migrate_more_types branch July 2, 2024 12:16

thaJeztah mentioned this pull request Jul 3, 2024

api/types/container: InspectResponse: keep old name for embedded type #48124

Merged

thaJeztah mentioned this pull request Sep 12, 2024

[27.x backport] c8d/prune: Keep the last tagged image instead of creating dangling image #48488

Merged

sorindumitru mentioned this pull request Feb 21, 2025

Bump github.com/docker/docker from 27.5.1+incompatible to 28.0.0+incompatible spiffe/spire#5890

Merged

thaJeztah mentioned this pull request Jul 20, 2025

api/types: remove deprecated aliases #50452

Merged

DmitriyLewen mentioned this pull request Feb 17, 2026

chore(deps): update Docker client SDK to v29 aquasecurity/trivy#10202

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api/types: migrate more types to separate packages#48057

api/types: migrate more types to separate packages#48057
vvoland merged 9 commits intomoby:masterfrom
thaJeztah:migrate_more_types

thaJeztah commented Jun 25, 2024 •

edited

Loading

Uh oh!

Uh oh!

vvoland Jul 2, 2024

Uh oh!

thaJeztah Jul 2, 2024

Uh oh!

akerouanton Jul 2, 2024

Uh oh!

vvoland Jul 2, 2024

Uh oh!

thaJeztah Jul 2, 2024

Uh oh!

thaJeztah Jul 2, 2024

Uh oh!

vvoland Jul 2, 2024

Uh oh!

thaJeztah Jul 2, 2024

Uh oh!

laurazard left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	// The split between Base (ContainerJSONBase) and InspecResponse (InspectResponse)
	// The split between Base (ContainerJSONBase) and InspectResponse (InspectResponse)

Conversation

thaJeztah commented Jun 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

api/types: move container-networksettings types to api/types/container

api/types: move container Health types to api/types/container

api/types: move MountPoint to api/types/container

api/types: move Port to api/types/container

api/types: move GraphDriverData to api/types/storage

api/types: move ImageInspect and RootFS to api/types/image

api/types: move ContainerState to api/types/image

api/types: move Container to api/types/container

api/types: move container-inspect types to api/types/container

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

laurazard left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

thaJeztah commented Jun 25, 2024 •

edited

Loading