Merge pull request #11173 from jmguzik/pod-ps-until-filter

Add until filter to podman pod ps

1 files changed, 12 insertions, 1 deletions

diff --git a/pkg/api/server/register_pods.go b/pkg/api/server/register_pods.go
index 3bcc50ba4..58234005e 100644
--- a/pkg/api/server/register_pods.go
+++ b/pkg/api/server/register_pods.go
@@ -17,7 +17,18 @@ func (s *APIServer) registerPodsHandlers(r *mux.Router) error {
 	// - in: query
 	//   name: filters
 	//   type: string
-	//   description: needs description and plumbing for filters
+	//   description: |
+	//      JSON encoded value of the filters (a map[string][]string) to process on the pods list. Available filters:
+	//        - `id=<pod-id>` Matches all of pod id.
+	//        - `label=<key>` or `label=<key>:<value>` Matches pods based on the presence of a label alone or a label and a value.
+	//        - `name=<pod-name>` Matches all of pod name.
+	//        - `until=<timestamp>` List pods created before this timestamp. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time.
+	//        - `status=<pod-status>` Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`.
+	//        - `network=<pod-network>` Name or full ID of network.
+	//        - `ctr-names=<pod-ctr-names>` Container name within the pod.
+	//        - `ctr-ids=<pod-ctr-ids>` Container ID within the pod.
+	//        - `ctr-status=<pod-ctr-status>` Container status within the pod.
+	//        - `ctr-number=<pod-ctr-number>` Number of containers in the pod.
 	// responses:
 	//   200:
 	//     $ref: "#/responses/ListPodsResponse"