runconfig: deprecate ContainerConfigWrapper, move to api/types/container

thaJeztah · thaJeztah · commit c692af36c302 · 2024-06-17T00:26:46.000+02:00
Move the type to api/types/container.CreateRequest, together with other
types used by the container API endpoints.

The Decoder, and related validation code is kept in the runconfig package
for now, but should likely be moved elsewhere (inside the API).

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/api/types/container/create_request.go b/api/types/container/create_request.go
@@ -0,0 +1,13 @@
+package container
+
+import "github.com/docker/docker/api/types/network"
+
+// CreateRequest is the request message sent to the server for container
+// create calls. It is a config wrapper that holds the container [Config]
+// (portable) and the corresponding [HostConfig] (non-portable) and
+// [network.NetworkingConfig].
+type CreateRequest struct {
+	*Config
+	HostConfig       *HostConfig               `json:"HostConfig,omitempty"`
+	NetworkingConfig *network.NetworkingConfig `json:"NetworkingConfig,omitempty"`
+}
diff --git a/runconfig/config.go b/runconfig/config.go
@@ -12,11 +12,9 @@ import (
 
 // ContainerConfigWrapper is a Config wrapper that holds the container Config (portable)
 // and the corresponding HostConfig (non-portable).
-type ContainerConfigWrapper struct {
-	*container.Config
-	HostConfig       *container.HostConfig     `json:"HostConfig,omitempty"`
-	NetworkingConfig *network.NetworkingConfig `json:"NetworkingConfig,omitempty"`
-}
+//
+// Deprecated: use [container.CreateRequest].
+type ContainerConfigWrapper = container.CreateRequest
 
 // ContainerDecoder implements httputils.ContainerDecoder
 // calling DecodeContainerConfig.
@@ -43,7 +41,7 @@ func (r ContainerDecoder) DecodeConfig(src io.Reader) (*container.Config, *conta
 // Be aware this function is not checking whether the resulted structs are nil,
 // it's your business to do so
 func decodeContainerConfig(src io.Reader, si *sysinfo.SysInfo) (*container.Config, *container.HostConfig, *network.NetworkingConfig, error) {
-	var w ContainerConfigWrapper
+	var w container.CreateRequest
 	if err := loadJSON(src, &w); err != nil {
 		return nil, nil, nil, err
 	}
diff --git a/runconfig/config_test.go b/runconfig/config_test.go
@@ -122,7 +122,7 @@ func callDecodeContainerConfigIsolation(isolation string) (*container.Config, *c
 		b   []byte
 		err error
 	)
-	w := ContainerConfigWrapper{
+	w := container.CreateRequest{
 		Config: &container.Config{},
 		HostConfig: &container.HostConfig{
 			NetworkMode: "none",

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ func callDecodeContainerConfigIsolation(isolation string) (container.Config, c`
`122`	`122`	`b []byte`
`123`	`123`	`err error`
`124`	`124`	`)`
`125`		`- w := ContainerConfigWrapper{`
	`125`	`+ w := container.CreateRequest{`
`126`	`126`	`Config: &container.Config{},`
`127`	`127`	`HostConfig: &container.HostConfig{`
`128`	`128`	`NetworkMode: "none",`