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

thaJeztah · thaJeztah · commit e12b7493b9f5 · 2024-07-02T12:46:47.000+02:00
This moves the `Port` type to the container package, and
deprecates the old location.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/api/types/container/port.go b/api/types/container/port.go
@@ -1,4 +1,4 @@
-package types
+package container
 
 // This file was generated by the swagger tool.
 // Editing this file might prove futile when you re-run the swagger generate command
diff --git a/api/types/types.go b/api/types/types.go
@@ -143,7 +143,7 @@ type Container struct {
 	ImageID    string
 	Command    string
 	Created    int64
-	Ports      []Port
+	Ports      []container.Port
 	SizeRw     int64 `json:",omitempty"`
 	SizeRootFs int64 `json:",omitempty"`
 	Labels     map[string]string
diff --git a/api/types/types_deprecated.go b/api/types/types_deprecated.go
@@ -255,3 +255,8 @@ type HealthcheckResult = container.HealthcheckResult
 //
 // Deprecated: use [container.MountPoint].
 type MountPoint = container.MountPoint
+
+// Port An open port on a container
+//
+// Deprecated: use [container.Port].
+type Port = container.Port
diff --git a/container/view.go b/container/view.go
@@ -310,7 +310,7 @@ func (v *View) transform(ctr *Container) *Snapshot {
 			ID:      ctr.ID,
 			Names:   v.getNames(ctr.ID),
 			ImageID: ctr.ImageID.String(),
-			Ports:   []types.Port{},
+			Ports:   []container.Port{},
 			Mounts:  ctr.GetMountPoints(),
 			State:   ctr.State.StateString(),
 			Status:  ctr.State.String(),
@@ -366,7 +366,7 @@ func (v *View) transform(ctr *Container) *Snapshot {
 		snapshot.Command = ctr.Path
 	}
 
-	snapshot.Ports = []types.Port{}
+	snapshot.Ports = []container.Port{}
 	networks := make(map[string]*network.EndpointSettings)
 	if ctr.NetworkSettings != nil {
 		for name, netw := range ctr.NetworkSettings.Networks {
@@ -398,7 +398,7 @@ func (v *View) transform(ctr *Container) *Snapshot {
 				continue
 			}
 			if len(bindings) == 0 {
-				snapshot.Ports = append(snapshot.Ports, types.Port{
+				snapshot.Ports = append(snapshot.Ports, container.Port{
 					PrivatePort: uint16(p),
 					Type:        port.Proto(),
 				})
@@ -410,7 +410,7 @@ func (v *View) transform(ctr *Container) *Snapshot {
 					log.G(context.TODO()).WithError(err).Warn("invalid host port map")
 					continue
 				}
-				snapshot.Ports = append(snapshot.Ports, types.Port{
+				snapshot.Ports = append(snapshot.Ports, container.Port{
 					PrivatePort: uint16(p),
 					PublicPort:  uint16(h),
 					Type:        port.Proto(),
diff --git a/hack/generate-swagger-api.sh b/hack/generate-swagger-api.sh
@@ -10,16 +10,16 @@ swagger generate model -f api/swagger.yaml \
 	-n PluginDevice \
 	-n PluginMount \
 	-n PluginEnv \
-	-n PluginInterfaceType \
-	-n Port
+	-n PluginInterfaceType
 
 swagger generate model -f api/swagger.yaml \
 	-t api -m types/container --skip-validator -C api/swagger-gen.yaml \
 	-n ContainerCreateResponse \
 	-n ContainerWaitResponse \
 	-n ContainerWaitExitError \
 	-n ChangeType \
-	-n FilesystemChange
+	-n FilesystemChange \
+	-n Port
 
 swagger generate model -f api/swagger.yaml \
 	-t api -m types/image --skip-validator -C api/swagger-gen.yaml \

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package types`
	`1`	`+package container`
`2`	`2`
`3`	`3`	`// This file was generated by the swagger tool.`
`4`	`4`	`// Editing this file might prove futile when you re-run the swagger generate command`