nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-05-30 15:24:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

improved swagger documentation

Browse Source 
* documented styling options in v2/send endpoint
This commit is contained in:
Bernhard B 2025-02-09 22:40:01 +01:00
parent 845ea54d0a
commit 4f07a64d68
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/api/api.go
View File

@ -395,7 +395,7 @@ func (a *Api) Send(c *gin.Context) {
// @Summary Send a signal message. // @Summary Send a signal message.
// @Tags Messages // @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 // @Accept json
// @Produce json // @Produce json
// @Success 201 {object} SendMessageResponse // @Success 201 {object} SendMessageResponse

2
src/docs/docs.go
View File

@ -2014,7 +2014,7 @@ const docTemplate = `{
}, },
"/v2/send": { "/v2/send": {
"post": { "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": [ "consumes": [
"application/json" "application/json"
], ],

2
src/docs/swagger.json
View File

@ -2011,7 +2011,7 @@
}, },
"/v2/send": { "/v2/send": {
"post": { "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": [ "consumes": [
"application/json" "application/json"
], ],

6
src/docs/swagger.yaml
View File

@ -1753,9 +1753,9 @@ paths:
consumes: consumes:
- application/json - application/json
description: 'Send a signal message. Set the text_mode to ''styled'' in case 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 you want to add formatting to your text message. Styling Options: \*italic
text*, **bold text**, ~strikethrough text~. If you want to escape a formatting text\*, \*\*bold text\*\*, ~strikethrough text~, ||spoiler||, \`monospace\`.
character, prefix it with two backslashes (''\\'')' If you want to escape a formatting character, prefix it with two backslashes.'
parameters: parameters:
- description: Input Data - description: Input Data
in: body in: body