nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-01-26 19:03:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation

Browse Source
This commit is contained in:
Era Dorta 2025-08-29 19:55:45 +02:00
parent d25a454f39
commit f078e1a2ae
3 changed files with 175 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
src/docs/docs.go
View File

@ -1854,6 +1854,53 @@ const docTemplate = `{
}
}
},
"/v1/remote-delete/{number}": {
"post": {
"description": "Delete a signal message",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Messages"
],
"summary": "Delete a signal message.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Type",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.RemoteDeleteRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/api.RemoteDeleteResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/search/{number}": {
"get": {
"description": "Check if one or more phone numbers are registered with the Signal Service.",
@ -2394,6 +2441,25 @@ const docTemplate = `{
}
}
},
"api.RemoteDeleteRequest": {
"type": "object",
"properties": {
"recipient": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"api.RemoteDeleteResponse": {
"type": "object",
"properties": {
"timestamp": {
"type": "string"
}
}
},
"api.SearchResponse": {
"type": "object",
"properties": {

66
src/docs/swagger.json
View File

@ -1851,6 +1851,53 @@
}
}
},
"/v1/remote-delete/{number}": {
"post": {
"description": "Delete a signal message",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Messages"
],
"summary": "Delete a signal message.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Type",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.RemoteDeleteRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/api.RemoteDeleteResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/search/{number}": {
"get": {
"description": "Check if one or more phone numbers are registered with the Signal Service.",
@ -2391,6 +2438,25 @@
}
}
},
"api.RemoteDeleteRequest": {
"type": "object",
"properties": {
"recipient": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"api.RemoteDeleteResponse": {
"type": "object",
"properties": {
"timestamp": {
"type": "string"
}
}
},
"api.SearchResponse": {
"type": "object",
"properties": {

43
src/docs/swagger.yaml
View File

@ -121,6 +121,18 @@ definitions:
use_voice:
type: boolean
type: object
api.RemoteDeleteRequest:
properties:
recipient:
type: string
timestamp:
type: integer
type: object
api.RemoteDeleteResponse:
properties:
timestamp:
type: string
type: object
api.SearchResponse:
properties:
number:
@ -1706,6 +1718,37 @@ paths:
summary: Verify a registered phone number.
tags:
- Devices
/v1/remote-delete/{number}:
post:
consumes:
- application/json
description: Delete a signal message
parameters:
- description: Registered Phone Number
in: path
name: number
required: true
type: string
- description: Type
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.RemoteDeleteRequest'
produces:
- application/json
responses:
"201":
description: Created
schema:
$ref: '#/definitions/api.RemoteDeleteResponse'
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Delete a signal message.
tags:
- Messages
/v1/search/{number}:
get:
consumes: