aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-19 15:44:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

improved REST API documentation

Browse Source
This commit is contained in:
Bernhard B
2023-10-07 11:29:41 +02:00
parent 9e09775d94
commit b45aab70a7
4 changed files with 106 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/api/api.go
View File

@@ -109,7 +109,7 @@ type SendMessageV2 struct {
QuoteAuthor *string `json:"quote_author"`
QuoteMessage *string `json:"quote_message"`
QuoteMentions []client.MessageMention `json:"quote_mentions"`
TextMode *string `json:"text_mode"`
TextMode *string `json:"text_mode" enums:"normal,styled"`
}
type TypingIndicatorRequest struct {
@@ -341,7 +341,7 @@ func (a *Api) Send(c *gin.Context) {
// @Summary Send a signal message.
// @Tags Messages
// @Description Send a signal message
// @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~.
// @Accept json
// @Produce json
// @Success 201 {object} SendMessageResponse

41
src/docs/docs.go
View File

@@ -333,6 +333,39 @@ var doc = `{
}
}
},
"/v1/contacts{number}/sync": {
"post": {
"description": "Send a synchronization message with the local contacts list to all linked devices. This command should only be used if this is the primary device.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Contacts"
],
"summary": "Send a synchronization message with the local contacts list to all linked devices.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/devices/{number}": {
"post": {
"description": "Links another device to this device. Only works, if this is the master device.",
@@ -1566,7 +1599,7 @@ var doc = `{
},
"/v2/send": {
"post": {
"description": "Send a signal message",
"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~.",
"consumes": [
"application/json"
],
@@ -1839,7 +1872,11 @@ var doc = `{
"type": "string"
},
"text_mode": {
"type": "string"
"type": "string",
"enum": [
"normal",
"styled"
]
}
}
},

41
src/docs/swagger.json
View File

@@ -317,6 +317,39 @@
}
}
},
"/v1/contacts{number}/sync": {
"post": {
"description": "Send a synchronization message with the local contacts list to all linked devices. This command should only be used if this is the primary device.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Contacts"
],
"summary": "Send a synchronization message with the local contacts list to all linked devices.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/devices/{number}": {
"post": {
"description": "Links another device to this device. Only works, if this is the master device.",
@@ -1550,7 +1583,7 @@
},
"/v2/send": {
"post": {
"description": "Send a signal message",
"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~.",
"consumes": [
"application/json"
],
@@ -1823,7 +1856,11 @@
"type": "string"
},
"text_mode": {
"type": "string"
"type": "string",
"enum": [
"normal",
"styled"
]
}
}
},

27
src/docs/swagger.yaml
View File

@@ -154,6 +154,9 @@ definitions:
sticker:
type: string
text_mode:
enum:
- normal
- styled
type: string
type: object
api.TrustIdentityRequest:
@@ -497,6 +500,28 @@ paths:
summary: Updates the info associated to a number on the contact list. If the contact doesn’t exist yet, it will be added.
tags:
- Contacts
/v1/contacts{number}/sync:
post:
consumes:
- application/json
description: Send a synchronization message with the local contacts list to all linked devices. This command should only be used if this is the primary device.
parameters:
- description: Registered Phone Number
in: path
name: number
required: true
type: string
produces:
- application/json
responses:
"204": {}
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Send a synchronization message with the local contacts list to all linked devices.
tags:
- Contacts
/v1/devices/{number}:
post:
consumes:
@@ -1317,7 +1342,7 @@ paths:
post:
consumes:
- application/json
description: Send a signal message
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~.'
parameters:
- description: Input Data
in: body