diff options
| author | Paul Holzinger <pholzing@redhat.com> | 2021-06-08 10:55:02 +0200 |
|---|---|---|
| committer | Matthew Heon <mheon@redhat.com> | 2021-06-11 13:06:06 -0400 |
| commit | 2993bdf1efe11823e6448993dad4deb3d9f27c2d (patch) | |
| tree | 1f5065d4cc81a23074a3541570efd1c6186a7e19 /pkg/api/handlers/libpod | |
| parent | 8ba0c92e6a8da59417d7e96a6f2002bfe1a74f1f (diff) | |
| download | podman-2993bdf1efe11823e6448993dad4deb3d9f27c2d.tar.gz podman-2993bdf1efe11823e6448993dad4deb3d9f27c2d.tar.bz2 podman-2993bdf1efe11823e6448993dad4deb3d9f27c2d.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/handlers/libpod')
| -rw-r--r-- | pkg/api/handlers/libpod/networks.go | 3 | ||||
| -rw-r--r-- | pkg/api/handlers/libpod/swagger.go | 7 |
2 files changed, 10 insertions, 0 deletions
diff --git a/pkg/api/handlers/libpod/networks.go b/pkg/api/handlers/libpod/networks.go index 5417f778e..e4f450e12 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 9450a70d9..f80595429 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 { |