eddy/wwebjs-api
Watch
1
0
Fork
You've already forked wwebjs-api
 0
Code Issues 1 Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

swagger: document health controller

Browse source
This commit is contained in:
Anton Voylenko 2024-12-04 14:18:48 +02:00
commit b0a04f98a1
2 changed files with 68 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

35
swagger.json
View file

@ -35,10 +35,19 @@
"tags": [
"Various"
],
"description": "",
"summary": "Health check",
"description": "Responds to request with \"pong\" message",
"responses": {
"200": {
"description": "OK"
"description": "Response message",
"content": {
"application/json": {
"example": {
"success": true,
"message": "pong"
}
}
}
}
}
}
@ -48,7 +57,8 @@
"tags": [
"Various"
],
"description": "",
"summary": "Local callback",
"description": "Used to generate a QR code and writes a log file. ONLY FOR DEVELOPMENT/TEST PURPOSES.",
"parameters": [
{
"name": "x-api-key",
@ -60,7 +70,14 @@
],
"responses": {
"200": {
"description": "OK"
"description": "Response message",
"content": {
"application/json": {
"example": {
"success": true
}
}
}
},
"403": {
"description": "Forbidden.",
@ -71,6 +88,16 @@
}
}
}
},
"500": {
"description": "Server Failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [