diff options
| author | set <set> | 2020-08-28 15:04:14 +0200 |
|---|---|---|
| committer | set <set> | 2020-08-28 15:04:14 +0200 |
| commit | 088eb1be9aa86343450c297380294483dc0bc3d0 (patch) | |
| tree | bd5472b79233d7139818007a1cc1da5383fa474d | |
| parent | c5ea2cf0d741e7ced6bd32e4a013a21be3755394 (diff) | |
| download | n_core-088eb1be9aa86343450c297380294483dc0bc3d0.tar.gz n_core-088eb1be9aa86343450c297380294483dc0bc3d0.zip | |
removed 'Required?' from documentation as the server will always send all fields any way
| -rw-r--r-- | README.md | 38 |
1 files changed, 19 insertions, 19 deletions
@@ -8,11 +8,11 @@ Each message sent to the N core server must be valid JSON and have a `command` f The arguments field contains the remaining text just as was send to the bridge. All messages may optionally include an `session` field. When you authorize against N core or switch to a menu, you will be returned (see next section) a session id which you can then send with this field to follow up on the initial command. -| Field | Type | Required? | Description | -|-------|------|-----------|-------------| -| `command` | string | yes | The command N core should handle | -| `arguments` | string | no | The arguments to the command (i.e. all remaining text in the message | -| `session` | string | no | The session id, defaults to `null` | +| Field | Type | Description | +|-------|------|-------------| +| `command` | string | The command N core should handle | +| `arguments` | string | The arguments to the command (i.e. all remaining text in the message | +| `session` | string | The session id, defaults to `null` | ### answer The answer consists of an array of `reply` objects, an `success`-flag and a `session`-id provided by N core. @@ -20,27 +20,27 @@ The reply objects enable N core to request certain formatting from the bridges, The session id can be ignored by bridges, but this will opt the bridge out of more complex (context specific) commands. JSON object overview: -| Field | Type | Required? | Description | -|-------|------|-----------|-------------| -| `reply` | array of `reply`-objects | yes | The reply from N core | -| `success` | bool | yes | Whether the command was successful | -| `session` | string | yes | A session id, defaults to `null` | +| Field | Type | Description | +|-------|------|-------------| +| `reply` | array of `reply`-objects | The reply from N core | +| `success` | bool | Whether the command was successful | +| `session` | string | A session id, defaults to `null` | #### `reply` The `reply` object: -| Field | Type | Required? | Description | -|-------|------|-----------|-------------| -| `text` | string | yes | A part of the answer | -| `annotations` | yes | array of `annotation`-objects | The annotations to this answer part | +| Field | Type | Description | +|-------|------|-------------| +| `text` | string | A part of the answer | +| `annotations` | array of `annotation`-objects | The annotations to this answer part | #### `annotation` The `annotation` object: -| Field | Type | Required? | Description | -|-------|------|-----------|-------------| -| `type` | string | yes | A part of the answer | -| `extra` | array of `reply`-objects | no | Extra content specific to the annotation type | +| Field | Type | Description | +|-------|------|-------------| +| `type` | string | A part of the answer | +| `extra` | array of `reply`-objects | Extra content specific to the annotation type | The currently specified annotation types are enumerated below: @@ -64,4 +64,4 @@ The text should be printed as a command how did bridge will recognize it (e.g. p Extra content: the description of the command. ##### `link` -The text should be formatted as a link. Extra content: the alt text for the uri - the uri should be the text itself, so that clients ignoring this annotation still show the real uri.
\ No newline at end of file +The text should be formatted as a link. Extra content: the alt text for the uri - the uri should be the text itself, so that clients ignoring this annotation still show the real uri. |