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

thaJeztah · thaJeztah · commit 84ffc644ef47 · 2024-07-02T12:46:48.000+02:00
This moves the `ContainerState` type to the container package,
renames it to `State`, and deprecates the old location.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/api/types/container/container.go b/api/types/container/container.go
@@ -88,3 +88,20 @@ type MountPoint struct {
 	// This field is not used on Windows.
 	Propagation mount.Propagation
 }
+
+// State stores container's running state
+// it's part of ContainerJSONBase and will return by "inspect" command
+type State struct {
+	Status     string // String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"
+	Running    bool
+	Paused     bool
+	Restarting bool
+	OOMKilled  bool
+	Dead       bool
+	Pid        int
+	ExitCode   int
+	Error      string
+	StartedAt  string
+	FinishedAt string
+	Health     *Health `json:",omitempty"`
+}
diff --git a/api/types/types.go b/api/types/types.go
@@ -87,31 +87,14 @@ type Version struct {
 	BuildTime     string `json:",omitempty"`
 }
 
-// ContainerState stores container's running state
-// it's part of ContainerJSONBase and will return by "inspect" command
-type ContainerState struct {
-	Status     string // String representation of the container state. Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"
-	Running    bool
-	Paused     bool
-	Restarting bool
-	OOMKilled  bool
-	Dead       bool
-	Pid        int
-	ExitCode   int
-	Error      string
-	StartedAt  string
-	FinishedAt string
-	Health     *container.Health `json:",omitempty"`
-}
-
 // ContainerJSONBase contains response of Engine API:
 // GET "/containers/{name:.*}/json"
 type ContainerJSONBase struct {
 	ID              string `json:"Id"`
 	Created         string
 	Path            string
 	Args            []string
-	State           *ContainerState
+	State           *container.State
 	Image           string
 	ResolvConfPath  string
 	HostnamePath    string
diff --git a/api/types/types_deprecated.go b/api/types/types_deprecated.go
@@ -210,6 +210,11 @@ type ContainerNode struct {
 	Labels    map[string]string
 }
 
+// ContainerState stores container's running state
+//
+// Deprecated: use [container.State].
+type ContainerState = container.State
+
 // NetworkSettings exposes the network settings in the api.
 //
 // Deprecated: use [container.NetworkSettings].
diff --git a/daemon/inspect.go b/daemon/inspect.go
@@ -146,7 +146,7 @@ func (daemon *Daemon) getInspectData(daemonCfg *config.Config, container *contai
 		}
 	}
 
-	containerState := &types.ContainerState{
+	containerState := &containertypes.State{
 		Status:     container.State.StateString(),
 		Running:    container.State.Running,
 		Paused:     container.State.Paused,

Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ func (daemon Daemon) getInspectData(daemonCfg config.Config, container *contai`
`146`	`146`	`}`
`147`	`147`	`}`
`148`	`148`
`149`		`- containerState := &types.ContainerState{`
	`149`	`+ containerState := &containertypes.State{`
`150`	`150`	`Status: container.State.StateString(),`
`151`	`151`	`Running: container.State.Running,`
`152`	`152`	`Paused: container.State.Paused,`