Merge pull request #10597 from Luap99/prune

Fix network prune api docs
containers · Jun 8, 2021 · 3d961ac · 3d961ac
2 parents 5d96b8e + 8378a9c
commit 3d961ac
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 11 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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)