From 5d02d7b5af97e611c52fcfe39a84aaadcbcae9db Mon Sep 17 00:00:00 2001 From: Arya Kiran Date: Sun, 27 Aug 2023 21:29:14 +0530 Subject: [PATCH] swag fmt + clarify translate engine all --- pages/api.go | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/pages/api.go b/pages/api.go index 8c07d61..6a37c19 100644 --- a/pages/api.go +++ b/pages/api.go @@ -9,7 +9,7 @@ import ( // @Summary Show list of available source languages for engine // @Param engine query string true "Engine name" // @Success 200 {object} utils.List -// @Router /api/source_languages [get] +// @Router /api/source_languages [get] func HandleSourceLanguages(c *fiber.Ctx) error { engine := utils.Sanitize(c.Query("engine"), "alpha") if engine == "" { @@ -26,7 +26,7 @@ func HandleSourceLanguages(c *fiber.Ctx) error { // @Summary Show list of available target languages for engine // @Param engine query string true "Engine name" // @Success 200 {object} utils.List -// @Router /api/target_languages [get] +// @Router /api/target_languages [get] func HandleTargetLanguages(c *fiber.Ctx) error { engine := utils.Sanitize(c.Query("engine"), "alpha") if engine == "" { @@ -41,10 +41,10 @@ func HandleTargetLanguages(c *fiber.Ctx) error { // HandleTTS godoc // @Summary Get Text-To-Speech for specified language using specified engine -// @Param engine query string true "Engine name" -// @Param lang query string true "Language being TTS'd" -// @Param text query string true "Text being TTS'd" -// @Router /api/tts [get] +// @Param engine query string true "Engine name" +// @Param lang query string true "Language being TTS'd" +// @Param text query string true "Text being TTS'd" +// @Router /api/tts [get] func HandleTTS(c *fiber.Ctx) error { engine := utils.Sanitize(c.Query("engine"), "alpha") lang := utils.Sanitize(c.Query("lang"), "alpha") @@ -61,13 +61,14 @@ func HandleTTS(c *fiber.Ctx) error { } // HandleTranslate godoc -// @Summary Translate text -// @Param engine query string true "Engine name" -// @Param from query string true "Source language" -// @Param to query string true "Target language" -// @Param text query string true "Text being translated" -// @Success 200 {object} utils.LangOut -// @Router /api/translate [get] +// @Summary Translate text +// @Description When engine is set to all, it will return an array of utils.LangOut. +// @Param engine query string true "Engine name" +// @Param from query string true "Source language" +// @Param to query string true "Target language" +// @Param text query string true "Text being translated" +// @Success 200 {object} utils.LangOut +// @Router /api/translate [get] func HandleTranslate(c *fiber.Ctx) error { engine := utils.Sanitize(c.Query("engine"), "alpha") from := utils.Sanitize(c.Query("from"), "alpha")