From d5a1d252a271dd552d193aff0dbecf841666b045 Mon Sep 17 00:00:00 2001 From: Bernhard B Date: Tue, 24 Dec 2024 23:16:50 +0100 Subject: [PATCH] fixed swagger API documentation --- src/api/api.go | 2 +- src/docs/docs.go | 2 +- src/docs/swagger.json | 2 +- src/docs/swagger.yaml | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/api/api.go b/src/api/api.go index 7361eff..cbda348 100644 --- a/src/api/api.go +++ b/src/api/api.go @@ -395,7 +395,7 @@ func (a *Api) Send(c *gin.Context) { // @Summary Send a signal message. // @Tags Messages -// @Description Send a signal message. Set the text_mode to 'styled' in case you want to add formatting to your text message. Styling Options: *italic text*, **bold text**, ~strikethrough text~. If you want to escape a character, prefix it with two backslashes ('\\') +// @Description Send a signal message. Set the text_mode to 'styled' in case you want to add formatting to your text message. Styling Options: *italic text*, **bold text**, ~strikethrough text~. If you want to escape a formatting character, prefix it with two backslashes ('\\') // @Accept json // @Produce json // @Success 201 {object} SendMessageResponse diff --git a/src/docs/docs.go b/src/docs/docs.go index 77d517f..1f48d2e 100644 --- a/src/docs/docs.go +++ b/src/docs/docs.go @@ -2014,7 +2014,7 @@ const docTemplate = `{ }, "/v2/send": { "post": { - "description": "Send a signal message. Set the text_mode to 'styled' in case you want to add formatting to your text message. Styling Options: *italic text*, **bold text**, ~strikethrough text~. If you want to escape a character, prefix it with two backslashes ('\\\\')", + "description": "Send a signal message. Set the text_mode to 'styled' in case you want to add formatting to your text message. Styling Options: *italic text*, **bold text**, ~strikethrough text~. If you want to escape a formatting character, prefix it with two backslashes ('\\\\')", "consumes": [ "application/json" ], diff --git a/src/docs/swagger.json b/src/docs/swagger.json index b032016..43e0d25 100644 --- a/src/docs/swagger.json +++ b/src/docs/swagger.json @@ -2011,7 +2011,7 @@ }, "/v2/send": { "post": { - "description": "Send a signal message. Set the text_mode to 'styled' in case you want to add formatting to your text message. Styling Options: *italic text*, **bold text**, ~strikethrough text~. If you want to escape a character, prefix it with two backslashes ('\\\\')", + "description": "Send a signal message. Set the text_mode to 'styled' in case you want to add formatting to your text message. Styling Options: *italic text*, **bold text**, ~strikethrough text~. If you want to escape a formatting character, prefix it with two backslashes ('\\\\')", "consumes": [ "application/json" ], diff --git a/src/docs/swagger.yaml b/src/docs/swagger.yaml index 0f55f66..6f2f703 100644 --- a/src/docs/swagger.yaml +++ b/src/docs/swagger.yaml @@ -1754,8 +1754,8 @@ paths: - application/json description: 'Send a signal message. Set the text_mode to ''styled'' in case you want to add formatting to your text message. Styling Options: *italic - text*, **bold text**, ~strikethrough text~. If you want to escape a character, - prefix it with two backslashes (''\\'')' + text*, **bold text**, ~strikethrough text~. If you want to escape a formatting + character, prefix it with two backslashes (''\\'')' parameters: - description: Input Data in: body