spotify/docker-client

Update `ListContainersParam` filters

Open

#710 opened on Apr 3, 2017

View on GitHub
 (6 comments) (2 reactions) (0 assignees)Java (1,430 stars) (551 forks)batch import
enhancementhelp wantedpinned

Description

There are lots of new filters available when listing containers. From the latest swagger.yaml:

Filters to process on the container list, encoded as JSON (a map[string][]string). For example, {"status": ["paused"]} will only return paused containers.

  • ancestor=(<image-name>[:<tag>], <image id>, or <image@digest>)
  • before=(<container id> or <container name>)
  • expose=(<port>[/<proto>]|<startport-endport>/[<proto>])
  • exited=<int> containers with exit code of <int>
  • health=(starting|healthy|unhealthy|none)
  • id=<ID> a container's ID
  • isolation=(default|process|hyperv) (Windows daemon only)
  • is-task=(true|false)
  • label=key or label="key=value" of a container label
  • name=<name> a container's name
  • network=(<network id> or <network name>)
  • publish=(<port>[/<proto>]|<startport-endport>/[<proto>])
  • since=(<container id> or <container name>)
  • status=(created|restarting|running|removing|paused|exited|dead)
  • volume=(<volume name> or <mount point destination>)

We should add these new filters. Might also be nice to dig through the older docker API documentation, figure out when each filter was added, annotate the methods with javadoc @since (docker api version).

I think this should wait on #707, which refactors all the filter params.

Contributor guide

Tech stack
java
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaDocker API knowledgefamiliarity with spotify docker client
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests adding new filters to ListContainersParam, as listed in the Docker API's swagger.yaml. The work is blocked by issue #707 which refactors filter params. Once that is resolved, a contributor should examine the existing ListContainersParam class, add the missing filters, and optionally annotate each with the Docker API version when introduced. The repository is marked as INACTIVE, so contributors should verify current maintenance status before proceeding.