add description information to params for modules

internal/module/db-sqlite.go

@@ -22,6 +22,8 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"dsn": {
+					Title:       "Data Source Name",
+					Description: "the data source name (DSN) for the SQLite database",
 					Type:        "string",
 					MinLength:   new(1),
 				},

internal/module/http-server.go

@@ -25,6 +25,7 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
 					Title:       "Port",
+					Description: "the port for the HTTP server to listen on",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1024),
 					Maximum:     jsonschema.Ptr[float64](65535),

internal/module/midi-input.go

@@ -23,6 +23,7 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
 					Title:       "Port",
+					Description: "the name of the MIDI port to listen to",
 					Type:        "string",
 				},
 			},

internal/module/midi-output.go

@@ -25,6 +25,7 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
 					Title:       "Port",
+					Description: "the name of the MIDI port to send messages to",
 					Type:        "string",
 				},
 			},

internal/module/mqtt-client.go

@@ -23,18 +23,22 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"broker": {
 					Title:       "Broker URL",
+					Description: "the URL of the MQTT broker to connect to",
 					Type:        "string",
 				},
 				"topic": {
 					Title:       "Topic",
+					Description: "an MQTT topic to subscribe to",
 					Type:        "string",
 				},
 				"clientId": {
 					Title:       "Client ID",
+					Description: "the client ID to use when connecting to the MQTT broker",
 					Type:        "string",
 				},
 				"qos": {
 					Title:       "QoS",
+					Description: "the QoS level to use when publishing messages",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](0),
 					Maximum:     jsonschema.Ptr[float64](2),
@@ -42,6 +46,7 @@ func init() {
 				},
 				"retained": {
 					Title:       "Retained",
+					Description: "whether to set the retained flag when publishing messages",
 					Type:        "boolean",
 					Default:     json.RawMessage(`false`),
 				},

internal/module/nats-client.go

@@ -21,10 +21,12 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"url": {
 					Title:       "NATS Server URL",
+					Description: "the URL of the NATS server to connect to",
 					Type:        "string",
 				},
 				"subject": {
 					Title:       "Subject",
+					Description: "the subject to subscribe to",
 					Type:        "string",
 				},
 			},

internal/module/nats-server.go

@@ -25,11 +25,13 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
 					Title:       "IP",
+					Description: "the IP address to bind the NATS server to",
 					Type:        "string",
 					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port for the NATS server to listen on",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1024),
 					Maximum:     jsonschema.Ptr[float64](65535),

internal/module/redis-client.go

@@ -21,9 +21,13 @@ func init() {
 			Type: "object",
 			Properties: map[string]*jsonschema.Schema{
 				"host": {
+					Title:       "Host",
+					Description: "the hostname or IP address of the Redis server to connect to",
 					Type:        "string",
 				},
 				"port": {
+					Title:       "Port",
+					Description: "the port to use when connecting to the Redis server",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1),
 					Maximum:     jsonschema.Ptr[float64](65535),

internal/module/serial-client.go

@@ -26,14 +26,17 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"port": {
 					Title:       "Port",
+					Description: "the name of the serial port to connect to",
 					Type:        "string",
 				},
 				"baudRate": {
 					Title:       "Baud Rate",
+					Description: "the baud rate to use when connecting to the serial port",
 					Type:        "integer",
 				},
 				"framing": {
 					Title:       "Framing Method",
+					Description: "the method to use for framing messages on the serial port",
 					Type:        "string",
 					Enum:        []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
 				},

internal/module/sip-call-server.go

@@ -30,11 +30,13 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
 					Title:       "IP",
+					Description: "the IP address to bind the SIP server to",
 					Type:        "string",
 					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port for the SIP server to listen on",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1024),
 					Maximum:     jsonschema.Ptr[float64](65535),
@@ -42,12 +44,14 @@ func init() {
 				},
 				"transport": {
 					Title:       "Transport",
+					Description: "the transport protocol to use for the SIP server",
 					Type:        "string",
 					Enum:        []any{"udp", "tcp", "ws", "udp4", "tcp4"},
 					Default:     json.RawMessage(`"udp"`),
 				},
 				"userAgent": {
 					Title:       "User Agent",
+					Description: "the user agent string to use",
 					Type:        "string",
 					Default:     json.RawMessage(`"showbridge"`),
 				},

internal/module/sip-dtmf-server.go

@@ -31,11 +31,13 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
 					Title:       "IP",
+					Description: "the IP address to bind the SIP server to",
 					Type:        "string",
 					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port for the SIP server to listen on",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1024),
 					Maximum:     jsonschema.Ptr[float64](65535),
@@ -43,17 +45,20 @@ func init() {
 				},
 				"transport": {
 					Title:       "Transport",
+					Description: "the transport protocol to use for the SIP server",
 					Type:        "string",
 					Enum:        []any{"udp", "tcp", "ws", "udp4", "tcp4"},
 					Default:     json.RawMessage(`"udp"`),
 				},
 				"userAgent": {
 					Title:       "User Agent",
+					Description: "the user agent string to use",
 					Type:        "string",
 					Default:     json.RawMessage(`"showbridge"`),
 				},
 				"separator": {
 					Title:       "DTMF Separator",
+					Description: "the DTMF character to use as a separator between DTMF digit groups",
 					Type:        "string",
 					MinLength:   new(1),
 					MaxLength:   new(1),

internal/module/tcp-client.go

@@ -24,16 +24,19 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"host": {
 					Title:       "Host",
+					Description: "the hostname or IP address of the TCP server to connect to",
 					Type:        "string",
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port of the TCP server to connect to",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1),
 					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 				"framing": {
 					Title:       "Framing Method",
+					Description: "the method used to frame messages over the TCP connection",
 					Type:        "string",
 					Enum:        []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
 				},

internal/module/tcp-server.go

@@ -27,17 +27,20 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
 					Title:       "IP",
+					Description: "the IP address to bind the TCP server to",
 					Type:        "string",
 					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port for the TCP server to listen on",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1024),
 					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 				"framing": {
 					Title:       "Framing Method",
+					Description: "the method used to frame messages over the TCP connection",
 					Type:        "string",
 					Enum:        []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
 				},

internal/module/time-interval.go

@@ -20,8 +20,8 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"duration": {
 					Title:       "Duration",
+					Description: "time in milliseconds between emitted events",
 					Type:        "integer",
-					Description: "Interval duration in milliseconds",
 				},
 			},
 			Required:             []string{"duration"},

internal/module/time-timer.go

@@ -20,8 +20,8 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"duration": {
 					Title:       "Duration",
+					Description: "time in milliseconds before the timer fires",
 					Type:        "integer",
-					Description: "Interval duration in milliseconds",
 				},
 			},
 			Required:             []string{"duration"},

internal/module/udp-client.go

@@ -22,10 +22,12 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"host": {
 					Title:       "Host",
+					Description: "the hostname or IP address of the UDP server to connect to",
 					Type:        "string",
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port of the UDP server to connect to",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1),
 					Maximum:     jsonschema.Ptr[float64](65535),

internal/module/udp-multicast.go

@@ -23,10 +23,12 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
 					Title:       "IP",
+					Description: "the multicast address to listen on",
 					Type:        "string",
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port to listen on",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1024),
 					Maximum:     jsonschema.Ptr[float64](65535),

internal/module/udp-server.go

@@ -24,17 +24,20 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"ip": {
 					Title:       "IP",
+					Description: "the IP address to bind the UDP server to",
 					Type:        "string",
 					Default:     json.RawMessage(`"0.0.0.0"`),
 				},
 				"port": {
 					Title:       "Port",
+					Description: "the port for the UDP server to listen on",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1024),
 					Maximum:     jsonschema.Ptr[float64](65535),
 				},
 				"bufferSize": {
 					Title:       "Buffer Size",
+					Description: "the size of the buffer for incoming UDP messages",
 					Type:        "integer",
 					Minimum:     jsonschema.Ptr[float64](1),
 					Maximum:     jsonschema.Ptr[float64](65535),

internal/module/websocket-client.go

@@ -24,6 +24,7 @@ func init() {
 			Properties: map[string]*jsonschema.Schema{
 				"url": {
 					Title:       "URL",
+					Description: "the URL of the WebSocket server to connect",
 					Type:        "string",
 				},
 			},