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

added new REST API endpoints

Browse Source 
* added endpoint to add members to an existing group
* added endpoint to remove members from an existing group

see #210
This commit is contained in:
Bernhard B
2022-03-20 20:39:40 +01:00
parent 4a9aa9b0f3
commit 3fcd6221d2
6 changed files with 426 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
src/docs/docs.go
View File

@@ -557,6 +557,98 @@ var doc = `{
}
}
},
"/v1/groups/{number}/{groupid}/members": {
"post": {
"description": "Add one or more members to an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Add one or more members to an existing Signal Group.",
"parameters": [
{
"description": "Members",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupMembersRequest"
}
},
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
},
"delete": {
"description": "Remove one or more members from an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Remove one or more members from an existing Signal Group.",
"parameters": [
{
"description": "Members",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupMembersRequest"
}
},
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/groups/{number}/{groupid}/quit": {
"post": {
"description": "Quit the specified Signal Group.",
@@ -1266,6 +1358,17 @@ var doc = `{
}
}
},
"api.ChangeGroupMembersRequest": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.Configuration": {
"type": "object",
"properties": {

103
src/docs/swagger.json
View File

@@ -541,6 +541,98 @@
}
}
},
"/v1/groups/{number}/{groupid}/members": {
"post": {
"description": "Add one or more members to an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Add one or more members to an existing Signal Group.",
"parameters": [
{
"description": "Members",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupMembersRequest"
}
},
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
},
"delete": {
"description": "Remove one or more members from an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Remove one or more members from an existing Signal Group.",
"parameters": [
{
"description": "Members",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupMembersRequest"
}
},
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/groups/{number}/{groupid}/quit": {
"post": {
"description": "Quit the specified Signal Group.",
@@ -1250,6 +1342,17 @@
}
}
},
"api.ChangeGroupMembersRequest": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.Configuration": {
"type": "object",
"properties": {

68
src/docs/swagger.yaml
View File

@@ -5,6 +5,13 @@ definitions:
uri:
type: string
type: object
api.ChangeGroupMembersRequest:
properties:
members:
items:
type: string
type: array
type: object
api.Configuration:
properties:
logging:
@@ -567,6 +574,67 @@ paths:
summary: Join a Signal Group.
tags:
- Groups
/v1/groups/{number}/{groupid}/members:
delete:
consumes:
- application/json
description: Remove one or more members from an existing Signal Group.
parameters:
- description: Members
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.ChangeGroupMembersRequest'
- description: Registered Phone Number
in: path
name: number
required: true
type: string
produces:
- application/json
responses:
"204":
description: No Content
schema:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Remove one or more members from an existing Signal Group.
tags:
- Groups
post:
consumes:
- application/json
description: Add one or more members to an existing Signal Group.
parameters:
- description: Members
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.ChangeGroupMembersRequest'
- description: Registered Phone Number
in: path
name: number
required: true
type: string
produces:
- application/json
responses:
"204":
description: No Content
schema:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Add one or more members to an existing Signal Group.
tags:
- Groups
/v1/groups/{number}/{groupid}/quit:
post:
consumes: