summaryrefslogtreecommitdiff
path: root/pkg/api/server/register_volumes.go
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2020-01-10 08:25:12 -0600
committerbaude <bbaude@redhat.com>2020-01-13 14:33:47 -0600
commitda4b8d3c645d69ee34b31adf029c7ba1e38c1bba (patch)
tree1d53676b32d1db0eeea558214f530d5c24c57f58 /pkg/api/server/register_volumes.go
parente1ffac6cc73eb36640cbaf6a1a28ba44749a96d9 (diff)
downloadpodman-da4b8d3c645d69ee34b31adf029c7ba1e38c1bba.tar.gz
podman-da4b8d3c645d69ee34b31adf029c7ba1e38c1bba.tar.bz2
podman-da4b8d3c645d69ee34b31adf029c7ba1e38c1bba.zip
swagger documentation updates
adhere closer to the spec by using description and summary fields and also ensuring that the id is unique to avoid collision between generic and libpod endpoints. also, make swagger output work with redoc which seems to display our information better for our needs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'pkg/api/server/register_volumes.go')
-rw-r--r--pkg/api/server/register_volumes.go16
1 files changed, 4 insertions, 12 deletions
diff --git a/pkg/api/server/register_volumes.go b/pkg/api/server/register_volumes.go
index 8fe5a67e4..34138cfbf 100644
--- a/pkg/api/server/register_volumes.go
+++ b/pkg/api/server/register_volumes.go
@@ -9,10 +9,8 @@ import (
func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// swagger:operation POST /libpod/volumes/create volumes createVolume
- //
- // Create a volume
- //
// ---
+ // summary: Create a volume
// produces:
// - application/json
// responses:
@@ -23,10 +21,8 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
r.Handle("/libpod/volumes/create", APIHandler(s.Context, libpod.CreateVolume)).Methods(http.MethodPost)
r.Handle("/libpod/volumes/json", APIHandler(s.Context, libpod.ListVolumes)).Methods(http.MethodGet)
// swagger:operation POST /volumes/prune volumes pruneVolumes
- //
- // Prune volumes
- //
// ---
+ // summary: Prune volumes
// produces:
// - application/json
// responses:
@@ -36,10 +32,8 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// "$ref": "#/responses/InternalError"
r.Handle("/libpod/volumes/prune", APIHandler(s.Context, libpod.PruneVolumes)).Methods(http.MethodPost)
// swagger:operation GET /volumes/{nameOrID}/json volumes inspectVolume
- //
- // Inspect volume
- //
// ---
+ // summary: Inspect volume
// parameters:
// - in: path
// name: nameOrID
@@ -56,10 +50,8 @@ func (s *APIServer) registerVolumeHandlers(r *mux.Router) error {
// "$ref": "#/responses/InternalError"
r.Handle("/libpod/volumes/{name:..*}/json", APIHandler(s.Context, libpod.InspectVolume)).Methods(http.MethodGet)
// swagger:operation DELETE /volumes/{nameOrID} volumes removeVolume
- //
- // Inspect volume
- //
// ---
+ // summary: Remove volume
// parameters:
// - in: path
// name: nameOrID