add description information to params for modules

internal/module/mqtt-client.go

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