docs: add JSON Schema definitions for all message types (draft 2020-12)
C2S (7): send, join, part, nick, topic, mode, ping
S2C (12): message, dm, notice, join, part, quit, nick, topic, mode, system, error, pong
S2S (6): relay, link, unlink, sync, ping, pong
Each message type has its own schema file under schema/{c2s,s2c,s2s}/.
schema/README.md provides an index of all types with descriptions.
This commit is contained in:
32
schema/s2c/notice.json
Normal file
32
schema/s2c/notice.json
Normal file
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://git.eeqj.de/sneak/chat/schema/s2c/notice.json",
|
||||
"title": "S2C Notice",
|
||||
"description": "A server notice. May be targeted to a channel or user, or global.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"type": {
|
||||
"const": "notice"
|
||||
},
|
||||
"ts": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "Origin (server name or nick)."
|
||||
},
|
||||
"channel": {
|
||||
"type": "string",
|
||||
"description": "Target channel, if channel-scoped."
|
||||
},
|
||||
"content": {
|
||||
"type": "string",
|
||||
"description": "Notice text."
|
||||
}
|
||||
},
|
||||
"required": ["id", "type", "ts", "content"]
|
||||
}
|
||||
Reference in New Issue
Block a user