aljaz/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/signal-cli-rest-api.git synced 2025-12-19 23:54:22 +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

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"
]
}
}
},