swagger: cleanup Snapshots

api/graph.go

@@ -26,7 +26,7 @@ import (
 // @Description
 // @Description Example URL: `http://localhost:8080/api/graph.svg?layout=vertical`
 // @Tags Status
-// @Produce json
+// @Produce image/png, image/svg+xml
 // @Param ext path string true "ext specifies desired file extension, e.g. .png, .svg."
 // @Param layout query string false "Change between a `horizontal` (default) and a `vertical` graph layout."
 // @Success 200 {object} []byte "Output"

api/mirror.go

@@ -83,7 +83,7 @@ type mirrorCreateParams struct {
 }
 
 // @Summary Create Mirror
-// @Description **Create a mirror of a remote repositoru**
+// @Description **Create a mirror of a remote repository**
 // @Tags Mirrors
 // @Consume json
 // @Param request body mirrorCreateParams true "Parameters"

api/snapshot.go

@@ -14,8 +14,9 @@ import (
 	"github.com/gin-gonic/gin"
 )
 
-// @Summary Get snapshots
-// @Description **Get list of available snapshots**
+// @Summary List Snapshots
+// @Description **Get list of snapshots**
+// @Description
 // @Description Each snapshot is returned as in “show” API.
 // @Tags Snapshots
 // @Produce  json
@@ -45,8 +46,8 @@ type snapshotsCreateFromMirrorParams struct {
 	Description string
 }
 
-// @Summary Create snapshot from mirror
-// @Description **Create snapshot of a mirror from given name**
+// @Summary Snapshot Mirror
+// @Description **Create a snapshot of a mirror**
 // @Tags Snapshots
 // @Produce json
 // @Param request body snapshotsCreateFromMirrorParams true "Parameters"
@@ -119,8 +120,9 @@ type snapshotsCreateParams struct {
 	PackageRefs     []string
 }
 
-// @Summary Create snapshot from repo
+// @Summary Snapshot Packages
 // @Description **Create a snapshot from package refs**
+// @Description
 // @Description Refs can be obtained from snapshots, local repos, or mirrors
 // @Tags Snapshots
 // @Param request body snapshotsCreateParams true "Parameters"