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

docs: fix wrong annotations for SendV2 and 200 - 201

Browse Source
This commit is contained in:
Gara Dorta 2026-09-26 23:20:04 +02:00
parent 80e0f34032
commit e9bee58aeb
3 changed files with 25 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/api/api.go
View File

@ -497,7 +497,7 @@ func (a *Api) Send(c *gin.Context) {
// @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} ds.SendMessageResponse
// @Success 201 {array} ds.SendMessageResponse
// @Failure 400 {object} SendMessageError
// @Param data body SendMessageV2 true "Input Data"
// @Router /v2/send [post]
@ -1202,7 +1202,7 @@ func (a *Api) DeleteGroup(c *gin.Context) {
// @Description Pin a message in a Signal Group.
// @Accept json
// @Produce json
// @Success 200 {string} string "OK"
// @Success 201 {string} string "OK"
// @Failure 400 {object} Error
// @Param data body PinMessageInGroupRequest true "Pin"
// @Param number path string true "Registered Phone Number"
@ -1253,7 +1253,7 @@ func (a *Api) PinMessageInGroup(c *gin.Context) {
// @Description Unpin a message in a Signal Group.
// @Accept json
// @Produce json
// @Success 200 {string} string "OK"
// @Success 201 {string} string "OK"
// @Failure 400 {object} Error
// @Param data body UnpinMessageInGroupRequest true "Unpin"
// @Param number path string true "Registered Phone Number"
@ -2426,7 +2426,7 @@ func (a *Api) SubmitRateLimitChallenge(c *gin.Context) {
// @Produce json
// @Param number path string true "Registered Phone Number"
// @Param data body UpdateAccountSettingsRequest true "Request"
// @Success 204
// @Success 201
// @Failure 400 {object} Error
// @Router /v1/accounts/{number}/settings [put]
func (a *Api) UpdateAccountSettings(c *gin.Context) {
@ -2557,7 +2557,7 @@ func (a *Api) ListInstalledStickerPacks(c *gin.Context) {
// @Accept json
// @Produce json
// @Param number path string true "Registered Phone Number"
// @Success 204
// @Success 201
// @Failure 400 {object} Error
// @Param data body AddStickerPackRequest true "Request"
// @Router /v1/sticker-packs/{number} [post]

17
src/docs/docs.go
View File

@ -2628,8 +2628,8 @@ const docTemplate = `{
"application/json"
],
"responses": {
"204": {
"description": "No Content"
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
@ -3938,7 +3938,7 @@ const docTemplate = `{
"application/json"
],
"responses": {
"200": {
"201": {
"description": "OK",
"schema": {
"type": "string"
@ -3990,7 +3990,7 @@ const docTemplate = `{
"application/json"
],
"responses": {
"200": {
"201": {
"description": "OK",
"schema": {
"type": "string"
@ -4929,8 +4929,8 @@ const docTemplate = `{
"application/json"
],
"responses": {
"204": {
"description": "No Content"
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
@ -5104,7 +5104,10 @@ const docTemplate = `{
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/data.SendMessageResponse"
"items": {
"$ref": "#/definitions/data.SendMessageResponse"
},
"type": "array"
}
},
"400": {

17
src/docs/swagger.json
View File

@ -2623,8 +2623,8 @@
"application/json"
],
"responses": {
"204": {
"description": "No Content"
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
@ -3933,7 +3933,7 @@
"application/json"
],
"responses": {
"200": {
"201": {
"description": "OK",
"schema": {
"type": "string"
@ -3985,7 +3985,7 @@
"application/json"
],
"responses": {
"200": {
"201": {
"description": "OK",
"schema": {
"type": "string"
@ -4924,8 +4924,8 @@
"application/json"
],
"responses": {
"204": {
"description": "No Content"
"201": {
"description": "Created"
},
"400": {
"description": "Bad Request",
@ -5099,7 +5099,10 @@
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/data.SendMessageResponse"
"items": {
"$ref": "#/definitions/data.SendMessageResponse"
},
"type": "array"
}
},
"400": {