lightning-terminal/litrpc/lit-status.swagger.json
2024-10-14 15:48:18 +02:00

105 lines
2.5 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "lit-status.proto",
"version": "version not set"
},
"tags": [
{
"name": "Status"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v1/status": {
"get": {
"operationId": "Status_SubServerStatus",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/litrpcSubServerStatusResp"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"tags": [
"Status"
]
}
}
},
"definitions": {
"litrpcSubServerStatus": {
"type": "object",
"properties": {
"disabled": {
"type": "boolean",
"description": "disabled is true if the sub-server is available in the LiT package but\nhas explicitly been disabled."
},
"running": {
"type": "boolean",
"description": "running is true if the sub-server is currently running."
},
"error": {
"type": "string",
"description": "error describes an error that might have resulted in the sub-server not\nstarting up properly."
},
"custom_status": {
"type": "string",
"description": "custom_status details a custom state that the sub-server has entered,\nwhich is unique to the sub-server, and which is not the standard\ndisabled, running or errored state."
}
}
},
"litrpcSubServerStatusResp": {
"type": "object",
"properties": {
"sub_servers": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/litrpcSubServerStatus"
},
"description": "A map of sub-server names to their status."
}
}
},
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
},
"rpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/protobufAny"
}
}
}
}
}
}