Update gpg, graph api docs

This commit is contained in:
iofq
2024-11-18 20:24:15 -06:00
committed by André Roth
parent 398fec13b0
commit 68fe2bc852
2 changed files with 19 additions and 15 deletions

View File

@@ -12,22 +12,23 @@ import (
"github.com/gin-gonic/gin"
)
// @Summary TODO
// @Description **ToDo**
// @Description To Do
type gpgAddKeyParams struct {
Keyserver string
GpgKeyID string
GpgKeyArmor string
Keyring string
}
// @Summary Add GPG Key
// @Description Adds a GPG key to aptly keyring
// @Tags GPG
// @Produce json
// @Success 200 {object} string "msg"
// @Success 200 {object} string "OK"
// @Failure 400 {object} Error "Bad Request"
// @Failure 404 {object} Error "Not Found"
// @Router /api/gpg [post]
func apiGPGAddKey(c *gin.Context) {
var b struct {
Keyserver string
GpgKeyID string
GpgKeyArmor string
Keyring string
}
b := gpgAddKeyParams{}
if c.Bind(&b) != nil {
return
}

View File

@@ -12,13 +12,16 @@ import (
"github.com/gin-gonic/gin"
)
// @Summary TODO
// @Description **ToDo**
// @Description To Do
// @Summary Graph Output
// @Description **Generate graph of aptly objects (same as in aptly graph command).**
// @Description e.g open url `http://localhost:8080/api/graph.svg?layout=vertical` in browser
// @Tags Graph
// @Produce json
// @Success 200 {object} string "msg"
// @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"
// @Failure 404 {object} Error "Not Found"
// @Failure 500 {object} Error "Internal Server Error"
// @Router /api/graph [get]
// GET /api/graph.:ext?layout=[vertical|horizontal(default)]
func apiGraph(c *gin.Context) {