jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-09 10:26:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update error codes docs for websocket API (#873)

Browse Source
This commit is contained in:
Paulus Schoutsen 2021-04-05 05:02:16 -07:00 committed by GitHub
parent 84fd2e7143
commit 4e714d88c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/websocket.md
View File

@ -341,7 +341,7 @@ The server will respond with a result message containing the current registered
_Introduced in Home Assistant 0.69._ _Introduced in Home Assistant 0.69._
:::caution Depreciated :::caution Deprecated
This websocket command was depreciated in Home Assistant Core [0.107](https://www.home-assistant.io/blog/2020/03/18/release-107/) and will be removed in a future release. Until then it will result in a `WARNING` entry in the user's log. This websocket command was depreciated in Home Assistant Core [0.107](https://www.home-assistant.io/blog/2020/03/18/release-107/) and will be removed in a future release. Until then it will result in a `WARNING` entry in the user's log.
::: :::
@ -421,19 +421,13 @@ The server must send a pong back as quickly as possible, if the connection is st
If an error occurs, the `success` key in the `result` message will be set to `false`. It will contain an `error` key containing an object with two keys: `code` and `message`. If an error occurs, the `success` key in the `result` message will be set to `false`. It will contain an `error` key containing an object with two keys: `code` and `message`.
| Code | Description |
| ----- | ------------ |
| 1 | A non-increasing identifier has been supplied.
| 2 | Received message is not in expected format (voluptuous validation error).
| 3 | Requested item cannot be found
```json ```json
{ {
"id": 12, "id": 12,
"type":"result", "type":"result",
"success": false, "success": false,
"error": { "error": {
"code": 2, "code": "invalid_format",
"message": "Message incorrectly formatted: expected str for dictionary value @ data['event_type']. Got 100" "message": "Message incorrectly formatted: expected str for dictionary value @ data['event_type']. Got 100"
} }
} }