added new API endpoints to add/remove admins to/from Signal Groups

see #232
This commit is contained in:
Bernhard B
2022-03-29 19:20:57 +02:00
parent 60b4d8afbf
commit d34fcb905e
6 changed files with 431 additions and 0 deletions

View File

@@ -467,6 +467,98 @@ var doc = `{
}
}
},
"/v1/groups/{number}/{groupid}/admins": {
"post": {
"description": "Add one or more admins to an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Add one or more admins to an existing Signal Group.",
"parameters": [
{
"description": "Admins",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupAdminsRequest"
}
},
{
"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 admins from an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Remove one or more admins from an existing Signal Group.",
"parameters": [
{
"description": "Admins",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupAdminsRequest"
}
},
{
"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}/block": {
"post": {
"description": "Block the specified Signal Group.",
@@ -1358,6 +1450,17 @@ var doc = `{
}
}
},
"api.ChangeGroupAdminsRequest": {
"type": "object",
"properties": {
"admins": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.ChangeGroupMembersRequest": {
"type": "object",
"properties": {

View File

@@ -451,6 +451,98 @@
}
}
},
"/v1/groups/{number}/{groupid}/admins": {
"post": {
"description": "Add one or more admins to an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Add one or more admins to an existing Signal Group.",
"parameters": [
{
"description": "Admins",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupAdminsRequest"
}
},
{
"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 admins from an existing Signal Group.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Groups"
],
"summary": "Remove one or more admins from an existing Signal Group.",
"parameters": [
{
"description": "Admins",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.ChangeGroupAdminsRequest"
}
},
{
"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}/block": {
"post": {
"description": "Block the specified Signal Group.",
@@ -1342,6 +1434,17 @@
}
}
},
"api.ChangeGroupAdminsRequest": {
"type": "object",
"properties": {
"admins": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"api.ChangeGroupMembersRequest": {
"type": "object",
"properties": {

View File

@@ -5,6 +5,13 @@ definitions:
uri:
type: string
type: object
api.ChangeGroupAdminsRequest:
properties:
admins:
items:
type: string
type: array
type: object
api.ChangeGroupMembersRequest:
properties:
members:
@@ -514,6 +521,67 @@ paths:
summary: List a Signal Group.
tags:
- Groups
/v1/groups/{number}/{groupid}/admins:
delete:
consumes:
- application/json
description: Remove one or more admins from an existing Signal Group.
parameters:
- description: Admins
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.ChangeGroupAdminsRequest'
- 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 admins from an existing Signal Group.
tags:
- Groups
post:
consumes:
- application/json
description: Add one or more admins to an existing Signal Group.
parameters:
- description: Admins
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.ChangeGroupAdminsRequest'
- 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 admins to an existing Signal Group.
tags:
- Groups
/v1/groups/{number}/{groupid}/block:
post:
consumes: