nik/signal-cli-rest-api
1
0
Fork 0
mirror of https://github.com/bbernhard/signal-cli-rest-api.git synced 2026-05-01 10:41:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

rebuild swagger documentation

Browse Source
This commit is contained in:
Bernhard B 2021-11-06 14:55:09 +01:00
parent a6489ce742
commit e5d170eaf6
3 changed files with 517 additions and 419 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
src/docs/docs.go
View File

@ -694,6 +694,84 @@ var doc = `{
} }
} }
}, },
"/v1/reactions/{number}": {
"post": {
"description": "React to a message",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Reactions"
],
"summary": "Send a reaction.",
"parameters": [
{
"description": "Reaction",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Reaction"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
},
"delete": {
"description": "Remove a reaction",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"Reactions"
],
"summary": "Remove a reaction.",
"parameters": [
{
"description": "Reaction",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/api.Reaction"
}
}
],
"responses": {
"204": {
"description": "No Content",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/api.Error"
}
}
}
}
},
"/v1/receive/{number}": { "/v1/receive/{number}": {
"get": { "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.", "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.",
@ -1091,6 +1169,23 @@ var doc = `{
} }
} }
}, },
"api.Reaction": {
"type": "object",
"properties": {
"reaction": {
"type": "string"
},
"recipient": {
"type": "string"
},
"target_author": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"api.RegisterNumberRequest": { "api.RegisterNumberRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -1295,6 +1390,10 @@ var doc = `{
{ {
"description": "List and Trust Identities.", "description": "List and Trust Identities.",
"name": "Identities" "name": "Identities"
},
{
"description": "React to messages.",
"name": "Reactions"
} }
] ]
}` }`

44
src/docs/swagger.json
View File

@ -681,7 +681,7 @@
}, },
"/v1/reactions/{number}": { "/v1/reactions/{number}": {
"post": { "post": {
"description": "React to a message.", "description": "React to a message",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -694,7 +694,7 @@
"summary": "Send a reaction.", "summary": "Send a reaction.",
"parameters": [ "parameters": [
{ {
"description": "Reactions", "description": "Reaction",
"name": "data", "name": "data",
"in": "body", "in": "body",
"required": true, "required": true,
@ -719,7 +719,7 @@
} }
}, },
"delete": { "delete": {
"description": "Delete a reaction.", "description": "Remove a reaction",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@ -729,10 +729,10 @@
"tags": [ "tags": [
"Reactions" "Reactions"
], ],
"summary": "Delete a reaction.", "summary": "Remove a reaction.",
"parameters": [ "parameters": [
{ {
"description": "Reactions", "description": "Reaction",
"name": "data", "name": "data",
"in": "body", "in": "body",
"required": true, "required": true,
@ -757,23 +757,6 @@
} }
} }
}, },
"api.Reaction": {
"type": "object",
"properties": {
"recipient": {
"type": "string"
},
"reaction": {
"type": "string"
},
"target_author": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"/v1/receive/{number}": { "/v1/receive/{number}": {
"get": { "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.", "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.",
@ -1171,6 +1154,23 @@
} }
} }
}, },
"api.Reaction": {
"type": "object",
"properties": {
"reaction": {
"type": "string"
},
"recipient": {
"type": "string"
},
"target_author": {
"type": "string"
},
"timestamp": {
"type": "integer"
}
}
},
"api.RegisterNumberRequest": { "api.RegisterNumberRequest": {
"type": "object", "type": "object",
"properties": { "properties": {

793
src/docs/swagger.yaml
View File

File diff suppressed because it is too large Load Diff