summaryrefslogtreecommitdiff
path: root/pkg/api/server/register_volumes.go
diff options
context:
space:
mode:
authorJakub Guzik <jakubmguzik@gmail.com>2021-04-13 09:16:25 +0200
committerJakub Guzik <jakubmguzik@gmail.com>2021-04-13 09:16:25 +0200
commit9d74825c7e1d2c178e84e7e619029690fa166384 (patch)
tree43cd1d4c737b258b1a9b3da90a3f225cd0b1aa14 /pkg/api/server/register_volumes.go
parent6933d4611a94097681a1d8435290d9bb1c59f1f4 (diff)
downloadpodman-9d74825c7e1d2c178e84e7e619029690fa166384.tar.gz
podman-9d74825c7e1d2c178e84e7e619029690fa166384.tar.bz2
podman-9d74825c7e1d2c178e84e7e619029690fa166384.zip
Reflect current state of prune implementation in docs
Signed-off-by: Jakub Guzik <jakubmguzik@gmail.com>
Diffstat (limited to 'pkg/api/server/register_volumes.go')
-rw-r--r--pkg/api/server/register_volumes.go12
1 files changed, 10 insertions, 2 deletions
diff --git a/pkg/api/server/register_volumes.go b/pkg/api/server/register_volumes.go
index 58f056626..e5d6cf195 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"