add description information to params for processors

internal/processor/db-query.go

@@ -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

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"expression": {
-					Title: "Expression",
+					Title:       "Expression",
-					Type:  "string",
+					Description: "Expr expression to evaluate, must return a boolean",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"expression"},

internal/processor/filter-rate.go

@@ -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

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"pattern": {
-					Title: "Pattern",
+					Title:       "Pattern",
-					Type:  "string",
+					Description: "regex pattern to match against",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"pattern"},

internal/processor/float-parse.go

@@ -20,10 +20,11 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"bitSize": {
-					Title:   "Bit Size",
+					Title:       "Bit Size",
-					Type:    "integer",
+					Description: "bit size of the resulting float",
-					Enum:    []any{32, 64},
+					Type:        "integer",
-					Default: json.RawMessage("64"),
+					Enum:        []any{32, 64},
+					Default:     json.RawMessage("64"),
 				},
 			},
 			AdditionalProperties: &jsonschema.Schema{Not: &jsonschema.Schema{}},

internal/processor/float-random.go

@@ -20,18 +20,21 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"bitSize": {
-					Title:   "Bit Size",
+					Title:       "Bit Size",
-					Type:    "integer",
+					Description: "bit size of the resulting float",
-					Enum:    []any{32, 64},
+					Type:        "integer",
-					Default: json.RawMessage("32"),
+					Enum:        []any{32, 64},
+					Default:     json.RawMessage("32"),
 				},
 				"min": {
-					Title: "Minimum",
+					Title:       "Minimum",
-					Type:  "number",
+					Description: "inclusive minimum value of the random float",
+					Type:        "number",
 				},
 				"max": {
-					Title: "Maximum",
+					Title:       "Maximum",
-					Type:  "number",
+					Description: "exclusive maximum value of the random float",
+					Type:        "number",
 				},
 			},
 			Required:             []string{"min", "max"},

internal/processor/free-d-create.go

@@ -21,40 +21,49 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"id": {
-					Title: "Camera ID",
+					Title:       "Camera ID",
-					Type:  "string",
+					Description: "ID of the camera this FreeD position corresponds to",
+					Type:        "string",
 				},
 				"pan": {
-					Title: "Pan",
+					Title:       "Pan",
-					Type:  "string",
+					Description: "pan angle of the camera",
+					Type:        "string",
 				},
 				"tilt": {
-					Title: "Tilt",
+					Title:       "Tilt",
-					Type:  "string",
+					Description: "tilt angle of the camera",
+					Type:        "string",
 				},
 				"roll": {
-					Title: "Roll",
+					Title:       "Roll",
-					Type:  "string",
+					Description: "roll angle of the camera",
+					Type:        "string",
 				},
 				"posX": {
-					Title: "Position X",
+					Title:       "Position X",
-					Type:  "string",
+					Description: "X coordinate of the camera's position",
+					Type:        "string",
 				},
 				"posY": {
-					Title: "Position Y",
+					Title:       "Position Y",
-					Type:  "string",
+					Description: "Y coordinate of the camera's position",
+					Type:        "string",
 				},
 				"posZ": {
-					Title: "Position Z",
+					Title:       "Position Z",
-					Type:  "string",
+					Description: "Z coordinate of the camera's position",
+					Type:        "string",
 				},
 				"zoom": {
-					Title: "Zoom",
+					Title:       "Zoom",
-					Type:  "string",
+					Description: "zoom level of the camera",
+					Type:        "string",
 				},
 				"focus": {
-					Title: "Focus",
+					Title:       "Focus",
-					Type:  "string",
+					Description: "focus level of the camera",
+					Type:        "string",
 				},
 			},
 			Required: []string{

internal/processor/http-request-do.go

@@ -22,13 +22,15 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"method": {
-					Title: "HTTP Method",
+					Title:       "HTTP Method",
-					Type:  "string",
+					Description: "method to use for the HTTP request",
-					Enum:  []any{"GET", "POST", "PUT", "PATCH", "DELETE"},
+					Type:        "string",
+					Enum:        []any{"GET", "POST", "PUT", "PATCH", "DELETE"},
 				},
 				"url": {
-					Title: "URL",
+					Title:       "URL",
-					Type:  "string",
+					Description: "URL to send the HTTP request to",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"method", "url"},

internal/processor/http-response-create.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"status": {
-					Title: "Status Code",
+					Title:       "Status Code",
-					Type:  "integer",
+					Description: "status code to set on the response",
+					Type:        "integer",
 				},
 				"bodyTemplate": {
-					Title: "Body Template",
+					Title:       "Body Template",
-					Type:  "string",
+					Description: "template for the response body",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"status", "bodyTemplate"},

internal/processor/int-parse.go

@@ -20,16 +20,18 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"base": {
-					Title:   "Base",
+					Title:       "Base",
-					Type:    "integer",
+					Description: "numerical base to use for parsing the integer",
-					Enum:    []any{0, 2, 8, 10, 16},
+					Type:        "integer",
-					Default: json.RawMessage("10"),
+					Enum:        []any{0, 2, 8, 10, 16},
+					Default:     json.RawMessage("10"),
 				},
 				"bitSize": {
-					Title:   "Bit Size",
+					Title:       "Bit Size",
-					Type:    "integer",
+					Description: "bit size of the resulting integer",
-					Enum:    []any{0, 8, 16, 32, 64},
+					Type:        "integer",
-					Default: json.RawMessage("64"),
+					Enum:        []any{0, 8, 16, 32, 64},
+					Default:     json.RawMessage("64"),
 				},
 			},
 			AdditionalProperties: &jsonschema.Schema{Not: &jsonschema.Schema{}},

internal/processor/int-random.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"min": {
-					Title: "Minimum",
+					Title:       "Minimum",
-					Type:  "integer",
+					Description: "inclusive minimum value of the random integer",
+					Type:        "integer",
 				},
 				"max": {
-					Title: "Maximum",
+					Title:       "Maximum",
-					Type:  "integer",
+					Description: "inclusive maximum value of the random integer",
+					Type:        "integer",
 				},
 			},
 			Required:             []string{"min", "max"},

internal/processor/int-scale.go

@@ -18,20 +18,24 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"inMin": {
-					Title: "Input Minimum",
+					Title:       "Input Minimum",
-					Type:  "integer",
+					Description: "minimum value of the input integer",
+					Type:        "integer",
 				},
 				"inMax": {
-					Title: "Input Maximum",
+					Title:       "Input Maximum",
-					Type:  "integer",
+					Description: "maximum value of the input integer",
+					Type:        "integer",
 				},
 				"outMin": {
-					Title: "Output Minimum",
+					Title:       "Output Minimum",
-					Type:  "integer",
+					Description: "minimum value of the output integer",
+					Type:        "integer",
 				},
 				"outMax": {
-					Title: "Output Maximum",
+					Title:       "Output Maximum",
-					Type:  "integer",
+					Description: "maximum value of the output integer",
+					Type:        "integer",
 				},
 			},
 			Required:             []string{"inMin", "inMax", "outMin", "outMax"},

internal/processor/kv-get.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"module": {
-					Title: "Module ID",
+					Title:       "Module ID",
-					Type:  "string",
+					Description: "ID of the key-value module to get the value from",
+					Type:        "string",
 				},
 				"key": {
-					Title: "Key",
+					Title:       "Key",
-					Type:  "string",
+					Description: "key to retrieve from the key-value module",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"module", "key"},

internal/processor/kv-set.go

@@ -19,12 +19,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"module": {
-					Title: "Module ID",
+					Title:       "Module ID",
-					Type:  "string",
+					Description: "ID of the key-value module to set the value in",
+					Type:        "string",
 				},
 				"key": {
-					Title: "Key",
+					Title:       "Key",
-					Type:  "string",
+					Description: "key to set in the key-value module",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"module", "key"},

internal/processor/midi-control_change-create.go

@@ -23,16 +23,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the control change message",
+					Type:        "string",
 				},
 				"control": {
-					Title: "Control",
+					Title:       "Control",
-					Type:  "string",
+					Description: "control number for the control change message",
+					Type:        "string",
 				},
 				"value": {
-					Title: "Value",
+					Title:       "Value",
-					Type:  "string",
+					Description: "value for the control change message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"channel", "control", "value"},

internal/processor/midi-note_off-create.go

@@ -23,16 +23,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the note off message",
+					Type:        "string",
 				},
 				"note": {
-					Title: "Note",
+					Title:       "Note",
-					Type:  "string",
+					Description: "note number for the note off message",
+					Type:        "string",
 				},
 				"velocity": {
-					Title: "Velocity",
+					Title:       "Velocity",
-					Type:  "string",
+					Description: "velocity for the note off message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"channel", "note", "velocity"},

internal/processor/midi-note_on-create.go

@@ -23,16 +23,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the note on message",
+					Type:        "string",
 				},
 				"note": {
-					Title: "Note",
+					Title:       "Note",
-					Type:  "string",
+					Description: "note number for the note on message",
+					Type:        "string",
 				},
 				"velocity": {
-					Title: "Velocity",
+					Title:       "Velocity",
-					Type:  "string",
+					Description: "velocity for the note on message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"channel", "note", "velocity"},

internal/processor/midi-program_change-create.go

@@ -23,12 +23,14 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"channel": {
-					Title: "Channel",
+					Title:       "Channel",
-					Type:  "string",
+					Description: "channel number for the program change message",
+					Type:        "string",
 				},
 				"program": {
-					Title: "Program",
+					Title:       "Program",
-					Type:  "string",
+					Description: "program number for the program change message",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"type", "channel", "program"},

internal/processor/module-output.go

@@ -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

@@ -23,19 +23,22 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"address": {
-					Title: "Address",
+					Title:       "Address",
-					Type:  "string",
+					Description: "OSC address for the message",
+					Type:        "string",
 				},
 				"args": {
-					Title: "Arguments",
+					Title:       "Arguments",
-					Type:  "array",
+					Description: "Arguments for the OSC message",
+					Type:        "array",
 					Items: &jsonschema.Schema{
 						Type: "string",
 					},
 				},
 				"types": {
-					Title: "Argument Types",
+					Title:       "Argument Types",
-					Type:  "string",
+					Description: "string of OSC types corresponding to the arguments",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"address"},

internal/processor/pubsub-publish.go

@@ -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

@@ -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

@@ -25,8 +25,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"expression": {
-					Title: "Expression",
+					Title:       "Expression",
-					Type:  "string",
+					Description: "Expr expression to evaluate",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"expression"},

internal/processor/script-js.go

@@ -18,8 +18,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"program": {
-					Title: "Program",
+					Title:       "Program",
-					Type:  "string",
+					Description: "JavaScript program to run",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"program"},

internal/processor/script-wasm.go

@@ -20,18 +20,21 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"path": {
-					Title: "Path",
+					Title:       "Path",
-					Type:  "string",
+					Description: "path to the WASM plugin to load",
+					Type:        "string",
 				},
 				"function": {
-					Title:   "Function",
+					Title:       "Function",
-					Type:    "string",
+					Description: "exported function to call on the WASM plugin",
-					Default: json.RawMessage(`"process"`),
+					Type:        "string",
+					Default:     json.RawMessage(`"process"`),
 				},
 				"enableWasi": {
-					Title:   "Enable WASI",
+					Title:       "Enable WASI",
-					Type:    "boolean",
+					Description: "whether to enable WASI when running the WASM plugin",
-					Default: json.RawMessage("false"),
+					Type:        "boolean",
+					Default:     json.RawMessage("false"),
 				},
 			},
 			Required:             []string{"path"},

internal/processor/sip-response-audio-create.go

@@ -19,15 +19,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"preWait": {
-					Title: "Pre Wait (ms)",
+					Title:       "Pre Wait (ms)",
-					Type:  "integer",
+					Description: "number of milliseconds to wait before playing the audio",
-				},
+					Type:        "integer",
-				"postWait": {
-					Title: "Post Wait (ms)",
-					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

@@ -21,15 +21,19 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"preWait": {
-					Title: "Pre Wait (ms)",
+					Title:       "Pre Wait (ms)",
-					Type:  "integer",
+					Description: "number of milliseconds to wait before sending the DTMF tones",
-				},
+					Type:        "integer",
-				"postWait": {
-					Title: "Post Wait (ms)",
-					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

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"template": {
-					Title: "Template",
+					Title:       "Template",
-					Type:  "string",
+					Description: "template to evaluate",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"template"},

internal/processor/string-split.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"separator": {
-					Title: "Separator",
+					Title:       "Separator",
-					Type:  "string",
+					Description: "separator to split the string on",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"separator"},

internal/processor/struct-field-get.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"name": {
-					Title: "Field Name",
+					Title:       "Field Name",
-					Type:  "string",
+					Description: "name of the struct field to extract",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"name"},

internal/processor/struct-method-get.go

@@ -19,8 +19,9 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"name": {
-					Title: "Method Name",
+					Title:       "Method Name",
-					Type:  "string",
+					Description: "name of the struct method to extract and call (with no arguments)",
+					Type:        "string",
 				},
 			},
 			Required:             []string{"name"},

internal/processor/time-sleep.go

@@ -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"},