add description information to params for modules

This commit is contained in:
Joel Wetzell
2026-06-01 17:39:00 -05:00
parent 81ae00c943
commit 5d1e6622cb
19 changed files with 172 additions and 128 deletions
+13 -10
View File
@@ -26,20 +26,23 @@ func init() {
Type: "object",
Properties: map[string]*jsonschema.Schema{
"ip": {
Title: "IP",
Type: "string",
Default: json.RawMessage(`"0.0.0.0"`),
Title: "IP",
Description: "the IP address to bind the TCP server to",
Type: "string",
Default: json.RawMessage(`"0.0.0.0"`),
},
"port": {
Title: "Port",
Type: "integer",
Minimum: jsonschema.Ptr[float64](1024),
Maximum: jsonschema.Ptr[float64](65535),
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",
Type: "string",
Enum: []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
Title: "Framing Method",
Description: "the method used to frame messages over the TCP connection",
Type: "string",
Enum: []any{"LF", "CR", "CRLF", "SLIP", "RAW"},
},
},
Required: []string{"port", "framing"},