Skip to content

Commit e5f9484

Browse files
thaJeztahthaJeztah
committed
api/types: move NetworksPruneReport to api/types/network
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent ad6edc1 commit e5f9484

8 files changed

Lines changed: 26 additions & 20 deletions

File tree

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package network // import "github.com/docker/docker/api/server/router/network"
33
import (
44
"context"
55

6-
"github.com/docker/docker/api/types"
76
"github.com/docker/docker/api/types/backend"
87
"github.com/docker/docker/api/types/filters"
98
"github.com/docker/docker/api/types/network"
@@ -17,7 +16,7 @@ type Backend interface {
1716
ConnectContainerToNetwork(containerName, networkName string, endpointConfig *network.EndpointSettings) error
1817
DisconnectContainerFromNetwork(containerName string, networkName string, force bool) error
1918
DeleteNetwork(networkID string) error
20-
NetworksPrune(ctx context.Context, pruneFilters filters.Args) (*types.NetworksPruneReport, error)
19+
NetworksPrune(ctx context.Context, pruneFilters filters.Args) (*network.PruneReport, error)
2120
}
2221

2322
// ClusterBackend is all the methods that need to be implemented

‎api/types/network/network.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,3 +158,9 @@ var acceptedFilters = map[string]bool{
158158
func ValidateFilters(filter filters.Args) error {
159159
return filter.Validate(acceptedFilters)
160160
}
161+
162+
// PruneReport contains the response for Engine API:
163+
// POST "/networks/prune"
164+
type PruneReport struct {
165+
NetworksDeleted []string
166+
}

‎api/types/types.go‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -483,12 +483,6 @@ type BuildCachePruneReport struct {
483483
SpaceReclaimed uint64
484484
}
485485

486-
// NetworksPruneReport contains the response for Engine API:
487-
// POST "/networks/prune"
488-
type NetworksPruneReport struct {
489-
NetworksDeleted []string
490-
}
491-
492486
// SecretCreateResponse contains the information returned to a client
493487
// on the creation of a new secret.
494488
type SecretCreateResponse struct {

‎api/types/types_deprecated.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,9 @@ type EndpointResource = network.EndpointResource
4848
//
4949
// Deprecated: use [network.Inspect] or [network.Summary] (for list operations).
5050
type NetworkResource = network.Inspect
51+
52+
// NetworksPruneReport contains the response for Engine API:
53+
// POST "/networks/prune"
54+
//
55+
// Deprecated: use [network.PruneReport].
56+
type NetworksPruneReport = network.PruneReport

‎client/interface.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ type NetworkAPIClient interface {
114114
NetworkInspectWithRaw(ctx context.Context, network string, options network.InspectOptions) (network.Inspect, []byte, error)
115115
NetworkList(ctx context.Context, options network.ListOptions) ([]network.Summary, error)
116116
NetworkRemove(ctx context.Context, network string) error
117-
NetworksPrune(ctx context.Context, pruneFilter filters.Args) (types.NetworksPruneReport, error)
117+
NetworksPrune(ctx context.Context, pruneFilter filters.Args) (network.PruneReport, error)
118118
}
119119

120120
// NodeAPIClient defines API client methods for the nodes

‎client/network_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/network"
1010
)
1111

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

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

‎client/network_prune_test.go‎

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

13-
"github.com/docker/docker/api/types"
1413
"github.com/docker/docker/api/types/filters"
14+
"github.com/docker/docker/api/types/network"
1515
"github.com/docker/docker/errdefs"
1616
"gotest.tools/v3/assert"
1717
is "gotest.tools/v3/assert/cmp"
@@ -82,7 +82,7 @@ func TestNetworksPrune(t *testing.T) {
8282
actual := query.Get(key)
8383
assert.Check(t, is.Equal(expected, actual))
8484
}
85-
content, err := json.Marshal(types.NetworksPruneReport{
85+
content, err := json.Marshal(network.PruneReport{
8686
NetworksDeleted: []string{"network_id1", "network_id2"},
8787
})
8888
if err != nil {

‎daemon/prune.go‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"github.com/docker/docker/api/types/backend"
1313
"github.com/docker/docker/api/types/events"
1414
"github.com/docker/docker/api/types/filters"
15+
"github.com/docker/docker/api/types/network"
1516
timetypes "github.com/docker/docker/api/types/time"
1617
"github.com/docker/docker/errdefs"
1718
"github.com/docker/docker/libnetwork"
@@ -97,8 +98,8 @@ func (daemon *Daemon) ContainersPrune(ctx context.Context, pruneFilters filters.
9798
}
9899

99100
// localNetworksPrune removes unused local networks
100-
func (daemon *Daemon) localNetworksPrune(ctx context.Context, pruneFilters filters.Args) *types.NetworksPruneReport {
101-
rep := &types.NetworksPruneReport{}
101+
func (daemon *Daemon) localNetworksPrune(ctx context.Context, pruneFilters filters.Args) *network.PruneReport {
102+
rep := &network.PruneReport{}
102103

103104
until, _ := getUntilFromPruneFilters(pruneFilters)
104105

@@ -137,8 +138,8 @@ func (daemon *Daemon) localNetworksPrune(ctx context.Context, pruneFilters filte
137138
}
138139

139140
// clusterNetworksPrune removes unused cluster networks
140-
func (daemon *Daemon) clusterNetworksPrune(ctx context.Context, pruneFilters filters.Args) (*types.NetworksPruneReport, error) {
141-
rep := &types.NetworksPruneReport{}
141+
func (daemon *Daemon) clusterNetworksPrune(ctx context.Context, pruneFilters filters.Args) (*network.PruneReport, error) {
142+
rep := &network.PruneReport{}
142143

143144
until, _ := getUntilFromPruneFilters(pruneFilters)
144145

@@ -187,7 +188,7 @@ func (daemon *Daemon) clusterNetworksPrune(ctx context.Context, pruneFilters fil
187188
}
188189

189190
// NetworksPrune removes unused networks
190-
func (daemon *Daemon) NetworksPrune(ctx context.Context, pruneFilters filters.Args) (*types.NetworksPruneReport, error) {
191+
func (daemon *Daemon) NetworksPrune(ctx context.Context, pruneFilters filters.Args) (*network.PruneReport, error) {
191192
if !atomic.CompareAndSwapInt32(&daemon.pruneRunning, 0, 1) {
192193
return nil, errPruneRunning
193194
}
@@ -203,7 +204,7 @@ func (daemon *Daemon) NetworksPrune(ctx context.Context, pruneFilters filters.Ar
203204
return nil, err
204205
}
205206

206-
rep := &types.NetworksPruneReport{}
207+
rep := &network.PruneReport{}
207208
if clusterRep, err := daemon.clusterNetworksPrune(ctx, pruneFilters); err == nil {
208209
rep.NetworksDeleted = append(rep.NetworksDeleted, clusterRep.NetworksDeleted...)
209210
}

0 commit comments

Comments
 (0)