From 8697f091f3033f613c978f6aa4b81e868046f4d1 Mon Sep 17 00:00:00 2001 From: FlomoN Date: Mon, 20 Jun 2022 14:20:34 +0200 Subject: [PATCH] Add params to godoc for cache --- pkg/api/cache.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/api/cache.go b/pkg/api/cache.go index 7cb0146..b8bc1ed 100644 --- a/pkg/api/cache.go +++ b/pkg/api/cache.go @@ -20,6 +20,7 @@ import ( // @Tags HTTP API // @Accept json // @Produce json +// @Param key path string true "Key to save to" // @Router /cache/{key} [post] // @Success 202 func (s *Server) cacheWriteHandler(w http.ResponseWriter, r *http.Request) { @@ -56,6 +57,7 @@ func (s *Server) cacheWriteHandler(w http.ResponseWriter, r *http.Request) { // @Tags HTTP API // @Accept json // @Produce json +// @Param key path string true "Key to delete" // @Router /cache/{key} [delete] // @Success 202 func (s *Server) cacheDeleteHandler(w http.ResponseWriter, r *http.Request) { @@ -87,6 +89,7 @@ func (s *Server) cacheDeleteHandler(w http.ResponseWriter, r *http.Request) { // @Tags HTTP API // @Accept json // @Produce json +// @Param key path string true "Key to load from cache" // @Router /cache/{key} [get] // @Success 200 {string} string value func (s *Server) cacheReadHandler(w http.ResponseWriter, r *http.Request) {