Skip to content

Commit db2f1ac

Browse files
thaJeztahthaJeztah
committed
api/types: move ContainersPruneReport to api/types/container
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 5b27e71 commit db2f1ac

8 files changed

Lines changed: 24 additions & 17 deletions

File tree

‎api/server/router/container/backend.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ type attachBackend interface {
6262

6363
// systemBackend includes functions to implement to provide system wide containers functionality
6464
type systemBackend interface {
65-
ContainersPrune(ctx context.Context, pruneFilters filters.Args) (*types.ContainersPruneReport, error)
65+
ContainersPrune(ctx context.Context, pruneFilters filters.Args) (*container.PruneReport, error)
6666
}
6767

6868
type commitBackend interface {

‎api/types/container/container.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
package container
2+
3+
// PruneReport contains the response for Engine API:
4+
// POST "/containers/prune"
5+
type PruneReport struct {
6+
ContainersDeleted []string
7+
SpaceReclaimed uint64
8+
}

‎api/types/types.go‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -439,13 +439,6 @@ type DiskUsage struct {
439439
BuilderSize int64 `json:",omitempty"` // Deprecated: deprecated in API 1.38, and no longer used since API 1.40.
440440
}
441441

442-
// ContainersPruneReport contains the response for Engine API:
443-
// POST "/containers/prune"
444-
type ContainersPruneReport struct {
445-
ContainersDeleted []string
446-
SpaceReclaimed uint64
447-
}
448-
449442
// VolumesPruneReport contains the response for Engine API:
450443
// POST "/volumes/prune"
451444
type VolumesPruneReport struct {

‎api/types/types_deprecated.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,9 @@ type ExecStartCheck = container.ExecStartOptions
7272
//
7373
// Deprecated: use [container.ExecInspect].
7474
type ContainerExecInspect = container.ExecInspect
75+
76+
// ContainersPruneReport contains the response for Engine API:
77+
// POST "/containers/prune"
78+
//
79+
// Deprecated: use [container.PruneReport].
80+
type ContainersPruneReport = container.PruneReport

‎client/container_prune.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ import (
55
"encoding/json"
66
"fmt"
77

8-
"github.com/docker/docker/api/types"
8+
"github.com/docker/docker/api/types/container"
99
"github.com/docker/docker/api/types/filters"
1010
)
1111

1212
// ContainersPrune requests the daemon to delete unused data
13-
func (cli *Client) ContainersPrune(ctx context.Context, pruneFilters filters.Args) (types.ContainersPruneReport, error) {
14-
var report types.ContainersPruneReport
13+
func (cli *Client) ContainersPrune(ctx context.Context, pruneFilters filters.Args) (container.PruneReport, error) {
14+
var report container.PruneReport
1515

1616
if err := cli.NewVersionError(ctx, "1.25", "container prune"); err != nil {
1717
return report, err

‎client/container_prune_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"strings"
1111
"testing"
1212

13-
"github.com/docker/docker/api/types"
13+
"github.com/docker/docker/api/types/container"
1414
"github.com/docker/docker/api/types/filters"
1515
"github.com/docker/docker/errdefs"
1616
"gotest.tools/v3/assert"
@@ -93,7 +93,7 @@ func TestContainersPrune(t *testing.T) {
9393
actual := query.Get(key)
9494
assert.Check(t, is.Equal(expected, actual))
9595
}
96-
content, err := json.Marshal(types.ContainersPruneReport{
96+
content, err := json.Marshal(container.PruneReport{
9797
ContainersDeleted: []string{"container_id1", "container_id2"},
9898
SpaceReclaimed: 9999,
9999
})

‎client/interface.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ type ContainerAPIClient interface {
7777
ContainerWait(ctx context.Context, container string, condition container.WaitCondition) (<-chan container.WaitResponse, <-chan error)
7878
CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)
7979
CopyToContainer(ctx context.Context, container, path string, content io.Reader, options types.CopyToContainerOptions) error
80-
ContainersPrune(ctx context.Context, pruneFilters filters.Args) (types.ContainersPruneReport, error)
80+
ContainersPrune(ctx context.Context, pruneFilters filters.Args) (container.PruneReport, error)
8181
}
8282

8383
// DistributionAPIClient defines API client methods for the registry

‎daemon/prune.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import (
88
"time"
99

1010
"github.com/containerd/log"
11-
"github.com/docker/docker/api/types"
1211
"github.com/docker/docker/api/types/backend"
12+
"github.com/docker/docker/api/types/container"
1313
"github.com/docker/docker/api/types/events"
1414
"github.com/docker/docker/api/types/filters"
1515
"github.com/docker/docker/api/types/network"
@@ -39,13 +39,13 @@ var (
3939
)
4040

4141
// ContainersPrune removes unused containers
42-
func (daemon *Daemon) ContainersPrune(ctx context.Context, pruneFilters filters.Args) (*types.ContainersPruneReport, error) {
42+
func (daemon *Daemon) ContainersPrune(ctx context.Context, pruneFilters filters.Args) (*container.PruneReport, error) {
4343
if !atomic.CompareAndSwapInt32(&daemon.pruneRunning, 0, 1) {
4444
return nil, errPruneRunning
4545
}
4646
defer atomic.StoreInt32(&daemon.pruneRunning, 0)
4747

48-
rep := &types.ContainersPruneReport{}
48+
rep := &container.PruneReport{}
4949

5050
// make sure that only accepted filters have been received
5151
err := pruneFilters.Validate(containersAcceptedFilters)

0 commit comments

Comments
 (0)