backup/showbridge-go
1
0
Fork 0
mirror of https://github.com/jwetzell/showbridge-go.git synced 2026-04-27 13:25:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

add title and descriptions for params schemas

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

34
schema/modules.schema.json
View File

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

63
schema/processors.schema.json
View File

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