api/types/container: introduce CommitResponse type

thaJeztah · thaJeztah · commit 0df3a0047af4 · 2025-02-10T21:14:03.000+01:00
Move api/types.IDResponse to a "common" package (to prevent cyclic import
issues), and introduce a container.CommitResponse type as alias. This allows
consumers to use ContainerCommit without having to import the "types" package,
and allows us to differentiate the response for container commit separate from
other endpoints currently using IDResponse.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/api/server/router/container/container_routes.go b/api/server/router/container/container_routes.go
@@ -71,7 +71,7 @@ func (c *containerRouter) postCommit(ctx context.Context, w http.ResponseWriter,
 		return err
 	}
 
-	return httputils.WriteJSON(w, http.StatusCreated, &types.IDResponse{ID: imgID})
+	return httputils.WriteJSON(w, http.StatusCreated, &container.CommitResponse{ID: imgID})
 }
 
 func (c *containerRouter) getContainersJSON(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -2908,9 +2908,10 @@ definitions:
     example:
       message: "Something went wrong."
 
-  IdResponse:
+  IDResponse:
     description: "Response to an API call that returns just an Id"
     type: "object"
+    x-go-name: "IDResponse"
     required: ["Id"]
     properties:
       Id:
@@ -10220,7 +10221,7 @@ paths:
         201:
           description: "no error"
           schema:
-            $ref: "#/definitions/IdResponse"
+            $ref: "#/definitions/IDResponse"
         404:
           description: "no such container"
           schema:
@@ -10614,7 +10615,7 @@ paths:
         201:
           description: "no error"
           schema:
-            $ref: "#/definitions/IdResponse"
+            $ref: "#/definitions/IDResponse"
         404:
           description: "no such container"
           schema:
@@ -13094,7 +13095,7 @@ paths:
         201:
           description: "no error"
           schema:
-            $ref: "#/definitions/IdResponse"
+            $ref: "#/definitions/IDResponse"
         409:
           description: "name conflicts with an existing object"
           schema:
@@ -13301,7 +13302,7 @@ paths:
         201:
           description: "no error"
           schema:
-            $ref: "#/definitions/IdResponse"
+            $ref: "#/definitions/IDResponse"
         409:
           description: "name conflicts with an existing object"
           schema:
diff --git a/api/types/common/id_response.go b/api/types/common/id_response.go
@@ -1,10 +1,10 @@
-package types
+package common
 
 // This file was generated by the swagger tool.
 // Editing this file might prove futile when you re-run the swagger generate command
 
 // IDResponse Response to an API call that returns just an Id
-// swagger:model IdResponse
+// swagger:model IDResponse
 type IDResponse struct {
 
 	// The id of the newly created object.
diff --git a/api/types/container/commit.go b/api/types/container/commit.go
@@ -0,0 +1,7 @@
+package container
+
+import "github.com/docker/docker/api/types/common"
+
+// CommitResponse response for the commit API call, containing the ID of the
+// image that was produced.
+type CommitResponse = common.IDResponse
diff --git a/api/types/types_deprecated.go b/api/types/types_deprecated.go
@@ -3,11 +3,15 @@ package types
 import (
 	"context"
 
+	"github.com/docker/docker/api/types/common"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/image"
 	"github.com/docker/docker/api/types/storage"
 )
 
+// IDResponse Response to an API call that returns just an Id
+type IDResponse = common.IDResponse
+
 // ContainerJSONBase contains response of Engine API GET "/containers/{name:.*}/json"
 // for API version 1.18 and older.
 //
diff --git a/client/client_interfaces.go b/client/client_interfaces.go
@@ -69,7 +69,7 @@ type HijackDialer interface {
 // ContainerAPIClient defines API client methods for the containers
 type ContainerAPIClient interface {
 	ContainerAttach(ctx context.Context, container string, options container.AttachOptions) (types.HijackedResponse, error)
-	ContainerCommit(ctx context.Context, container string, options container.CommitOptions) (types.IDResponse, error)
+	ContainerCommit(ctx context.Context, container string, options container.CommitOptions) (container.CommitResponse, error)
 	ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *ocispec.Platform, containerName string) (container.CreateResponse, error)
 	ContainerDiff(ctx context.Context, container string) ([]container.FilesystemChange, error)
 	ContainerExecAttach(ctx context.Context, execID string, options container.ExecAttachOptions) (types.HijackedResponse, error)
diff --git a/client/container_commit.go b/client/container_commit.go
@@ -7,26 +7,25 @@ import (
 	"net/url"
 
 	"github.com/distribution/reference"
-	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 )
 
 // ContainerCommit applies changes to a container and creates a new tagged image.
-func (cli *Client) ContainerCommit(ctx context.Context, containerID string, options container.CommitOptions) (types.IDResponse, error) {
+func (cli *Client) ContainerCommit(ctx context.Context, containerID string, options container.CommitOptions) (container.CommitResponse, error) {
 	containerID, err := trimID("container", containerID)
 	if err != nil {
-		return types.IDResponse{}, err
+		return container.CommitResponse{}, err
 	}
 
 	var repository, tag string
 	if options.Reference != "" {
 		ref, err := reference.ParseNormalizedNamed(options.Reference)
 		if err != nil {
-			return types.IDResponse{}, err
+			return container.CommitResponse{}, err
 		}
 
 		if _, isCanonical := ref.(reference.Canonical); isCanonical {
-			return types.IDResponse{}, errors.New("refusing to create a tag with a digest reference")
+			return container.CommitResponse{}, errors.New("refusing to create a tag with a digest reference")
 		}
 		ref = reference.TagNameOnly(ref)
 
@@ -49,7 +48,7 @@ func (cli *Client) ContainerCommit(ctx context.Context, containerID string, opti
 		query.Set("pause", "0")
 	}
 
-	var response types.IDResponse
+	var response container.CommitResponse
 	resp, err := cli.post(ctx, "/commit", query, options.Config, nil)
 	defer ensureReaderClosed(resp)
 	if err != nil {
diff --git a/client/container_commit_test.go b/client/container_commit_test.go
@@ -10,7 +10,6 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/errdefs"
 	"gotest.tools/v3/assert"
@@ -77,7 +76,7 @@ func TestContainerCommit(t *testing.T) {
 			if len(changes) != len(expectedChanges) {
 				return nil, fmt.Errorf("expected container changes size to be '%d', got %d", len(expectedChanges), len(changes))
 			}
-			b, err := json.Marshal(types.IDResponse{
+			b, err := json.Marshal(container.CommitResponse{
 				ID: "new_container_id",
 			})
 			if err != nil {
diff --git a/hack/generate-swagger-api.sh b/hack/generate-swagger-api.sh
@@ -4,13 +4,16 @@ set -eu
 swagger generate model -f api/swagger.yaml \
 	-t api -m types --skip-validator -C api/swagger-gen.yaml \
 	-n ErrorResponse \
-	-n IdResponse \
 	-n Plugin \
 	-n PluginDevice \
 	-n PluginMount \
 	-n PluginEnv \
 	-n PluginInterfaceType
 
+swagger generate model -f api/swagger.yaml \
+	-t api -m types/common --skip-validator -C api/swagger-gen.yaml \
+	-n IDResponse
+
 swagger generate model -f api/swagger.yaml \
 	-t api -m types/storage --skip-validator -C api/swagger-gen.yaml \
 	-n DriverData

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ func (c *containerRouter) postCommit(ctx context.Context, w http.ResponseWriter,`
`71`	`71`	`return err`
`72`	`72`	`}`
`73`	`73`
`74`		`- return httputils.WriteJSON(w, http.StatusCreated, &types.IDResponse{ID: imgID})`
	`74`	`+ return httputils.WriteJSON(w, http.StatusCreated, &container.CommitResponse{ID: imgID})`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`func (c containerRouter) getContainersJSON(ctx context.Context, w http.ResponseWriter, r http.Request, vars map[string]string) error {`