mirror of https://github.com/Hypfer/Valetudo.git
87 lines
2.2 KiB
JSON
87 lines
2.2 KiB
JSON
{
|
|
"/api/v2/robot/capabilities/BasicControlCapability": {
|
|
"put": {
|
|
"tags": [
|
|
"BasicControlCapability"
|
|
],
|
|
"summary": "Basic robot control",
|
|
"description": "Allowed actions:\n\n- `start`\n- `stop`\n- `pause`\n- `home`\n",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"action": {
|
|
"type": "string",
|
|
"description": "Robot action to perform",
|
|
"enum": [
|
|
"start",
|
|
"stop",
|
|
"pause",
|
|
"home"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"start": {
|
|
"description": "Start",
|
|
"value": {
|
|
"action": "start"
|
|
}
|
|
},
|
|
"stop": {
|
|
"description": "Stop",
|
|
"value": {
|
|
"action": "stop"
|
|
}
|
|
},
|
|
"pause": {
|
|
"description": "Pause",
|
|
"value": {
|
|
"action": "pause"
|
|
}
|
|
},
|
|
"home": {
|
|
"description": "Home",
|
|
"value": {
|
|
"action": "home"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/200"
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/400"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/robot/capabilities/BasicControlCapability/properties": {
|
|
"get": {
|
|
"tags": [
|
|
"BasicControlCapability"
|
|
],
|
|
"summary": "Get various capability-related properties",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Ok",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|