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

re-generated swagger documentation

Browse Source
This commit is contained in:
Bernhard B
2022-01-15 19:55:04 +01:00
parent 1f622e3305
commit b64ee6bbb8
3 changed files with 133 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/docs/docs.go
View File

@@ -1091,6 +1091,47 @@ var doc = `{
}
}
},
"/v1/unregister/{number}": {
"post": {
"description": "Disables push support for this device. **WARNING:** If *delete_account* is set to *true*, the account will be deleted from the Signal Server. This cannot be undone without loss.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Devices"
],
"summary": "Unregister a phone number.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Additional Settings",
"name": "data",
"in": "body",
"schema": {
"$ref": "#/definitions/api.UnregisterNumberRequest"
}
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v2/send": {
"post": {
"description": "Send a signal message",
@@ -1323,6 +1364,15 @@ var doc = `{
}
}
},
"api.UnregisterNumberRequest": {
"type": "object",
"properties": {
"delete_account": {
"type": "boolean",
"example": false
}
}
},
"api.UpdateProfileRequest": {
"type": "object",
"properties": {

50
src/docs/swagger.json
View File

@@ -1076,6 +1076,47 @@
}
}
},
"/v1/unregister/{number}": {
"post": {
"description": "Disables push support for this device. **WARNING:** If *delete_account* is set to *true*, the account will be deleted from the Signal Server. This cannot be undone without loss.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Devices"
],
"summary": "Unregister a phone number.",
"parameters": [
{
"type": "string",
"description": "Registered Phone Number",
"name": "number",
"in": "path",
"required": true
},
{
"description": "Additional Settings",
"name": "data",
"in": "body",
"schema": {
"$ref": "#/definitions/api.UnregisterNumberRequest"
}
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v2/send": {
"post": {
"description": "Send a signal message",
@@ -1308,6 +1349,15 @@
}
}
},
"api.UnregisterNumberRequest": {
"type": "object",
"properties": {
"delete_account": {
"type": "boolean",
"example": false
}
}
},
"api.UpdateProfileRequest": {
"type": "object",
"properties": {

33
src/docs/swagger.yaml
View File

@@ -124,6 +124,12 @@ definitions:
recipient:
type: string
type: object
api.UnregisterNumberRequest:
properties:
delete_account:
example: false
type: boolean
type: object
api.UpdateProfileRequest:
properties:
base64_avatar:
@@ -900,6 +906,33 @@ paths:
summary: Show Typing Indicator.
tags:
- Messages
/v1/unregister/{number}:
post:
consumes:
- application/json
description: Disables push support for this device. **WARNING:** If *delete_account* is set to *true*, the account will be deleted from the Signal Server. This cannot be undone without loss.
parameters:
- description: Registered Phone Number
in: path
name: number
required: true
type: string
- description: Additional Settings
in: body
name: data
schema:
$ref: '#/definitions/api.UnregisterNumberRequest'
produces:
- application/json
responses:
"204": {}
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Unregister a phone number.
tags:
- Devices
/v2/send:
post:
consumes: