summaryrefslogtreecommitdiff
path: root/pkg/api/server
diff options
context:
space:
mode:
authorPaul Holzinger <pholzing@redhat.com>2021-06-08 10:55:02 +0200
committerPaul Holzinger <pholzing@redhat.com>2021-06-08 11:38:26 +0200
commit8378a9c4df9af5f5cc72a3515ca65d1e3ca011a0 (patch)
tree3e479a5ff9e4facefbb0bd4fa2aaead302a96635 /pkg/api/server
parent9a3a7327fdafaac66c99130a6729e4bcde8df0b0 (diff)
downloadpodman-8378a9c4df9af5f5cc72a3515ca65d1e3ca011a0.tar.gz
podman-8378a9c4df9af5f5cc72a3515ca65d1e3ca011a0.tar.bz2
podman-8378a9c4df9af5f5cc72a3515ca65d1e3ca011a0.zip
Fix network prune api docs
The api doc used wrong response examples for both the compat and libpod network prune endpoints. Change the doc so that it matches the actual return values. Also fix the endpoints to return an empty array instead of null when no networks are removed. [NO TESTS NEEDED] Fixes: #10564 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
Diffstat (limited to 'pkg/api/server')
-rw-r--r--pkg/api/server/register_networks.go9
1 files changed, 6 insertions, 3 deletions
diff --git a/pkg/api/server/register_networks.go b/pkg/api/server/register_networks.go
index 4d9806316..d122c6a36 100644
--- a/pkg/api/server/register_networks.go
+++ b/pkg/api/server/register_networks.go
@@ -180,9 +180,12 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
// 200:
// description: OK
// schema:
- // type: array
- // items:
- // type: string
+ // type: object
+ // properties:
+ // NetworksDeleted:
+ // type: array
+ // items:
+ // type: string
// 500:
// $ref: "#/responses/InternalError"
r.HandleFunc(VersionedPath("/networks/prune"), s.APIHandler(compat.Prune)).Methods(http.MethodPost)