Skip to content

Commit 89a6966

Browse files
WeiZhang555WeiZhang555
committed
Replace all "Filter" field with "Filters" for consistency
In file `api/types/client.go`, some of the "*Options{}" structs own a `Filters` field while some else have the name of `Filter`, this commit will rename all `Filter` to `Filters` for consistency. Also `Filters` is consistent with API with format `/xxx?filters=xxx`, that's why `Filters` is the right name. Signed-off-by: Zhang Wei <[email protected]>
1 parent 17aaa08 commit 89a6966

23 files changed

Lines changed: 55 additions & 55 deletions

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ func (s *containerRouter) getContainersJSON(ctx context.Context, w http.Response
3232
}
3333

3434
config := &types.ContainerListOptions{
35-
All: httputils.BoolValue(r, "all"),
36-
Size: httputils.BoolValue(r, "size"),
37-
Since: r.Form.Get("since"),
38-
Before: r.Form.Get("before"),
39-
Filter: filter,
35+
All: httputils.BoolValue(r, "all"),
36+
Size: httputils.BoolValue(r, "size"),
37+
Since: r.Form.Get("since"),
38+
Before: r.Form.Get("before"),
39+
Filters: filter,
4040
}
4141

4242
if tmpLimit := r.Form.Get("limit"); tmpLimit != "" {

‎api/server/router/swarm/cluster_routes.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ func (sr *swarmRouter) getServices(ctx context.Context, w http.ResponseWriter, r
102102
return err
103103
}
104104

105-
services, err := sr.backend.GetServices(basictypes.ServiceListOptions{Filter: filter})
105+
services, err := sr.backend.GetServices(basictypes.ServiceListOptions{Filters: filter})
106106
if err != nil {
107107
logrus.Errorf("Error getting services: %v", err)
108108
return err
@@ -182,7 +182,7 @@ func (sr *swarmRouter) getNodes(ctx context.Context, w http.ResponseWriter, r *h
182182
return err
183183
}
184184

185-
nodes, err := sr.backend.GetNodes(basictypes.NodeListOptions{Filter: filter})
185+
nodes, err := sr.backend.GetNodes(basictypes.NodeListOptions{Filters: filter})
186186
if err != nil {
187187
logrus.Errorf("Error getting nodes: %v", err)
188188
return err
@@ -243,7 +243,7 @@ func (sr *swarmRouter) getTasks(ctx context.Context, w http.ResponseWriter, r *h
243243
return err
244244
}
245245

246-
tasks, err := sr.backend.GetTasks(basictypes.TaskListOptions{Filter: filter})
246+
tasks, err := sr.backend.GetTasks(basictypes.TaskListOptions{Filters: filter})
247247
if err != nil {
248248
logrus.Errorf("Error getting tasks: %v", err)
249249
return err

‎api/types/client.go‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ type ContainerExecInspect struct {
5959

6060
// ContainerListOptions holds parameters to list containers with.
6161
type ContainerListOptions struct {
62-
Quiet bool
63-
Size bool
64-
All bool
65-
Latest bool
66-
Since string
67-
Before string
68-
Limit int
69-
Filter filters.Args
62+
Quiet bool
63+
Size bool
64+
All bool
65+
Latest bool
66+
Since string
67+
Before string
68+
Limit int
69+
Filters filters.Args
7070
}
7171

7272
// ContainerLogsOptions holds parameters to filter logs with.
@@ -267,7 +267,7 @@ func (v VersionResponse) ServerOK() bool {
267267

268268
// NodeListOptions holds parameters to list nodes with.
269269
type NodeListOptions struct {
270-
Filter filters.Args
270+
Filters filters.Args
271271
}
272272

273273
// NodeRemoveOptions holds parameters to remove nodes with.
@@ -317,12 +317,12 @@ type ServiceUpdateOptions struct {
317317

318318
// ServiceListOptions holds parameters to list services with.
319319
type ServiceListOptions struct {
320-
Filter filters.Args
320+
Filters filters.Args
321321
}
322322

323323
// TaskListOptions holds parameters to list tasks with.
324324
type TaskListOptions struct {
325-
Filter filters.Args
325+
Filters filters.Args
326326
}
327327

328328
// PluginRemoveOptions holds parameters to remove plugins.

‎cli/command/container/list.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ func (p *preProcessor) Networks() bool {
7979

8080
func buildContainerListOptions(opts *psOptions) (*types.ContainerListOptions, error) {
8181
options := &types.ContainerListOptions{
82-
All: opts.all,
83-
Limit: opts.last,
84-
Size: opts.size,
85-
Filter: opts.filter.Value(),
82+
All: opts.all,
83+
Limit: opts.last,
84+
Size: opts.size,
85+
Filters: opts.filter.Value(),
8686
}
8787

8888
if opts.nLatest && opts.last == -1 {

‎cli/command/container/ps_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ func TestBuildContainerListOptions(t *testing.T) {
5555
assert.Equal(t, c.expectedAll, options.All)
5656
assert.Equal(t, c.expectedSize, options.Size)
5757
assert.Equal(t, c.expectedLimit, options.Limit)
58-
assert.Equal(t, options.Filter.Len(), len(c.expectedFilters))
58+
assert.Equal(t, options.Filters.Len(), len(c.expectedFilters))
5959

6060
for k, v := range c.expectedFilters {
61-
f := options.Filter
61+
f := options.Filters
6262
if !f.ExactMatch(k, v) {
6363
t.Fatalf("Expected filter with key %s to be %s but got %s", k, v, f.Get(k))
6464
}

‎cli/command/node/list.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func runList(dockerCli *command.DockerCli, opts listOptions) error {
5050

5151
nodes, err := client.NodeList(
5252
ctx,
53-
types.NodeListOptions{Filter: opts.filter.Value()})
53+
types.NodeListOptions{Filters: opts.filter.Value()})
5454
if err != nil {
5555
return err
5656
}

‎cli/command/node/ps.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func runPs(dockerCli *command.DockerCli, opts psOptions) error {
7272
filter := opts.filter.Value()
7373
filter.Add("node", node.ID)
7474

75-
nodeTasks, err := client.TaskList(ctx, types.TaskListOptions{Filter: filter})
75+
nodeTasks, err := client.TaskList(ctx, types.TaskListOptions{Filters: filter})
7676
if err != nil {
7777
errs = append(errs, err.Error())
7878
continue

‎cli/command/service/list.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func runList(dockerCli *command.DockerCli, opts listOptions) error {
5151
client := dockerCli.Client()
5252
out := dockerCli.Out()
5353

54-
services, err := client.ServiceList(ctx, types.ServiceListOptions{Filter: opts.filter.Value()})
54+
services, err := client.ServiceList(ctx, types.ServiceListOptions{Filters: opts.filter.Value()})
5555
if err != nil {
5656
return err
5757
}
@@ -63,7 +63,7 @@ func runList(dockerCli *command.DockerCli, opts listOptions) error {
6363
taskFilter.Add("service", service.ID)
6464
}
6565

66-
tasks, err := client.TaskList(ctx, types.TaskListOptions{Filter: taskFilter})
66+
tasks, err := client.TaskList(ctx, types.TaskListOptions{Filters: taskFilter})
6767
if err != nil {
6868
return err
6969
}

‎cli/command/service/ps.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ func runPS(dockerCli *command.DockerCli, opts psOptions) error {
6464
}
6565
}
6666

67-
tasks, err := client.TaskList(ctx, types.TaskListOptions{Filter: filter})
67+
tasks, err := client.TaskList(ctx, types.TaskListOptions{Filters: filter})
6868
if err != nil {
6969
return err
7070
}

‎cli/command/stack/common.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ func getServices(
3434
) ([]swarm.Service, error) {
3535
return apiclient.ServiceList(
3636
ctx,
37-
types.ServiceListOptions{Filter: getStackFilter(namespace)})
37+
types.ServiceListOptions{Filters: getStackFilter(namespace)})
3838
}
3939

4040
func getNetworks(

0 commit comments

Comments
 (0)