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

rebuilt swagger documentation

Browse Source
This commit is contained in:
Bernhard B
2024-05-11 17:24:34 +02:00
parent e894cfee4a
commit 95e0b88671
3 changed files with 164 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
src/docs/docs.go
View File

@@ -1405,6 +1405,46 @@ var doc = `{
}
}
},
"/v1/receipts/{number}": {
"post": {
"description": "Send a read or viewed receipt",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Receipts"
],
"summary": "Send a receipt.",
"parameters": [
{
"description": "Receipt",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Receipt"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/receive/{number}": {
"get": {
"description": "Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint.",
@@ -2073,6 +2113,24 @@ var doc = `{
}
}
},
"api.Receipt": {
"type": "object",
"properties": {
"receipt_type": {
"type": "string",
"enum": [
"read",
"viewed"
]
},
"recipient": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"api.RegisterNumberRequest": {
"type": "object",
"properties": {
@@ -2495,6 +2553,10 @@ var doc = `{
"description": "React to messages.",
"name": "Reactions"
},
{
"description": "Send receipts for messages.",
"name": "Receipts"
},
{
"description": "Search the Signal Service.",
"name": "Search"

62
src/docs/swagger.json
View File

@@ -1389,6 +1389,46 @@
}
}
},
"/v1/receipts/{number}": {
"post": {
"description": "Send a read or viewed receipt",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Receipts"
],
"summary": "Send a receipt.",
"parameters": [
{
"description": "Receipt",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Receipt"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/receive/{number}": {
"get": {
"description": "Receives Signal Messages from the Signal Network. If you are running the docker container in normal/native mode, this is a GET endpoint. In json-rpc mode this is a websocket endpoint.",
@@ -2057,6 +2097,24 @@
}
}
},
"api.Receipt": {
"type": "object",
"properties": {
"receipt_type": {
"type": "string",
"enum": [
"read",
"viewed"
]
},
"recipient": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"api.RegisterNumberRequest": {
"type": "object",
"properties": {
@@ -2479,6 +2537,10 @@
"description": "React to messages.",
"name": "Reactions"
},
{
"description": "Send receipts for messages.",
"name": "Receipts"
},
{
"description": "Search the Signal Service.",
"name": "Search"

40
src/docs/swagger.yaml
View File

@@ -102,6 +102,18 @@ definitions:
timestamp:
type: integer
type: object
api.Receipt:
properties:
receipt_type:
enum:
- read
- viewed
type: string
recipient:
type: string
timestamp:
type: integer
type: object
api.RegisterNumberRequest:
properties:
captcha:
@@ -1276,6 +1288,32 @@ paths:
summary: Send a reaction.
tags:
- Reactions
/v1/receipts/{number}:
post:
consumes:
- application/json
description: Send a read or viewed receipt
parameters:
- description: Receipt
in: body
name: data
required: true
schema:
$ref: '#/definitions/api.Receipt'
produces:
- application/json
responses:
"204":
description: No Content
schema:
type: string
"400":
description: Bad Request
schema:
$ref: '#/definitions/api.Error'
summary: Send a receipt.
tags:
- Receipts
/v1/receive/{number}:
get:
consumes:
@@ -1635,6 +1673,8 @@ tags:
name: Identities
- description: React to messages.
name: Reactions
- description: Send receipts for messages.
name: Receipts
- description: Search the Signal Service.
name: Search
- description: List and Install Sticker Packs