blitz_api/app/apps/docs.py

55 lines
1.3 KiB
Python
Raw Permalink Normal View History

2021-06-20 10:26:21 +02:00
get_app_status_response_docs = """
Returns a JSON list with the current status of all available apps
2021-06-20 10:26:21 +02:00
```
{
"data": [
{
"id": "btcpayserver",
"version": "v1.13.0",
"installed": false,
"configured": false,
"status": "offline",
"local_ip": null,
"http_port": null,
"https_port": null,
"https_forced": null,
"https_self_signed": null,
"hidden_service": null,
"address": null,
"auth_method": null,
"details": null,
"error": null
},
2021-06-20 10:26:21 +02:00
{
"id": "btc-rpc-explorer",
"version": "v3.4.0",
"installed": false,
"configured": false,
"status": "offline",
"local_ip": null,
...
2021-06-20 10:26:21 +02:00
},
...
],
"errors": [
2021-06-20 10:26:21 +02:00
{
"id": "rtl",
"error": "App status script execution failed.\n├╴at /home/blitzapi/blitz_api/app/apps/impl/raspiblitz.py:92:10\n├╴script_name: /home/admin/config.scripts/bonus.rtl.sh status\n\n╰─▶ 500: Something went wrong!\n ╰╴at /home/blitzapi/blitz_api/app/apps/impl/raspiblitz.py:92:10"
2021-06-20 10:26:21 +02:00
},
...
]
}
2021-06-20 10:26:21 +02:00
```
"""
get_app_status_sub_response_docs = """
Sends a JSON object with the status of an app if it changes.
```
{
id: 'specter',
name: 'Specter Desktop',
status: 'online'
},
```
"""