summaryrefslogtreecommitdiff
path: root/pkg/api
diff options
context:
space:
mode:
authorJakub Guzik <jakubmguzik@gmail.com>2021-04-13 09:16:25 +0200
committerMatthew Heon <mheon@redhat.com>2021-04-16 11:26:32 -0400
commit0e28e3da3fb80ae77f3c7a4ba09da0b467914339 (patch)
treeb605d4f6550c3158ef408e75e4a6e0f6a9e96f37 /pkg/api
parentac753308e877824f6094600d36b00cea3aa098b3 (diff)
downloadpodman-0e28e3da3fb80ae77f3c7a4ba09da0b467914339.tar.gz
podman-0e28e3da3fb80ae77f3c7a4ba09da0b467914339.tar.bz2
podman-0e28e3da3fb80ae77f3c7a4ba09da0b467914339.zip
Reflect current state of prune implementation in docs
Signed-off-by: Jakub Guzik <jakubmguzik@gmail.com>
Diffstat (limited to 'pkg/api')
-rw-r--r--pkg/api/server/register_networks.go1
-rw-r--r--pkg/api/server/register_volumes.go12
2 files changed, 10 insertions, 3 deletions
diff --git a/pkg/api/server/register_networks.go b/pkg/api/server/register_networks.go
index a07c6a55e..7710fb83f 100644
--- a/pkg/api/server/register_networks.go
+++ b/pkg/api/server/register_networks.go
@@ -382,7 +382,6 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
// name: filters
// type: string
// description: |
- // NOT IMPLEMENTED
// Filters to process on the prune list, encoded as JSON (a map[string][]string).
// Available filters:
// - until=<timestamp> Prune networks 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.
diff --git a/pkg/api/server/register_volumes.go b/pkg/api/server/register_volumes.go
index b19faefdd..b03f26487 100644
--- a/pkg/api/server/register_volumes.go
+++ b/pkg/api/server/register_volumes.go
@@ -81,6 +81,14 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// summary: Prune volumes
// produces:
// - application/json
+ // parameters:
+ // - in: query
+ // name: filters
+ // type: string
+ // description: |
+ // JSON encoded value of filters (a map[string][]string) to match volumes against before pruning.
+ // Available filters:
+ // - label (label=<key>, label=<key>=<value>, label!=<key>, or label!=<key>=<value>) Prune volumes with (or without, in case label!=... is used) the specified labels.
// responses:
// '200':
// "$ref": "#/responses/VolumePruneResponse"
@@ -259,8 +267,8 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// type: string
// description: |
// JSON encoded value of filters (a map[string][]string) to match volumes against before pruning.
- //
- // Note: No filters are currently supported and any filters specified will cause an error response.
+ // Available filters:
+ // - label (label=<key>, label=<key>=<value>, label!=<key>, or label!=<key>=<value>) Prune volumes with (or without, in case label!=... is used) the specified labels.
// responses:
// '200':
// "$ref": "#/responses/DockerVolumePruneResponse"