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:
26
schema/c2s/mode.json
Normal file
26
schema/c2s/mode.json
Normal file
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://git.eeqj.de/sneak/chat/schema/c2s/mode.json",
|
||||
"title": "C2S Mode",
|
||||
"description": "Set channel or user mode flags.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"channel": {
|
||||
"type": "string",
|
||||
"description": "Target channel.",
|
||||
"pattern": "^#[a-zA-Z0-9_-]+$"
|
||||
},
|
||||
"mode": {
|
||||
"type": "string",
|
||||
"description": "Mode string (e.g. +o, -m, +v).",
|
||||
"pattern": "^[+-][a-zA-Z]+$",
|
||||
"examples": ["+o", "-m", "+v", "+i"]
|
||||
},
|
||||
"target": {
|
||||
"type": "string",
|
||||
"description": "Target nick for user modes (e.g. +o alice). Omit for channel modes."
|
||||
}
|
||||
},
|
||||
"required": ["channel", "mode"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
Reference in New Issue
Block a user