nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-09-21 06:20:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

fixed swagger API documentation

Browse Source
This commit is contained in:
Bernhard B 2024-12-24 23:16:50 +01:00
parent a70c2994c3
commit d5a1d252a2
4 changed files with 5 additions and 5 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 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 // @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 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": [ "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 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": [ "consumes": [
"application/json" "application/json"
], ],

4
src/docs/swagger.yaml
View File

@ -1754,8 +1754,8 @@ paths:
- 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 character, text*, **bold text**, ~strikethrough text~. If you want to escape a formatting
prefix it with two backslashes (''\\'')' character, prefix it with two backslashes (''\\'')'
parameters: parameters:
- description: Input Data - description: Input Data
in: body in: body