Valetudo/backend/lib/webserver/capabilityRouters/doc/StatisticsCapabilityRouter....

116 lines
2.8 KiB
JSON

{
"/api/v2/robot/capabilities/TotalStatisticsCapability": {
"get": {
"tags": [
"TotalStatisticsCapability"
],
"summary": "Get total statistics",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValetudoDataPoint"
}
}
}
}
}
}
}
},
"/api/v2/robot/capabilities/TotalStatisticsCapability/properties": {
"get": {
"tags": [
"TotalStatisticsCapability"
],
"summary": "Get various capability-related properties",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"availableStatistics": {
"type": "array",
"items": {
"type": "string",
"enum": [
"count",
"time",
"area"
]
}
}
}
}
}
}
}
}
}
},
"/api/v2/robot/capabilities/CurrentStatisticsCapability": {
"get": {
"tags": [
"CurrentStatisticsCapability"
],
"summary": "Get statistics about the current (or last) task",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValetudoDataPoint"
}
}
}
}
}
}
}
},
"/api/v2/robot/capabilities/CurrentStatisticsCapability/properties": {
"get": {
"tags": [
"CurrentStatisticsCapability"
],
"summary": "Get various capability-related properties",
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"availableStatistics": {
"type": "array",
"items": {
"type": "string",
"enum": [
"count",
"time",
"area"
]
}
}
}
}
}
}
}
}
}
}
}