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

activate endpoint and write swagger documentation

Browse Source
This commit is contained in:
René Filip
2021-11-06 00:43:02 +01:00
parent 6bf60a23e6
commit 3bd0d97970
6 changed files with 490 additions and 321 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docker-compose.yml
View File

@@ -1,9 +1,11 @@
version: "3"
services:
signal-cli-rest-api:
image: bbernhard/signal-cli-rest-api:latest
#image: bbernhard/signal-cli-rest-api:latest
build: .
environment:
- MODE=normal #supported modes: json-rpc, native, normal
# - MODE=normal #supported modes: json-rpc, native, normal
- MODE=json-rpc #supported modes: json-rpc, native, normal
#- AUTO_RECEIVE_SCHEDULE=0 22 * * * #enable this parameter on demand (see description below)
ports:
- "8080:8080" #map docker port 8080 to host port 8080.

9
src/api/api.go
View File

@@ -902,7 +902,7 @@ func (a *Api) QuitGroup(c *gin.Context) {
// @Success 204 {string} OK
// @Failure 400 {object} Error
// @Param data body Reaction true "Reaction"
// @Router /v1/reaction/{number} [post]
// @Router /v1/reactions/{number} [post]
func (a *Api) SendReaction(c *gin.Context) {
var req Reaction
err := c.BindJSON(&req)
@@ -950,7 +950,7 @@ func (a *Api) SendReaction(c *gin.Context) {
// @Success 204 {string} OK
// @Failure 400 {object} Error
// @Param data body Reaction true "Reaction"
// @Router /v1/reaction/{number} [delete]
// @Router /v1/reactions/{number} [delete]
func (a *Api) RemoveReaction(c *gin.Context) {
var req Reaction
err := c.BindJSON(&req)
@@ -967,11 +967,6 @@ func (a *Api) RemoveReaction(c *gin.Context) {
return
}
if req.Reaction == "" {
c.JSON(400, Error{Msg: "Couldn't process request - reaction missing"})
return
}
if req.TargetAuthor == "" {
c.JSON(400, Error{Msg: "Couldn't process request - target_author missing"})
return

5
src/client/client.go
View File

@@ -1008,6 +1008,9 @@ func (s *SignalClient) SendReaction(number string, recipient string, emoji strin
return errors.New("Invalid group id")
}
}
if remove && emoji == "" {
emoji = "👍" // emoji must not be empty to remove a reaction
}
if s.signalCliMode == JsonRpc {
type Request struct {
@@ -1027,7 +1030,7 @@ func (s *SignalClient) SendReaction(number string, recipient string, emoji strin
request.Emoji = emoji
request.TargetAuthor = target_author
request.Timestamp = timestamp
if remove == true {
if remove {
request.Remove = remove
}
jsonRpc2Client, err := s.getJsonRpc2Client(number)

99
src/docs/swagger.json
View File

@@ -679,6 +679,101 @@
}
}
},
"/v1/reaction/{number}": {
"post": {
"description": "React to a message.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Reaction"
],
"summary": "Send a reaction.",
"parameters": [
{
"description": "Reaction",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Reaction"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
},
"delete": {
"description": "Delete a reaction.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Reaction"
],
"summary": "Delete a reaction.",
"parameters": [
{
"description": "Reaction",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Reaction"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"api.Reaction": {
"type": "object",
"properties": {
"recipient": {
"type": "string"
},
"reaction": {
"type": "string"
},
"target_author": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"/v1/receive/{number}": {
"get": {
"description": "Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint.",
@@ -1280,6 +1375,10 @@
{
"description": "List and Trust Identities.",
"name": "Identities"
},
{
"description": "React to messages.",
"name": "Reaction"
}
]
}

163
src/docs/swagger.yaml
View File

@@ -1,9 +1,9 @@
basePath: /
"basePath: /
definitions:
api.Configuration:
properties:
logging:
$ref: '#/definitions/api.LoggingConfiguration'
$ref: "#/definitions/api.LoggingConfiguration"
type: object
type: object
api.CreateGroupRequest:
@@ -23,7 +23,7 @@ definitions:
name:
type: string
permissions:
$ref: '#/definitions/api.GroupPermissions'
$ref: "#/definitions/api.GroupPermissions"
type: object
type: object
api.CreateGroupResponse:
@@ -54,6 +54,17 @@ definitions:
Level:
type: string
type: object
api.Reaction:
properties:
recipient:
type: string
reaction:
type: string
target_author:
type: string
timestamp:
type: integer
type: object
api.RegisterNumberRequest:
properties:
captcha:
@@ -184,7 +195,7 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/client.About'
$ref: "#/definitions/client.About"
summary: Lists general information about the API
tags:
- General
@@ -203,7 +214,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: List all attachments.
tags:
- Attachments
@@ -226,7 +237,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Remove attachment.
tags:
- Attachments
@@ -248,7 +259,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Serve Attachment.
tags:
- Attachments
@@ -263,11 +274,11 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/api.Configuration'
$ref: "#/definitions/api.Configuration"
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: List the REST API configuration.
tags:
- General
@@ -281,7 +292,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.Configuration'
$ref: "#/definitions/api.Configuration"
produces:
- application/json
responses:
@@ -292,7 +303,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Set the REST API configuration.
tags:
- General
@@ -314,12 +325,12 @@ paths:
description: OK
schema:
items:
$ref: '#/definitions/client.GroupEntry'
$ref: "#/definitions/client.GroupEntry"
type: array
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: List all Signal Groups.
tags:
- Groups
@@ -333,7 +344,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.CreateGroupRequest'
$ref: "#/definitions/api.CreateGroupRequest"
- description: Registered Phone Number
in: path
name: number
@@ -345,11 +356,11 @@ paths:
"201":
description: Created
schema:
$ref: '#/definitions/api.CreateGroupResponse'
$ref: "#/definitions/api.CreateGroupResponse"
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Create a new Signal Group.
tags:
- Groups
@@ -379,7 +390,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Delete a Signal Group.
tags:
- Groups
@@ -404,11 +415,11 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/client.GroupEntry'
$ref: "#/definitions/client.GroupEntry"
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: List a Signal Group.
tags:
- Groups
@@ -438,7 +449,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Block a Signal Group.
tags:
- Groups
@@ -468,7 +479,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Join a Signal Group.
tags:
- Groups
@@ -498,7 +509,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Quit a Signal Group.
tags:
- Groups
@@ -531,7 +542,7 @@ paths:
description: OK
schema:
items:
$ref: '#/definitions/client.IdentityEntry'
$ref: "#/definitions/client.IdentityEntry"
type: array
summary: List Identities
tags:
@@ -545,7 +556,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.TrustIdentityRequest'
$ref: "#/definitions/api.TrustIdentityRequest"
- description: Registered Phone Number
in: path
name: number
@@ -575,7 +586,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.UpdateProfileRequest'
$ref: "#/definitions/api.UpdateProfileRequest"
- description: Registered Phone Number
in: path
name: number
@@ -591,7 +602,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Update Profile.
tags:
- Profiles
@@ -614,10 +625,61 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Link device and generate QR code.
tags:
- Devices
/v1/reaction/{number}:
post:
consumes:
- application/json
description: React to a message.
parameters:
- description: Reaction
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.Reaction'
produces:
- application/json
responses:
"204":
description: No Content
schema:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Send a reaction.
tags:
- Reaction
delete:
consumes:
- application/json
description: Delete a reaction.
parameters:
- description: Reaction
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.Reaction'
produces:
- application/json
responses:
"204":
description: No Content
schema:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Delete a reaction.
tags:
- Reaction
/v1/receive/{number}:
get:
consumes:
@@ -629,7 +691,7 @@ paths:
name: number
required: true
type: string
- description: 'Receive timeout in seconds (default: 1)'
- description: "Receive timeout in seconds (default: 1)"
in: query
name: timeout
type: string
@@ -645,7 +707,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Receive Signal Messages.
tags:
- Messages
@@ -664,7 +726,7 @@ paths:
in: body
name: data
schema:
$ref: '#/definitions/api.RegisterNumberRequest'
$ref: "#/definitions/api.RegisterNumberRequest"
produces:
- application/json
responses:
@@ -672,7 +734,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Register a phone number.
tags:
- Devices
@@ -691,7 +753,7 @@ paths:
in: body
name: data
schema:
$ref: '#/definitions/api.VerifyNumberSettings'
$ref: "#/definitions/api.VerifyNumberSettings"
- description: Verification Code
in: path
name: token
@@ -707,7 +769,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Verify a registered phone number.
tags:
- Devices
@@ -723,7 +785,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.SendMessageV1'
$ref: "#/definitions/api.SendMessageV1"
produces:
- application/json
responses:
@@ -734,7 +796,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Send a signal message.
tags:
- Messages
@@ -754,7 +816,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.TypingIndicatorRequest'
$ref: "#/definitions/api.TypingIndicatorRequest"
produces:
- application/json
responses:
@@ -765,7 +827,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Hide Typing Indicator.
tags:
- Messages
@@ -784,7 +846,7 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.TypingIndicatorRequest'
$ref: "#/definitions/api.TypingIndicatorRequest"
produces:
- application/json
responses:
@@ -795,7 +857,7 @@ paths:
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Show Typing Indicator.
tags:
- Messages
@@ -810,34 +872,37 @@ paths:
name: data
required: true
schema:
$ref: '#/definitions/api.SendMessageV2'
$ref: "#/definitions/api.SendMessageV2"
produces:
- application/json
responses:
"201":
description: Created
schema:
$ref: '#/definitions/api.SendMessageResponse'
$ref: "#/definitions/api.SendMessageResponse"
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
$ref: "#/definitions/api.Error"
summary: Send a signal message.
tags:
- Messages
swagger: "2.0"
tags:
- description: Some general endpoints.
- description: Some general endpoints.
name: General
- description: Register and link Devices.
- description: Register and link Devices.
name: Devices
- description: Create, List and Delete Signal Groups.
- description: Create, List and Delete Signal Groups.
name: Groups
- description: Send and Receive Signal Messages.
- description: Send and Receive Signal Messages.
name: Messages
- description: List and Delete Attachments.
- description: List and Delete Attachments.
name: Attachments
- description: Update Profile.
- description: Update Profile.
name: Profiles
- description: List and Trust Identities.
- description: List and Trust Identities.
name: Identities
- description: React to messages.
name: Reaction
"

15
src/main.go
View File

@@ -46,6 +46,9 @@ import (
// @tag.name Identities
// @tag.description List and Trust Identities.
// @tag.name Reaction
// @tag.description React to messages.
// @host 127.0.0.1:8080
// @BasePath /
func main() {
@@ -114,7 +117,6 @@ func main() {
}
}
jsonRpc2ClientConfigPathPath := *signalCliConfig + "/jsonrpc2.yml"
signalClient := client.NewSignalClient(*signalCliConfig, *attachmentTmpDir, *avatarTmpDir, signalCliMode, jsonRpc2ClientConfigPathPath)
err = signalClient.Init()
@@ -196,6 +198,12 @@ func main() {
typingIndicator.PUT(":number", api.SendStartTyping)
typingIndicator.DELETE(":number", api.SendStopTyping)
}
reaction := v1.Group("/reaction")
{
reaction.POST(":number", api.SendReaction)
reaction.DELETE(":number", api.RemoveReaction)
}
}
v2 := router.Group("/v2")
@@ -228,7 +236,7 @@ func main() {
filename := filepath.Base(path)
if strings.HasPrefix(filename, "+") && info.Mode().IsRegular() {
log.Debug("AUTO_RECEIVE_SCHEDULE: Calling receive for number ", filename)
resp, err := http.Get("http://127.0.0.1:" + port + "/v1/receive/"+filename)
resp, err := http.Get("http://127.0.0.1:" + port + "/v1/receive/" + filename)
if err != nil {
log.Error("AUTO_RECEIVE_SCHEDULE: Couldn't call receive for number ", filename, ": ", err.Error())
}
@@ -264,8 +272,5 @@ func main() {
c.Start()
}
router.Run()
}