From 398fec13b02d40a6da968631eab3ec10792ba421 Mon Sep 17 00:00:00 2001 From: iofq Date: Mon, 18 Nov 2024 20:13:59 -0600 Subject: [PATCH] Update packages api docs --- api/packages.go | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/api/packages.go b/api/packages.go index e649a80e..f1b6919a 100644 --- a/api/packages.go +++ b/api/packages.go @@ -4,12 +4,13 @@ import ( "github.com/gin-gonic/gin" ) -// @Summary TODO -// @Description **ToDo** -// @Description To Do +// @Summary Show packages +// @Description **Show information about package by package key** +// @Description Package keys could be obtained from various GET .../packages APIs. // @Tags Packages // @Produce json -// @Success 200 {object} string "msg" +// @Param key path string true "package key (unique package identifier)" +// @Success 200 {object} deb.Package "OK" // @Failure 404 {object} Error "Not Found" // @Router /api/packages/{key} [get] func apiPackagesShow(c *gin.Context) {