cadmium-im/cadmium-docs-legacy
1
0
Fork 0
mirror of https://github.com/cadmium-im/cadmium-docs-legacy.git synced 2024-11-09 20:21:03 +00:00
Code Issues Projects Releases Wiki Activity

Correct Protocol Errors extension - add ok variable

Browse Source
This commit is contained in:
ChronosX88 2019-12-16 17:14:18 +04:00
parent 70f490c72e
commit 4e0c4b1d11
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
2 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
protocol-spec/json-schema/BaseMessage.schema.json
View File

@ -62,6 +62,12 @@
"type": "object", "type": "object",
"title": "payload", "title": "payload",
"description": "Message payload (used to store extra information in message, list of permissible fields in the payload depends on \"type\" field)" "description": "Message payload (used to store extra information in message, list of permissible fields in the payload depends on \"type\" field)"
},
"ok": {
"$id": "#/properties/ok",
"type": "boolean",
"title": "ok",
"description": "Indicating whether request have an error"
} }
} }
} }

5
protocol-spec/protocol-errors.md
View File

@ -1,7 +1,7 @@
# Protocol Errors # Protocol Errors
## Introduction ## Introduction
Mechanism of error processing included into protocol. Mechanism of error processing included into protocol.
Adds into any type ID `:error` postfix. Adds into any response message `ok` variable. If `ok` is true - we have no errors, if `ok` is false - we have an error.
## Message type identifiers ## Message type identifiers
- `*:error` - `*:error`
@ -24,9 +24,10 @@ Adds into any type ID `:error` postfix.
```json ```json
{ {
"id": "abcd", "id": "abcd",
"type": "incorrectMessageType:error", "type": "incorrectMessageType",
"from": "cadmium.im", "from": "cadmium.im",
"to": "@juliet@cadmium.im", "to": "@juliet@cadmium.im",
"ok": false,
"payload": { "payload": {
"errCode": 0, "errCode": 0,
"errText": "Incorrect type of message (type isn't implemented in the server)", "errText": "Incorrect type of message (type isn't implemented in the server)",