mirror of https://github.com/Hypfer/Valetudo.git
103 lines
2.7 KiB
JSON
103 lines
2.7 KiB
JSON
{
|
|
"/api/v2/robot/capabilities/VoicePackManagementCapability": {
|
|
"get": {
|
|
"tags": [
|
|
"VoicePackManagementCapability"
|
|
],
|
|
"summary": "Get current voice pack and operation status, if any",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Ok",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"currentLanguage": {
|
|
"type": "string"
|
|
},
|
|
"operationStatus": {
|
|
"$ref": "#/components/schemas/ValetudoVoicePackOperationStatus"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"VoicePackManagementCapability"
|
|
],
|
|
"summary": "Set voice pack",
|
|
"description": "**Note:** the actual parameters and the voice pack format are highly dependent on the specific robot model.",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"download"
|
|
]
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"type": "string"
|
|
},
|
|
"hash": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"custom":{
|
|
"description": "Install a custom voice pack",
|
|
"value": {
|
|
"action": "download",
|
|
"url": "http://host_or_ip/custom.tar.gz",
|
|
"language": "cu",
|
|
"hash": "md5md5md5md5md5md5md5md5md5md5md"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/200"
|
|
},
|
|
"400": {
|
|
"$ref": "#/components/responses/400"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v2/robot/capabilities/VoicePackManagementCapability/properties": {
|
|
"get": {
|
|
"tags": [
|
|
"VoicePackManagementCapability"
|
|
],
|
|
"summary": "Get various capability-related properties",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Ok",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|