From 2993bdf1efe11823e6448993dad4deb3d9f27c2d Mon Sep 17 00:00:00 2001
From: Paul Holzinger <pholzing@redhat.com>
Date: Tue, 8 Jun 2021 10:55:02 +0200
Subject: [PATCH] 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>
---
 pkg/api/handlers/compat/networks.go | 2 +-
 pkg/api/handlers/compat/swagger.go  | 7 -------
 pkg/api/handlers/libpod/networks.go | 3 +++
 pkg/api/handlers/libpod/swagger.go  | 7 +++++++
 pkg/api/server/register_networks.go | 9 ++++++---
 5 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/pkg/api/handlers/compat/networks.go b/pkg/api/handlers/compat/networks.go
index 77ed548d83..04f8570ff8 100644
--- a/pkg/api/handlers/compat/networks.go
+++ b/pkg/api/handlers/compat/networks.go
@@ -414,7 +414,7 @@ func Prune(w http.ResponseWriter, r *http.Request) {
 	type response struct {
 		NetworksDeleted []string
 	}
-	var prunedNetworks []string //nolint
+	prunedNetworks := []string{}
 	for _, pr := range pruneReports {
 		if pr.Error != nil {
 			logrus.Error(pr.Error)
diff --git a/pkg/api/handlers/compat/swagger.go b/pkg/api/handlers/compat/swagger.go
index a0783e723e..b773799eff 100644
--- a/pkg/api/handlers/compat/swagger.go
+++ b/pkg/api/handlers/compat/swagger.go
@@ -77,10 +77,3 @@ type swagCompatNetworkDisconnectRequest struct {
 	// in:body
 	Body struct{ types.NetworkDisconnect }
 }
-
-// Network prune
-// swagger:response NetworkPruneResponse
-type swagCompatNetworkPruneResponse struct {
-	// in:body
-	Body []string
-}
diff --git a/pkg/api/handlers/libpod/networks.go b/pkg/api/handlers/libpod/networks.go
index 5417f778e6..e4f450e12e 100644
--- a/pkg/api/handlers/libpod/networks.go
+++ b/pkg/api/handlers/libpod/networks.go
@@ -190,5 +190,8 @@ func Prune(w http.ResponseWriter, r *http.Request) {
 		utils.Error(w, "Something went wrong.", http.StatusInternalServerError, err)
 		return
 	}
+	if pruneReports == nil {
+		pruneReports = []*entities.NetworkPruneReport{}
+	}
 	utils.WriteResponse(w, http.StatusOK, pruneReports)
 }
diff --git a/pkg/api/handlers/libpod/swagger.go b/pkg/api/handlers/libpod/swagger.go
index 9450a70d93..f805954295 100644
--- a/pkg/api/handlers/libpod/swagger.go
+++ b/pkg/api/handlers/libpod/swagger.go
@@ -119,6 +119,13 @@ type swagNetworkCreateReport struct {
 	Body entities.NetworkCreateReport
 }
 
+// Network prune
+// swagger:response NetworkPruneResponse
+type swagNetworkPruneResponse struct {
+	// in:body
+	Body []entities.NetworkPruneReport
+}
+
 func ServeSwagger(w http.ResponseWriter, r *http.Request) {
 	path := DefaultPodmanSwaggerSpec
 	if p, found := os.LookupEnv("PODMAN_SWAGGER_SPEC"); found {
diff --git a/pkg/api/server/register_networks.go b/pkg/api/server/register_networks.go
index dcec61befc..85d008e76c 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)