nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-11-11 11:30:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Terminate group docs: drop the groups v2 detail

Browse Source 
As suggested in review: it's confusing for most people, and signal-cli
returns an error if it doesn't apply.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Joseph Giambo 2026-11-08 10:36:36 -08:00
parent 605badab81
commit 39319d2ae0
4 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/EXAMPLES.md
View File

@ -127,7 +127,7 @@ e.g:
- Terminate (end) a group for everyone
Permanently end the group with the given group id for all members. Afterwards nobody, not even an admin, can send messages or start calls in the group, but members keep the message history. This can't be undone. The account must be an admin of the group, and only groups v2 are supported.
Permanently end the group with the given group id for all members. Afterwards nobody, not even an admin, can send messages or start calls in the group, but members keep the message history. This can't be undone. The account must be an admin of the group.
`curl -X POST -H "Content-Type: application/json" 'http://127.0.0.1:8080/v1/groups/<number>/<group id>/terminate'`

2
src/api/api.go
View File

@ -1792,7 +1792,7 @@ func (a *Api) QuitGroup(c *gin.Context) {
// @Summary Terminate a Signal Group for all members.
// @Tags Groups
// @Description Permanently end the specified Signal Group for everyone ("End group" in the Signal apps). Afterwards no member, not even an admin, can send messages or start calls in the group; members keep the existing message history. This can't be undone. Requires admin rights in the group and is only supported for groups v2.
// @Description Permanently end the specified Signal Group for everyone ("End group" in the Signal apps). Afterwards no member, not even an admin, can send messages or start calls in the group; members keep the existing message history. This can't be undone. Requires admin rights in the group.
// @Accept json
// @Produce json
// @Success 204 {string} OK

2
src/docs/docs.go
View File

@ -4087,7 +4087,7 @@ const docTemplate = `{
"consumes": [
"application/json"
],
"description": "Permanently end the specified Signal Group for everyone (\"End group\" in the Signal apps). Afterwards no member, not even an admin, can send messages or start calls in the group; members keep the existing message history. This can't be undone. Requires admin rights in the group and is only supported for groups v2.",
"description": "Permanently end the specified Signal Group for everyone (\"End group\" in the Signal apps). Afterwards no member, not even an admin, can send messages or start calls in the group; members keep the existing message history. This can't be undone. Requires admin rights in the group.",
"parameters": [
{
"description": "Account identifier (E.164 phone number or ACI UUID)",

2
src/docs/swagger.json
View File

@ -4082,7 +4082,7 @@
"consumes": [
"application/json"
],
"description": "Permanently end the specified Signal Group for everyone (\"End group\" in the Signal apps). Afterwards no member, not even an admin, can send messages or start calls in the group; members keep the existing message history. This can't be undone. Requires admin rights in the group and is only supported for groups v2.",
"description": "Permanently end the specified Signal Group for everyone (\"End group\" in the Signal apps). Afterwards no member, not even an admin, can send messages or start calls in the group; members keep the existing message history. This can't be undone. Requires admin rights in the group.",
"parameters": [
{
"description": "Account identifier (E.164 phone number or ACI UUID)",