Use IDResponse for container create response.

dnephin · dnephin · commit c8d5e7203e1a · 2016-10-31T11:16:02.000-04:00
Signed-off-by: Daniel Nephin &lt;dnephin@docker.com&gt;
diff --git a/api/server/router/image/image_routes.go b/api/server/router/image/image_routes.go
@@ -63,7 +63,7 @@ func (s *imageRouter) postCommit(ctx context.Context, w http.ResponseWriter, r *
 		return err
 	}
 
-	return httputils.WriteJSON(w, http.StatusCreated, &types.ContainerCommitResponse{
+	return httputils.WriteJSON(w, http.StatusCreated, &types.IDResponse{
 		ID: string(imgID),
 	})
 }
diff --git a/api/swagger.yaml b/api/swagger.yaml
@@ -4937,14 +4937,7 @@ paths:
         201:
           description: "no error"
           schema:
-            type: "object"
-            properties:
-              Id:
-                description: "The ID of the image created"
-                type: "string"
-          examples:
-            application/json:
-              Id: "596069db4bf5"
+            $ref: "#/definitions/IdResponse"
         404:
           description: "no such container"
           schema:
diff --git a/api/types/types.go b/api/types/types.go
@@ -38,12 +38,6 @@ type ContainerWaitResponse struct {
 	StatusCode int `json:"StatusCode"`
 }
 
-// ContainerCommitResponse contains response of Remote API:
-// POST "/commit?container="+containerID
-type ContainerCommitResponse struct {
-	ID string `json:"Id"`
-}
-
 // ContainerChange contains response of Remote API:
 // GET "/containers/{name:.*}/changes"
 type ContainerChange struct {
diff --git a/client/container_commit.go b/client/container_commit.go
@@ -12,16 +12,16 @@ import (
 )
 
 // ContainerCommit applies changes into a container and creates a new tagged image.
-func (cli *Client) ContainerCommit(ctx context.Context, container string, options types.ContainerCommitOptions) (types.ContainerCommitResponse, error) {
+func (cli *Client) ContainerCommit(ctx context.Context, container string, options types.ContainerCommitOptions) (types.IDResponse, error) {
 	var repository, tag string
 	if options.Reference != "" {
 		distributionRef, err := distreference.ParseNamed(options.Reference)
 		if err != nil {
-			return types.ContainerCommitResponse{}, err
+			return types.IDResponse{}, err
 		}
 
 		if _, isCanonical := distributionRef.(distreference.Canonical); isCanonical {
-			return types.ContainerCommitResponse{}, errors.New("refusing to create a tag with a digest reference")
+			return types.IDResponse{}, errors.New("refusing to create a tag with a digest reference")
 		}
 
 		tag = reference.GetTagFromNamedRef(distributionRef)
@@ -41,7 +41,7 @@ func (cli *Client) ContainerCommit(ctx context.Context, container string, option
 		query.Set("pause", "0")
 	}
 
-	var response types.ContainerCommitResponse
+	var response types.IDResponse
 	resp, err := cli.post(ctx, "/commit", query, options.Config, nil)
 	if err != nil {
 		return response, err
diff --git a/client/container_commit_test.go b/client/container_commit_test.go
@@ -67,7 +67,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.ContainerCommitResponse{
+			b, err := json.Marshal(types.IDResponse{
 				ID: "new_container_id",
 			})
 			if err != nil {
diff --git a/client/interface.go b/client/interface.go
@@ -33,7 +33,7 @@ type CommonAPIClient interface {
 // ContainerAPIClient defines API client methods for the containers
 type ContainerAPIClient interface {
 	ContainerAttach(ctx context.Context, container string, options types.ContainerAttachOptions) (types.HijackedResponse, error)
-	ContainerCommit(ctx context.Context, container string, options types.ContainerCommitOptions) (types.ContainerCommitResponse, error)
+	ContainerCommit(ctx context.Context, container string, options types.ContainerCommitOptions) (types.IDResponse, error)
 	ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, containerName string) (container.ContainerCreateCreatedBody, error)
 	ContainerDiff(ctx context.Context, container string) ([]types.ContainerChange, error)
 	ContainerExecAttach(ctx context.Context, execID string, config types.ExecConfig) (types.HijackedResponse, error)

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ func (s imageRouter) postCommit(ctx context.Context, w http.ResponseWriter, r `
`63`	`63`	`return err`
`64`	`64`	`}`
`65`	`65`
`66`		`- return httputils.WriteJSON(w, http.StatusCreated, &types.ContainerCommitResponse{`
	`66`	`+ return httputils.WriteJSON(w, http.StatusCreated, &types.IDResponse{`
`67`	`67`	`ID: string(imgID),`
`68`	`68`	`})`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,16 +12,16 @@ import (`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`// ContainerCommit applies changes into a container and creates a new tagged image.`
`15`		`-func (cli *Client) ContainerCommit(ctx context.Context, container string, options types.ContainerCommitOptions) (types.ContainerCommitResponse, error) {`
	`15`	`+func (cli *Client) ContainerCommit(ctx context.Context, container string, options types.ContainerCommitOptions) (types.IDResponse, error) {`
`16`	`16`	`var repository, tag string`
`17`	`17`	`if options.Reference != "" {`
`18`	`18`	`distributionRef, err := distreference.ParseNamed(options.Reference)`
`19`	`19`	`if err != nil {`
`20`		`- return types.ContainerCommitResponse{}, err`
	`20`	`+ return types.IDResponse{}, err`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`if _, isCanonical := distributionRef.(distreference.Canonical); isCanonical {`
`24`		`- return types.ContainerCommitResponse{}, errors.New("refusing to create a tag with a digest reference")`
	`24`	`+ return types.IDResponse{}, errors.New("refusing to create a tag with a digest reference")`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`tag = reference.GetTagFromNamedRef(distributionRef)`
`@@ -41,7 +41,7 @@ func (cli *Client) ContainerCommit(ctx context.Context, container string, option`
`41`	`41`	`query.Set("pause", "0")`
`42`	`42`	`}`
`43`	`43`
`44`		`- var response types.ContainerCommitResponse`
	`44`	`+ var response types.IDResponse`
`45`	`45`	`resp, err := cli.post(ctx, "/commit", query, options.Config, nil)`
`46`	`46`	`if err != nil {`
`47`	`47`	`return response, err`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ func TestContainerCommit(t *testing.T) {`
`67`	`67`	`if len(changes) != len(expectedChanges) {`
`68`	`68`	`return nil, fmt.Errorf("expected container changes size to be '%d', got %d", len(expectedChanges), len(changes))`
`69`	`69`	`}`
`70`		`- b, err := json.Marshal(types.ContainerCommitResponse{`
	`70`	`+ b, err := json.Marshal(types.IDResponse{`
`71`	`71`	`ID: "new_container_id",`
`72`	`72`	`})`
`73`	`73`	`if err != nil {`