improved swagger documentation

* documented styling options in v2/send endpoint
bbernhard · Feb 9, 2025 · 4f07a64 · 4f07a64
1 parent 845ea54
commit 4f07a64
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git 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 formatting 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~, ||spoiler||, \`monospace\`. 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
@@ -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 formatting 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~, ||spoiler||, \\` + "`" + `monospace\\` + "`" + `. 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
@@ -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 formatting 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~, ||spoiler||, \\`monospace\\`. 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
@@ -1753,9 +1753,9 @@ paths:
       consumes:
       - 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 formatting
-        character, prefix it with two backslashes (''\\'')'
+        you want to add formatting to your text message. Styling Options: \*italic
+        text\*, \*\*bold text\*\*, ~strikethrough text~, ||spoiler||, \`monospace\`.
+        If you want to escape a formatting character, prefix it with two backslashes.'
       parameters:
       - description: Input Data
         in: body