jwetzell/showbridge-go
1
0
Fork 0
mirror of https://github.com/jwetzell/showbridge-go.git synced 2026-08-17 20:23:58 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

Merge pull request #178 from jwetzell/processor-params-schema-descriptions

Browse Source 
add description information to params for processors
This commit is contained in:
Joel Wetzell
2026-06-01 17:56:39 -05:00
committed by GitHub
parent 56566cf666 73905e1274
commit b01bebea54
32 changed files with 204 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/processor/db-query.go
+2 -2
View File
@@ -22,13 +22,13 @@ func init() {
Properties: map[string]*jsonschema.Schema{
"module": {
Title: "Module ID",
Type: "string",
Description: "ID of the database module to query",
Type: "string",
},
"query": {
Title: "Query",
Type: "string",
Description: "SQL query to execute",
Type: "string",
},
},
Required: []string{"module", "query"},
internal/processor/filter-expr.go
+3 -2
View File
@@ -19,8 +19,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"expression": {
Title: "Expression",
Type: "string",
Title: "Expression",
Description: "Expr expression to evaluate, must return a boolean",
Type: "string",
},
},
Required: []string{"expression"},
internal/processor/filter-rate.go
+2 -2
View File
@@ -18,9 +18,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"rate": {
Type: "integer",
Title: "Rate",
Description: "The number of events to allow per second.",
Description: "number of events to allow per second",
Type: "integer",
},
},
Required: []string{"rate"},
internal/processor/filter-regex.go
+3 -2
View File
@@ -19,8 +19,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"pattern": {
Title: "Pattern",
Type: "string",
Title: "Pattern",
Description: "regex pattern to match against",
Type: "string",
},
},
Required: []string{"pattern"},
internal/processor/float-parse.go
+5 -4
View File
@@ -20,10 +20,11 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"bitSize": {
Title: "Bit Size",
Type: "integer",
Enum: []any{32, 64},
Default: json.RawMessage("64"),
Title: "Bit Size",
Description: "bit size of the resulting float",
Type: "integer",
Enum: []any{32, 64},
Default: json.RawMessage("64"),
},
},
AdditionalProperties: &jsonschema.Schema{Not: &jsonschema.Schema{}},
internal/processor/float-random.go
+11 -8
View File
@@ -20,18 +20,21 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"bitSize": {
Title: "Bit Size",
Type: "integer",
Enum: []any{32, 64},
Default: json.RawMessage("32"),
Title: "Bit Size",
Description: "bit size of the resulting float",
Type: "integer",
Enum: []any{32, 64},
Default: json.RawMessage("32"),
},
"min": {
Title: "Minimum",
Type: "number",
Title: "Minimum",
Description: "inclusive minimum value of the random float",
Type: "number",
},
"max": {
Title: "Maximum",
Type: "number",
Title: "Maximum",
Description: "exclusive maximum value of the random float",
Type: "number",
},
},
Required: []string{"min", "max"},
internal/processor/free-d-create.go
+27 -18
View File
@@ -21,40 +21,49 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"id": {
Title: "Camera ID",
Type: "string",
Title: "Camera ID",
Description: "ID of the camera this FreeD position corresponds to",
Type: "string",
},
"pan": {
Title: "Pan",
Type: "string",
Title: "Pan",
Description: "pan angle of the camera",
Type: "string",
},
"tilt": {
Title: "Tilt",
Type: "string",
Title: "Tilt",
Description: "tilt angle of the camera",
Type: "string",
},
"roll": {
Title: "Roll",
Type: "string",
Title: "Roll",
Description: "roll angle of the camera",
Type: "string",
},
"posX": {
Title: "Position X",
Type: "string",
Title: "Position X",
Description: "X coordinate of the camera's position",
Type: "string",
},
"posY": {
Title: "Position Y",
Type: "string",
Title: "Position Y",
Description: "Y coordinate of the camera's position",
Type: "string",
},
"posZ": {
Title: "Position Z",
Type: "string",
Title: "Position Z",
Description: "Z coordinate of the camera's position",
Type: "string",
},
"zoom": {
Title: "Zoom",
Type: "string",
Title: "Zoom",
Description: "zoom level of the camera",
Type: "string",
},
"focus": {
Title: "Focus",
Type: "string",
Title: "Focus",
Description: "focus level of the camera",
Type: "string",
},
},
Required: []string{
internal/processor/http-request-do.go
+7 -5
View File
@@ -22,13 +22,15 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"method": {
Title: "HTTP Method",
Type: "string",
Enum: []any{"GET", "POST", "PUT", "PATCH", "DELETE"},
Title: "HTTP Method",
Description: "method to use for the HTTP request",
Type: "string",
Enum: []any{"GET", "POST", "PUT", "PATCH", "DELETE"},
},
"url": {
Title: "URL",
Type: "string",
Title: "URL",
Description: "URL to send the HTTP request to",
Type: "string",
},
},
Required: []string{"method", "url"},
internal/processor/http-response-create.go
+6 -4
View File
@@ -19,12 +19,14 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"status": {
Title: "Status Code",
Type: "integer",
Title: "Status Code",
Description: "status code to set on the response",
Type: "integer",
},
"bodyTemplate": {
Title: "Body Template",
Type: "string",
Title: "Body Template",
Description: "template for the response body",
Type: "string",
},
},
Required: []string{"status", "bodyTemplate"},
internal/processor/int-parse.go
+10 -8
View File
@@ -20,16 +20,18 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"base": {
Title: "Base",
Type: "integer",
Enum: []any{0, 2, 8, 10, 16},
Default: json.RawMessage("10"),
Title: "Base",
Description: "numerical base to use for parsing the integer",
Type: "integer",
Enum: []any{0, 2, 8, 10, 16},
Default: json.RawMessage("10"),
},
"bitSize": {
Title: "Bit Size",
Type: "integer",
Enum: []any{0, 8, 16, 32, 64},
Default: json.RawMessage("64"),
Title: "Bit Size",
Description: "bit size of the resulting integer",
Type: "integer",
Enum: []any{0, 8, 16, 32, 64},
Default: json.RawMessage("64"),
},
},
AdditionalProperties: &jsonschema.Schema{Not: &jsonschema.Schema{}},
internal/processor/int-random.go
+6 -4
View File
@@ -19,12 +19,14 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"min": {
Title: "Minimum",
Type: "integer",
Title: "Minimum",
Description: "inclusive minimum value of the random integer",
Type: "integer",
},
"max": {
Title: "Maximum",
Type: "integer",
Title: "Maximum",
Description: "inclusive maximum value of the random integer",
Type: "integer",
},
},
Required: []string{"min", "max"},
internal/processor/int-scale.go
+12 -8
View File
@@ -18,20 +18,24 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"inMin": {
Title: "Input Minimum",
Type: "integer",
Title: "Input Minimum",
Description: "minimum value of the input integer",
Type: "integer",
},
"inMax": {
Title: "Input Maximum",
Type: "integer",
Title: "Input Maximum",
Description: "maximum value of the input integer",
Type: "integer",
},
"outMin": {
Title: "Output Minimum",
Type: "integer",
Title: "Output Minimum",
Description: "minimum value of the output integer",
Type: "integer",
},
"outMax": {
Title: "Output Maximum",
Type: "integer",
Title: "Output Maximum",
Description: "maximum value of the output integer",
Type: "integer",
},
},
Required: []string{"inMin", "inMax", "outMin", "outMax"},
internal/processor/kv-get.go
+6 -4
View File
@@ -19,12 +19,14 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"module": {
Title: "Module ID",
Type: "string",
Title: "Module ID",
Description: "ID of the key-value module to get the value from",
Type: "string",
},
"key": {
Title: "Key",
Type: "string",
Title: "Key",
Description: "key to retrieve from the key-value module",
Type: "string",
},
},
Required: []string{"module", "key"},
internal/processor/kv-set.go
+6 -4
View File
@@ -19,12 +19,14 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"module": {
Title: "Module ID",
Type: "string",
Title: "Module ID",
Description: "ID of the key-value module to set the value in",
Type: "string",
},
"key": {
Title: "Key",
Type: "string",
Title: "Key",
Description: "key to set in the key-value module",
Type: "string",
},
},
Required: []string{"module", "key"},
internal/processor/midi-control_change-create.go
+9 -6
View File
@@ -23,16 +23,19 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"channel": {
Title: "Channel",
Type: "string",
Title: "Channel",
Description: "channel number for the control change message",
Type: "string",
},
"control": {
Title: "Control",
Type: "string",
Title: "Control",
Description: "control number for the control change message",
Type: "string",
},
"value": {
Title: "Value",
Type: "string",
Title: "Value",
Description: "value for the control change message",
Type: "string",
},
},
Required: []string{"channel", "control", "value"},
internal/processor/midi-note_off-create.go
+9 -6
View File
@@ -23,16 +23,19 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"channel": {
Title: "Channel",
Type: "string",
Title: "Channel",
Description: "channel number for the note off message",
Type: "string",
},
"note": {
Title: "Note",
Type: "string",
Title: "Note",
Description: "note number for the note off message",
Type: "string",
},
"velocity": {
Title: "Velocity",
Type: "string",
Title: "Velocity",
Description: "velocity for the note off message",
Type: "string",
},
},
Required: []string{"channel", "note", "velocity"},
internal/processor/midi-note_on-create.go
+9 -6
View File
@@ -23,16 +23,19 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"channel": {
Title: "Channel",
Type: "string",
Title: "Channel",
Description: "channel number for the note on message",
Type: "string",
},
"note": {
Title: "Note",
Type: "string",
Title: "Note",
Description: "note number for the note on message",
Type: "string",
},
"velocity": {
Title: "Velocity",
Type: "string",
Title: "Velocity",
Description: "velocity for the note on message",
Type: "string",
},
},
Required: []string{"channel", "note", "velocity"},
internal/processor/midi-program_change-create.go
+6 -4
View File
@@ -23,12 +23,14 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"channel": {
Title: "Channel",
Type: "string",
Title: "Channel",
Description: "channel number for the program change message",
Type: "string",
},
"program": {
Title: "Program",
Type: "string",
Title: "Program",
Description: "program number for the program change message",
Type: "string",
},
},
Required: []string{"type", "channel", "program"},
internal/processor/module-output.go
+1 -1
View File
@@ -20,8 +20,8 @@ func init() {
Properties: map[string]*jsonschema.Schema{
"module": {
Title: "Module ID",
Type: "string",
Description: "ID of module to send output to",
Type: "string",
},
},
Required: []string{"module"},
internal/processor/osc-message-create.go
+9 -6
View File
@@ -23,19 +23,22 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"address": {
Title: "Address",
Type: "string",
Title: "Address",
Description: "OSC address for the message",
Type: "string",
},
"args": {
Title: "Arguments",
Type: "array",
Title: "Arguments",
Description: "Arguments for the OSC message",
Type: "array",
Items: &jsonschema.Schema{
Type: "string",
},
},
"types": {
Title: "Argument Types",
Type: "string",
Title: "Argument Types",
Description: "string of OSC types corresponding to the arguments",
Type: "string",
},
},
Required: []string{"address"},
internal/processor/pubsub-publish.go
+2 -2
View File
@@ -22,13 +22,13 @@ func init() {
Properties: map[string]*jsonschema.Schema{
"module": {
Title: "Module ID",
Type: "string",
Description: "ID of the module to publish to",
Type: "string",
},
"topic": {
Title: "Topic",
Description: "topic to publish to",
Type: "string",
Description: "Topic to publish to",
},
},
Required: []string{"module", "topic"},
internal/processor/router-input.go
+1 -1
View File
@@ -20,8 +20,8 @@ func init() {
Properties: map[string]*jsonschema.Schema{
"source": {
Title: "Source",
Type: "string",
Description: "source to report as to the router",
Type: "string",
},
},
Required: []string{"source"},
internal/processor/script-expr.go
+3 -2
View File
@@ -25,8 +25,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"expression": {
Title: "Expression",
Type: "string",
Title: "Expression",
Description: "Expr expression to evaluate",
Type: "string",
},
},
Required: []string{"expression"},
internal/processor/script-js.go
+3 -2
View File
@@ -18,8 +18,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"program": {
Title: "Program",
Type: "string",
Title: "Program",
Description: "JavaScript program to run",
Type: "string",
},
},
Required: []string{"program"},
internal/processor/script-wasm.go
+11 -8
View File
@@ -20,18 +20,21 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"path": {
Title: "Path",
Type: "string",
Title: "Path",
Description: "path to the WASM plugin to load",
Type: "string",
},
"function": {
Title: "Function",
Type: "string",
Default: json.RawMessage(`"process"`),
Title: "Function",
Description: "exported function to call on the WASM plugin",
Type: "string",
Default: json.RawMessage(`"process"`),
},
"enableWasi": {
Title: "Enable WASI",
Type: "boolean",
Default: json.RawMessage("false"),
Title: "Enable WASI",
Description: "whether to enable WASI when running the WASM plugin",
Type: "boolean",
Default: json.RawMessage("false"),
},
},
Required: []string{"path"},
internal/processor/sip-response-audio-create.go
+11 -7
View File
@@ -19,15 +19,19 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"preWait": {
Title: "Pre Wait (ms)",
Type: "integer",
},
"postWait": {
Title: "Post Wait (ms)",
Type: "integer",
Title: "Pre Wait (ms)",
Description: "number of milliseconds to wait before playing the audio",
Type: "integer",
},
"audioFile": {
Type: "string",
Title: "Audio File",
Description: "path to the audio file to play",
Type: "string",
},
"postWait": {
Title: "Post Wait (ms)",
Description: "number of milliseconds to wait after playing the audio",
Type: "integer",
},
},
Required: []string{"preWait", "postWait", "audioFile"},
internal/processor/sip-response-dtmf-create.go
+11 -7
View File
@@ -21,15 +21,19 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"preWait": {
Title: "Pre Wait (ms)",
Type: "integer",
},
"postWait": {
Title: "Post Wait (ms)",
Type: "integer",
Title: "Pre Wait (ms)",
Description: "number of milliseconds to wait before sending the DTMF tones",
Type: "integer",
},
"digits": {
Type: "string",
Title: "Digits",
Description: "DTMF digits to send",
Type: "string",
},
"postWait": {
Title: "Post Wait (ms)",
Description: "number of milliseconds to wait after sending the DTMF tones",
Type: "integer",
},
},
Required: []string{"preWait", "postWait", "digits"},
internal/processor/string-create.go
+3 -2
View File
@@ -19,8 +19,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"template": {
Title: "Template",
Type: "string",
Title: "Template",
Description: "template to evaluate",
Type: "string",
},
},
Required: []string{"template"},
internal/processor/string-split.go
+3 -2
View File
@@ -19,8 +19,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"separator": {
Title: "Separator",
Type: "string",
Title: "Separator",
Description: "separator to split the string on",
Type: "string",
},
},
Required: []string{"separator"},
internal/processor/struct-field-get.go
+3 -2
View File
@@ -19,8 +19,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"name": {
Title: "Field Name",
Type: "string",
Title: "Field Name",
Description: "name of the struct field to extract",
Type: "string",
},
},
Required: []string{"name"},
internal/processor/struct-method-get.go
+3 -2
View File
@@ -19,8 +19,9 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"name": {
Title: "Method Name",
Type: "string",
Title: "Method Name",
Description: "name of the struct method to extract and call (with no arguments)",
Type: "string",
},
},
Required: []string{"name"},
internal/processor/time-sleep.go
+1 -1
View File
@@ -19,8 +19,8 @@ func init() {
Properties: map[string]*jsonschema.Schema{
"duration": {
Title: "Duration",
Description: "time to sleep in milliseconds",
Type: "integer",
Description: "Duration to sleep in milliseconds",
},
},
Required: []string{"duration"},