Skip to content

Commit ecb24af

Browse files
thaJeztahthaJeztah
committed
api/types: move ImagesPruneReport to api/types/image
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 162ef4f commit ecb24af

10 files changed

Lines changed: 26 additions & 24 deletions

File tree

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import (
55
"io"
66

77
"github.com/distribution/reference"
8-
"github.com/docker/docker/api/types"
98
"github.com/docker/docker/api/types/backend"
109
"github.com/docker/docker/api/types/filters"
1110
"github.com/docker/docker/api/types/image"
@@ -28,7 +27,7 @@ type imageBackend interface {
2827
Images(ctx context.Context, opts image.ListOptions) ([]*image.Summary, error)
2928
GetImage(ctx context.Context, refOrID string, options backend.GetImageOpts) (*dockerimage.Image, error)
3029
TagImage(ctx context.Context, id dockerimage.ID, newRef reference.Named) error
31-
ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*types.ImagesPruneReport, error)
30+
ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*image.PruneReport, error)
3231
}
3332

3433
type importExportBackend interface {

‎api/types/image/image.go‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,10 @@ type Metadata struct {
77
// LastTagTime is the date and time at which the image was last tagged.
88
LastTagTime time.Time `json:",omitempty"`
99
}
10+
11+
// PruneReport contains the response for Engine API:
12+
// POST "/images/prune"
13+
type PruneReport struct {
14+
ImagesDeleted []DeleteResponse
15+
SpaceReclaimed uint64
16+
}

‎api/types/types.go‎

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

422-
// ImagesPruneReport contains the response for Engine API:
423-
// POST "/images/prune"
424-
type ImagesPruneReport struct {
425-
ImagesDeleted []image.DeleteResponse
426-
SpaceReclaimed uint64
427-
}
428-
429422
// BuildCachePruneReport contains the response for Engine API:
430423
// POST "/build/prune"
431424
type BuildCachePruneReport struct {

‎api/types/types_deprecated.go‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@ package types
22

33
import (
44
"github.com/docker/docker/api/types/container"
5+
"github.com/docker/docker/api/types/image"
56
"github.com/docker/docker/api/types/network"
67
"github.com/docker/docker/api/types/volume"
78
)
89

10+
// ImagesPruneReport contains the response for Engine API:
11+
// POST "/images/prune"
12+
//
13+
// Deprecated: use [image.PruneReport].
14+
type ImagesPruneReport = image.PruneReport
15+
916
// VolumesPruneReport contains the response for Engine API:
1017
// POST "/volumes/prune".
1118
//

‎client/image_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"
98
"github.com/docker/docker/api/types/filters"
9+
"github.com/docker/docker/api/types/image"
1010
)
1111

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

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

‎client/image_prune_test.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ import (
1313
"github.com/docker/docker/api/types/image"
1414
"github.com/docker/docker/errdefs"
1515

16-
"github.com/docker/docker/api/types"
1716
"github.com/docker/docker/api/types/filters"
1817
"gotest.tools/v3/assert"
1918
is "gotest.tools/v3/assert/cmp"
@@ -84,7 +83,7 @@ func TestImagesPrune(t *testing.T) {
8483
actual := query.Get(key)
8584
assert.Check(t, is.Equal(expected, actual))
8685
}
87-
content, err := json.Marshal(types.ImagesPruneReport{
86+
content, err := json.Marshal(image.PruneReport{
8887
ImagesDeleted: []image.DeleteResponse{
8988
{
9089
Deleted: "image_id1",

‎client/interface.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ type ImageAPIClient interface {
102102
ImageSearch(ctx context.Context, term string, options types.ImageSearchOptions) ([]registry.SearchResult, error)
103103
ImageSave(ctx context.Context, images []string) (io.ReadCloser, error)
104104
ImageTag(ctx context.Context, image, ref string) error
105-
ImagesPrune(ctx context.Context, pruneFilter filters.Args) (types.ImagesPruneReport, error)
105+
ImagesPrune(ctx context.Context, pruneFilter filters.Args) (image.PruneReport, error)
106106
}
107107

108108
// NetworkAPIClient defines API client methods for the networks

‎daemon/containerd/image_prune.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import (
88
cerrdefs "github.com/containerd/errdefs"
99
"github.com/containerd/log"
1010
"github.com/distribution/reference"
11-
"github.com/docker/docker/api/types"
1211
"github.com/docker/docker/api/types/filters"
1312
"github.com/docker/docker/api/types/image"
1413
"github.com/docker/docker/errdefs"
@@ -31,7 +30,7 @@ var imagesAcceptedFilters = map[string]bool{
3130
var errPruneRunning = errdefs.Conflict(errors.New("a prune operation is already running"))
3231

3332
// ImagesPrune removes unused images
34-
func (i *ImageService) ImagesPrune(ctx context.Context, fltrs filters.Args) (*types.ImagesPruneReport, error) {
33+
func (i *ImageService) ImagesPrune(ctx context.Context, fltrs filters.Args) (*image.PruneReport, error) {
3534
if !i.pruneRunning.CompareAndSwap(false, true) {
3635
return nil, errPruneRunning
3736
}
@@ -62,8 +61,8 @@ func (i *ImageService) ImagesPrune(ctx context.Context, fltrs filters.Args) (*ty
6261
return i.pruneUnused(ctx, filterFunc, danglingOnly)
6362
}
6463

65-
func (i *ImageService) pruneUnused(ctx context.Context, filterFunc imageFilterFunc, danglingOnly bool) (*types.ImagesPruneReport, error) {
66-
report := types.ImagesPruneReport{}
64+
func (i *ImageService) pruneUnused(ctx context.Context, filterFunc imageFilterFunc, danglingOnly bool) (*image.PruneReport, error) {
65+
report := image.PruneReport{}
6766

6867
allImages, err := i.images.List(ctx)
6968
if err != nil {

‎daemon/image_service.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import (
55
"io"
66

77
"github.com/distribution/reference"
8-
"github.com/docker/docker/api/types"
98
"github.com/docker/docker/api/types/backend"
109
"github.com/docker/docker/api/types/events"
1110
"github.com/docker/docker/api/types/filters"
@@ -37,7 +36,7 @@ type ImageService interface {
3736
Images(ctx context.Context, opts imagetype.ListOptions) ([]*imagetype.Summary, error)
3837
LogImageEvent(imageID, refName string, action events.Action)
3938
CountImages(ctx context.Context) int
40-
ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*types.ImagesPruneReport, error)
39+
ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*imagetype.PruneReport, error)
4140
ImportImage(ctx context.Context, ref reference.Named, platform *ocispec.Platform, msg string, layerReader io.Reader, changes []string) (image.ID, error)
4241
TagImage(ctx context.Context, imageID image.ID, newTag reference.Named) error
4342
GetImage(ctx context.Context, refOrID string, options backend.GetImageOpts) (*image.Image, error)

‎daemon/images/image_prune.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import (
99

1010
"github.com/containerd/log"
1111
"github.com/distribution/reference"
12-
"github.com/docker/docker/api/types"
1312
"github.com/docker/docker/api/types/events"
1413
"github.com/docker/docker/api/types/filters"
1514
imagetypes "github.com/docker/docker/api/types/image"
@@ -33,7 +32,7 @@ var imagesAcceptedFilters = map[string]bool{
3332
var errPruneRunning = errdefs.Conflict(errors.New("a prune operation is already running"))
3433

3534
// ImagesPrune removes unused images
36-
func (i *ImageService) ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*types.ImagesPruneReport, error) {
35+
func (i *ImageService) ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*imagetypes.PruneReport, error) {
3736
if !atomic.CompareAndSwapInt32(&i.pruneRunning, 0, 1) {
3837
return nil, errPruneRunning
3938
}
@@ -45,7 +44,7 @@ func (i *ImageService) ImagesPrune(ctx context.Context, pruneFilters filters.Arg
4544
return nil, err
4645
}
4746

48-
rep := &types.ImagesPruneReport{}
47+
rep := &imagetypes.PruneReport{}
4948

5049
danglingOnly, err := pruneFilters.GetBoolOrDefault("dangling", true)
5150
if err != nil {

0 commit comments

Comments
 (0)