add title and descriptions for params schemas

This commit is contained in:
Joel Wetzell
2026-03-06 18:59:27 -06:00
parent cd4c3f59f2
commit 05e68e90af
2 changed files with 96 additions and 1 deletions

View File

@@ -36,6 +36,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535 "maximum": 65535
@@ -63,6 +64,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"duration": { "duration": {
"title": "Duration",
"type": "integer" "type": "integer"
} }
}, },
@@ -88,6 +90,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"duration": { "duration": {
"title": "Duration",
"type": "integer" "type": "integer"
} }
}, },
@@ -113,6 +116,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"port": { "port": {
"title": "Port",
"type": "string" "type": "string"
} }
}, },
@@ -138,6 +142,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"port": { "port": {
"title": "Port",
"type": "string" "type": "string"
} }
}, },
@@ -163,12 +168,15 @@
"type": "object", "type": "object",
"properties": { "properties": {
"broker": { "broker": {
"title": "Broker URL",
"type": "string" "type": "string"
}, },
"topic": { "topic": {
"title": "Topic",
"type": "string" "type": "string"
}, },
"clientId": { "clientId": {
"title": "Client ID",
"type": "string" "type": "string"
} }
}, },
@@ -194,9 +202,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"url": { "url": {
"title": "NATS Server URL",
"type": "string" "type": "string"
}, },
"subject": { "subject": {
"title": "Subject",
"type": "string" "type": "string"
} }
}, },
@@ -222,10 +232,12 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ip": { "ip": {
"title": "IP",
"type": "string", "type": "string",
"default": "0.0.0.0" "default": "0.0.0.0"
}, },
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535, "maximum": 65535,
@@ -269,9 +281,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"port": { "port": {
"title": "Port",
"type": "string" "type": "string"
}, },
"baudRate": { "baudRate": {
"title": "Baud Rate",
"type": "integer" "type": "integer"
} }
}, },
@@ -297,21 +311,25 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ip": { "ip": {
"title": "IP",
"type": "string", "type": "string",
"default": "0.0.0.0" "default": "0.0.0.0"
}, },
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535, "maximum": 65535,
"default": 5060 "default": 5060
}, },
"transport": { "transport": {
"title": "Transport",
"type": "string", "type": "string",
"enum": ["udp", "tcp", "ws", "udp4", "tcp4"], "enum": ["udp", "tcp", "ws", "udp4", "tcp4"],
"default": "udp" "default": "udp"
}, },
"userAgent": { "userAgent": {
"title": "User Agent",
"type": "string", "type": "string",
"default": "showbridge" "default": "showbridge"
} }
@@ -338,25 +356,30 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ip": { "ip": {
"title": "IP",
"type": "string", "type": "string",
"default": "0.0.0.0" "default": "0.0.0.0"
}, },
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535, "maximum": 65535,
"default": 5060 "default": 5060
}, },
"transport": { "transport": {
"title": "Transport",
"type": "string", "type": "string",
"enum": ["udp", "tcp", "ws", "udp4", "tcp4"], "enum": ["udp", "tcp", "ws", "udp4", "tcp4"],
"default": "udp" "default": "udp"
}, },
"userAgent": { "userAgent": {
"title": "User Agent",
"type": "string", "type": "string",
"default": "showbridge" "default": "showbridge"
}, },
"separator": { "separator": {
"title": "DTMF Separator",
"type": "string", "type": "string",
"minLength": 1, "minLength": 1,
"maxLength": 1 "maxLength": 1
@@ -384,14 +407,17 @@
"type": "object", "type": "object",
"properties": { "properties": {
"host": { "host": {
"title": "Host",
"type": "string" "type": "string"
}, },
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535 "maximum": 65535
}, },
"framing": { "framing": {
"title": "Framing Method",
"type": "string", "type": "string",
"enum": ["LF", "CR", "CRLF", "SLIP", "RAW"] "enum": ["LF", "CR", "CRLF", "SLIP", "RAW"]
} }
@@ -422,11 +448,13 @@
"default": "0.0.0.0" "default": "0.0.0.0"
}, },
"port": { "port": {
"title" : "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535 "maximum": 65535
}, },
"framing": { "framing": {
"title": "Framing Method",
"type": "string", "type": "string",
"enum": ["LF", "CR", "CRLF", "SLIP", "RAW"] "enum": ["LF", "CR", "CRLF", "SLIP", "RAW"]
} }
@@ -453,9 +481,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"host": { "host": {
"title": "Host",
"type": "string" "type": "string"
}, },
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535 "maximum": 65535
@@ -483,9 +513,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ip": { "ip": {
"title": "IP",
"type": "string" "type": "string"
}, },
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535 "maximum": 65535
@@ -513,10 +545,12 @@
"type": "object", "type": "object",
"properties": { "properties": {
"ip": { "ip": {
"title": "IP",
"type": "string", "type": "string",
"default": "0.0.0.0" "default": "0.0.0.0"
}, },
"port": { "port": {
"title": "Port",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 65535 "maximum": 65535

View File

@@ -42,6 +42,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"opCode": { "opCode": {
"title": "Op Code",
"type": "integer" "type": "integer"
} }
}, },
@@ -76,6 +77,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"expression": { "expression": {
"title": "Expression",
"type": "string" "type": "string"
} }
}, },
@@ -98,6 +100,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"bitSize": { "bitSize": {
"title": "Bit Size",
"type": "integer", "type": "integer",
"enum": [32, 64], "enum": [32, 64],
"default": 64 "default": 64
@@ -121,30 +124,39 @@
"type": "object", "type": "object",
"properties": { "properties": {
"id": { "id": {
"title": "Camera ID",
"type": "string" "type": "string"
}, },
"pan": { "pan": {
"title": "Pan",
"type": "string" "type": "string"
}, },
"tilt": { "tilt": {
"title": "Tilt",
"type": "string" "type": "string"
}, },
"roll": { "roll": {
"title": "Roll",
"type": "string" "type": "string"
}, },
"posX": { "posX": {
"title": "Position X",
"type": "string" "type": "string"
}, },
"posY": { "posY": {
"title": "Position Y",
"type": "string" "type": "string"
}, },
"posZ": { "posZ": {
"title": "Position Z",
"type": "string" "type": "string"
}, },
"zoom": { "zoom": {
"title": "Zoom",
"type": "string" "type": "string"
}, },
"focus": { "focus": {
"title": "Focus",
"type": "string" "type": "string"
} }
}, },
@@ -201,10 +213,12 @@
"type": "object", "type": "object",
"properties": { "properties": {
"method": { "method": {
"title": "HTTP Method",
"type": "string", "type": "string",
"enum": ["GET", "POST"] "enum": ["GET", "POST"]
}, },
"url": { "url": {
"title": "URL",
"type": "string" "type": "string"
} }
}, },
@@ -227,9 +241,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"path": { "path": {
"title": "Path",
"type": "string" "type": "string"
}, },
"method": { "method": {
"title": "HTTP Method",
"type": "string", "type": "string",
"enum": ["GET", "POST"] "enum": ["GET", "POST"]
} }
@@ -253,9 +269,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"status": { "status": {
"title": "Status Code",
"type": "integer" "type": "integer"
}, },
"body": { "body": {
"title": "Body",
"type": "string" "type": "string"
} }
}, },
@@ -278,11 +296,13 @@
"type": "object", "type": "object",
"properties": { "properties": {
"base": { "base": {
"title": "Base",
"type": "integer", "type": "integer",
"enum": [0,2, 8, 10, 16], "enum": [0,2, 8, 10, 16],
"default": 10 "default": 10
}, },
"bitSize": { "bitSize": {
"title": "Bit Size",
"type": "integer", "type": "integer",
"enum": [0, 8, 16, 32, 64], "enum": [0, 8, 16, 32, 64],
"default": 64 "default": 64
@@ -306,9 +326,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"min": { "min": {
"title": "Minimum",
"type": "integer" "type": "integer"
}, },
"max": { "max": {
"title": "Maximum",
"type": "integer" "type": "integer"
} }
}, },
@@ -358,16 +380,20 @@
"type": "object", "type": "object",
"properties": { "properties": {
"type": { "type": {
"title": "MIDI Message Type",
"type": "string", "type": "string",
"enum": ["NoteOn", "noteon", "note_on"] "enum": ["NoteOn", "noteon", "note_on"]
}, },
"channel": { "channel": {
"title": "Channel",
"type": "string" "type": "string"
}, },
"note": { "note": {
"title": "Note",
"type": "string" "type": "string"
}, },
"velocity": { "velocity": {
"title": "Velocity",
"type": "string" "type": "string"
} }
}, },
@@ -378,16 +404,20 @@
"type": "object", "type": "object",
"properties": { "properties": {
"type": { "type": {
"title": "MIDI Message Type",
"type": "string", "type": "string",
"enum": ["NoteOff", "noteoff", "note_off"] "enum": ["NoteOff", "noteoff", "note_off"]
}, },
"channel": { "channel": {
"title": "Channel",
"type": "string" "type": "string"
}, },
"note": { "note": {
"title": "Note",
"type": "string" "type": "string"
}, },
"velocity": { "velocity": {
"title": "Velocity",
"type": "string" "type": "string"
} }
}, },
@@ -398,16 +428,20 @@
"type": "object", "type": "object",
"properties": { "properties": {
"type": { "type": {
"title": "MIDI Message Type",
"type": "string", "type": "string",
"enum": ["ControlChange", "controlchange", "control_change"] "enum": ["ControlChange", "controlchange", "control_change"]
}, },
"channel": { "channel": {
"title": "Channel",
"type": "string" "type": "string"
}, },
"control": { "control": {
"title": "Control",
"type": "string" "type": "string"
}, },
"value": { "value": {
"title": "Value",
"type": "string" "type": "string"
} }
}, },
@@ -418,13 +452,16 @@
"type": "object", "type": "object",
"properties": { "properties": {
"type": { "type": {
"title": "MIDI Message Type",
"type": "string", "type": "string",
"enum": ["ProgramChange", "programchange", "program_change"] "enum": ["ProgramChange", "programchange", "program_change"]
}, },
"channel": { "channel": {
"title": "Channel",
"type": "string" "type": "string"
}, },
"program": { "program": {
"title": "Program",
"type": "string" "type": "string"
} }
}, },
@@ -473,6 +510,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"type": { "type": {
"title": "MIDI Message Type",
"type": "string", "type": "string",
"enum": ["NoteOn", "NoteOff", "ControlChange", "ProgramChange"] "enum": ["NoteOn", "NoteOff", "ControlChange", "ProgramChange"]
} }
@@ -508,15 +546,19 @@
"type": "object", "type": "object",
"properties": { "properties": {
"topic": { "topic": {
"title": "Topic",
"type": "string" "type": "string"
}, },
"qos": { "qos": {
"title": "QoS",
"type": "number" "type": "number"
}, },
"retained": { "retained": {
"title": "Retained",
"type": "boolean" "type": "boolean"
}, },
"payload": { "payload": {
"title": "Payload",
"type": "string" "type": "string"
} }
}, },
@@ -551,9 +593,11 @@
"type": "object", "type": "object",
"properties": { "properties": {
"subject": { "subject": {
"title": "Subject",
"type": "string" "type": "string"
}, },
"payload": { "payload": {
"title": "Payload",
"type": "string" "type": "string"
} }
}, },
@@ -576,15 +620,18 @@
"type": "object", "type": "object",
"properties": { "properties": {
"address": { "address": {
"title": "Address",
"type": "string" "type": "string"
}, },
"args": { "args": {
"title": "Arguments",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"types": { "types": {
"title": "Argument Types",
"type": "string" "type": "string"
} }
}, },
@@ -631,6 +678,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"address": { "address": {
"title": "Address",
"type": "string" "type": "string"
} }
}, },
@@ -653,6 +701,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"module": { "module": {
"title": "Module ID",
"type": "string", "type": "string",
"description": "ID of module to send output to" "description": "ID of module to send output to"
} }
@@ -675,6 +724,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"expression": { "expression": {
"title": "Expression",
"type": "string" "type": "string"
} }
}, },
@@ -697,6 +747,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"program": { "program": {
"title": "Program",
"type": "string" "type": "string"
} }
}, },
@@ -719,13 +770,16 @@
"type": "object", "type": "object",
"properties": { "properties": {
"path": { "path": {
"title": "Path",
"type": "string" "type": "string"
}, },
"function": { "function": {
"title": "Function",
"type": "string", "type": "string",
"default": "process" "default": "process"
}, },
"enableWasi": { "enableWasi": {
"title": "Enable WASI",
"type": "boolean", "type": "boolean",
"default": false "default": false
} }
@@ -749,6 +803,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"template": { "template": {
"title": "Template",
"type": "string" "type": "string"
} }
}, },
@@ -794,6 +849,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"pattern": { "pattern": {
"title": "Pattern",
"type": "string" "type": "string"
} }
}, },
@@ -816,6 +872,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"separator": { "separator": {
"title": "Separator",
"type": "string" "type": "string"
} }
}, },
@@ -837,6 +894,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"name": { "name": {
"title": "Field Name",
"type": "string" "type": "string"
} }
}, },
@@ -858,6 +916,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"name": { "name": {
"title": "Method Name",
"type": "string" "type": "string"
} }
}, },
@@ -879,7 +938,9 @@
"type": "object", "type": "object",
"properties": { "properties": {
"duration": { "duration": {
"type": "integer" "title": "Duration",
"type": "integer",
"description": "Duration to sleep in milliseconds"
} }
}, },
"required": ["duration"] "required": ["duration"]