diff --git a/api/server/router/container/container_routes.go b/api/server/router/container/container_routes.go index be6e06a4d1..cfa6838772 100644 --- a/api/server/router/container/container_routes.go +++ b/api/server/router/container/container_routes.go @@ -397,12 +397,12 @@ func (s *containerRouter) postContainersWait(ctx context.Context, w http.Respons return nil } - var waitError *container.ContainerWaitOKBodyError + var waitError *container.WaitExitError if status.Err() != nil { - waitError = &container.ContainerWaitOKBodyError{Message: status.Err().Error()} + waitError = &container.WaitExitError{Message: status.Err().Error()} } - return json.NewEncoder(w).Encode(&container.ContainerWaitOKBody{ + return json.NewEncoder(w).Encode(&container.WaitResponse{ StatusCode: int64(status.ExitCode()), Error: waitError, }) diff --git a/api/swagger.yaml b/api/swagger.yaml index 8554f90022..b418cd2f1f 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -4619,7 +4619,7 @@ definitions: ContainerWaitResponse: description: "OK response to ContainerWait operation" type: "object" - x-go-name: "ContainerWaitOKBody" + x-go-name: "WaitResponse" title: "ContainerWaitResponse" required: [StatusCode, Error] properties: @@ -4633,7 +4633,7 @@ definitions: ContainerWaitExitError: description: "container waiting error, if any" type: "object" - x-go-name: "ContainerWaitOKBodyError" + x-go-name: "WaitExitError" properties: Message: description: "Details of an error" diff --git a/api/types/container/deprecated.go b/api/types/container/deprecated.go new file mode 100644 index 0000000000..bf6e0ba11a --- /dev/null +++ b/api/types/container/deprecated.go @@ -0,0 +1,11 @@ +package container // import "github.com/docker/docker/api/types/container" + +// ContainerWaitOKBody OK response to ContainerWait operation +// +// Deprecated: use WaitResponse +type ContainerWaitOKBody = WaitResponse + +// ContainerWaitOKBodyError container waiting error, if any +// +// Deprecated: use WaitExitError +type ContainerWaitOKBodyError = WaitExitError diff --git a/api/types/container/container_wait_o_k_body_error.go b/api/types/container/wait_exit_error.go similarity index 61% rename from api/types/container/container_wait_o_k_body_error.go rename to api/types/container/wait_exit_error.go index ee598973ec..ab56d4eed8 100644 --- a/api/types/container/container_wait_o_k_body_error.go +++ b/api/types/container/wait_exit_error.go @@ -3,9 +3,9 @@ package container // This file was generated by the swagger tool. // Editing this file might prove futile when you re-run the swagger generate command -// ContainerWaitOKBodyError container waiting error, if any -// swagger:model ContainerWaitOKBodyError -type ContainerWaitOKBodyError struct { +// WaitExitError container waiting error, if any +// swagger:model WaitExitError +type WaitExitError struct { // Details of an error Message string `json:"Message,omitempty"` diff --git a/api/types/container/container_wait_o_k_body.go b/api/types/container/wait_response.go similarity index 66% rename from api/types/container/container_wait_o_k_body.go rename to api/types/container/wait_response.go index 3219207fbb..d2fb63aac5 100644 --- a/api/types/container/container_wait_o_k_body.go +++ b/api/types/container/wait_response.go @@ -3,15 +3,15 @@ package container // This file was generated by the swagger tool. // Editing this file might prove futile when you re-run the swagger generate command -// ContainerWaitOKBody ContainerWaitResponse +// WaitResponse ContainerWaitResponse // // OK response to ContainerWait operation -// swagger:model ContainerWaitOKBody -type ContainerWaitOKBody struct { +// swagger:model WaitResponse +type WaitResponse struct { // error // Required: true - Error *ContainerWaitOKBodyError `json:"Error"` + Error *WaitExitError `json:"Error"` // Exit code of the container // Required: true diff --git a/client/container_wait.go b/client/container_wait.go index e9b134c9d2..9aff716132 100644 --- a/client/container_wait.go +++ b/client/container_wait.go @@ -24,12 +24,12 @@ import ( // wait request or in getting the response. This allows the caller to // synchronize ContainerWait with other calls, such as specifying a // "next-exit" condition before issuing a ContainerStart request. -func (cli *Client) ContainerWait(ctx context.Context, containerID string, condition container.WaitCondition) (<-chan container.ContainerWaitOKBody, <-chan error) { +func (cli *Client) ContainerWait(ctx context.Context, containerID string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error) { if versions.LessThan(cli.ClientVersion(), "1.30") { return cli.legacyContainerWait(ctx, containerID) } - resultC := make(chan container.ContainerWaitOKBody) + resultC := make(chan container.WaitResponse) errC := make(chan error, 1) query := url.Values{} @@ -46,7 +46,7 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, condit go func() { defer ensureReaderClosed(resp) - var res container.ContainerWaitOKBody + var res container.WaitResponse if err := json.NewDecoder(resp.body).Decode(&res); err != nil { errC <- err return @@ -60,8 +60,8 @@ func (cli *Client) ContainerWait(ctx context.Context, containerID string, condit // legacyContainerWait returns immediately and doesn't have an option to wait // until the container is removed. -func (cli *Client) legacyContainerWait(ctx context.Context, containerID string) (<-chan container.ContainerWaitOKBody, <-chan error) { - resultC := make(chan container.ContainerWaitOKBody) +func (cli *Client) legacyContainerWait(ctx context.Context, containerID string) (<-chan container.WaitResponse, <-chan error) { + resultC := make(chan container.WaitResponse) errC := make(chan error) go func() { @@ -72,7 +72,7 @@ func (cli *Client) legacyContainerWait(ctx context.Context, containerID string) } defer ensureReaderClosed(resp) - var res container.ContainerWaitOKBody + var res container.WaitResponse if err := json.NewDecoder(resp.body).Decode(&res); err != nil { errC <- err return diff --git a/client/container_wait_test.go b/client/container_wait_test.go index ab42272887..63d08ded0d 100644 --- a/client/container_wait_test.go +++ b/client/container_wait_test.go @@ -38,7 +38,7 @@ func TestContainerWait(t *testing.T) { if !strings.HasPrefix(req.URL.Path, expectedURL) { return nil, fmt.Errorf("Expected URL '%s', got '%s'", expectedURL, req.URL) } - b, err := json.Marshal(container.ContainerWaitOKBody{ + b, err := json.Marshal(container.WaitResponse{ StatusCode: 15, }) if err != nil { diff --git a/client/interface.go b/client/interface.go index 1e177b43d9..513a5bdeed 100644 --- a/client/interface.go +++ b/client/interface.go @@ -73,7 +73,7 @@ type ContainerAPIClient interface { ContainerTop(ctx context.Context, container string, arguments []string) (container.ContainerTopOKBody, error) ContainerUnpause(ctx context.Context, container string) error ContainerUpdate(ctx context.Context, container string, updateConfig container.UpdateConfig) (container.ContainerUpdateOKBody, error) - ContainerWait(ctx context.Context, container string, condition container.WaitCondition) (<-chan container.ContainerWaitOKBody, <-chan error) + ContainerWait(ctx context.Context, container string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error) CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, types.ContainerPathStat, error) CopyToContainer(ctx context.Context, container, path string, content io.Reader, options types.CopyToContainerOptions) error ContainersPrune(ctx context.Context, pruneFilters filters.Args) (types.ContainersPruneReport, error)