@portpowered/reference-data 0.0.0-stage → 0.4.0

package/generated/resources/content-launcher/message-launch-content.json

@@ -0,0 +1,46 @@
+{
+  "type": "object",
+  "properties": {
+    "search": {
+      "type": "object",
+      "description": "Content search criteria",
+      "properties": {
+        "parameterList": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "description": "A content search parameter",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "VIDEO",
+                  "AUDIO",
+                  "IMAGE",
+                  "OTHER"
+                ]
+              },
+              "value": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "type",
+              "value"
+            ],
+            "additionalProperties": false,
+            "title": "ContentSearchParameter"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "title": "ContentSearch"
+    },
+    "autoPlay": {
+      "type": "boolean",
+      "description": "Whether to auto-play the content",
+      "default": true
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/content-launcher/message-launch-url.json

@@ -0,0 +1,40 @@
+{
+  "type": "object",
+  "properties": {
+    "contentUrl": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL of the content to launch"
+    },
+    "displayString": {
+      "type": "string",
+      "description": "Display string for the content"
+    },
+    "brandingInformation": {
+      "type": "object",
+      "description": "Content provider branding information",
+      "properties": {
+        "providerName": {
+          "type": "string",
+          "description": "Provider name"
+        },
+        "background": {
+          "type": "string",
+          "format": "uri",
+          "description": "Background image URL"
+        },
+        "logo": {
+          "type": "string",
+          "format": "uri",
+          "description": "Logo image URL"
+        }
+      },
+      "additionalProperties": false,
+      "title": "BrandingInformation"
+    }
+  },
+  "required": [
+    "contentUrl"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/control-route-groups-provider/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/control-route-groups-provider/message-create-group.json

@@ -0,0 +1,18 @@
+{
+  "description": "Request to delete a group based on its group ID. ",
+  "type": "object",
+  "properties": {
+    "pluginGroupRouteId": {
+      "type": "string",
+      "description": "The plugin group route ID to delete."
+    },
+    "memberRouteIds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "The IDs of the routes that should exist in the group."
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/control-route-groups-provider/message-delete-group.json

@@ -0,0 +1,11 @@
+{
+  "description": "Request to delete a group based on its group ID. ",
+  "type": "object",
+  "properties": {
+    "pluginGroupRouteId": {
+      "type": "string",
+      "description": "The plugin group route ID to delete."
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/control-routes-provider/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/control-routes-provider/message-acknowledged.json

@@ -0,0 +1,5 @@
+{
+  "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, but not necessarily that it did anything.  Consider this to happen on any infrared based device (TV remotes), where no ack is feasible.",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/resources/control-routes-provider/message-attribute-report.json

@@ -0,0 +1,63 @@
+{
+  "description": "Response to report attributes of a control route",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "A control route item with associated plugin route and attributes",
+        "properties": {
+          "associatedPluginRouteId": {
+            "type": "string"
+          },
+          "attributes": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "namespace": {
+                  "type": "string",
+                  "description": "The namespace of the attribute"
+                },
+                "name": {
+                  "type": "string",
+                  "description": "The name of the attribute"
+                },
+                "version": {
+                  "type": "string",
+                  "description": "The version of the attribute"
+                },
+                "value": {
+                  "type": "object",
+                  "description": "The value of the attribute"
+                },
+                "sampledAt": {
+                  "type": "string",
+                  "format": "date-time",
+                  "description": "Actual observation time in UTC; omit when unknown. Request time is not a sample time."
+                }
+              },
+              "required": [
+                "namespace",
+                "name",
+                "version",
+                "value"
+              ],
+              "title": "AttributeSchema"
+            }
+          }
+        },
+        "required": [
+          "associatedPluginRouteId",
+          "attributes"
+        ],
+        "title": "ControlRouteItem"
+      }
+    }
+  },
+  "required": [
+    "items"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/control-routes-provider/message-batch-message-dispatch.json

@@ -0,0 +1,24 @@
+{
+  "description": "Request to dispatch a batch of messages to a control route sent from port OS to the control routes provider",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "object",
+      "description": "A batch message dispatch item",
+      "properties": {
+        "message": {
+          "description": "The payload of the message to dispatch to the control route provider.",
+          "type": "object"
+        }
+      },
+      "required": [
+        "message"
+      ],
+      "title": "BatchMessageItem"
+    }
+  },
+  "required": [
+    "items"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/control-routes-provider/message-deferred-response.json

@@ -0,0 +1,5 @@
+{
+  "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, and that a confirmation of the result will be sent later on.  We generate this message when the device is expected to respond some time later on, and we need to wait for the result.  For the default behavior, we expect to wait up to a minute to handle low powered devices.",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/resources/control-routes-provider/message-error-dispatch.json

@@ -0,0 +1,30 @@
+{
+  "description": "Response to acknowledge a message was dispatched, it confirms that a message was dispatched, and that the result was not successful.",
+  "type": "object",
+  "properties": {
+    "error": {
+      "type": "object",
+      "description": "An error from a dispatch operation",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type of the error, an enum which denotes a specific type of error that belongs to a family of errors."
+        },
+        "family": {
+          "type": "string",
+          "description": "The family of the error, an enum which denotes a general set of issues similar to the http error set. Some examples are BAD_REQUEST, SYSTEM_ERROR, etc."
+        },
+        "code": {
+          "type": "string",
+          "description": "The code of the error, an opaque error code that can be given for debugging purposes."
+        },
+        "message": {
+          "type": "string",
+          "description": "The message of the error, a human readable message that describes the error."
+        }
+      },
+      "title": "DispatchError"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/control-routes-provider/message-report-attributes.json

@@ -0,0 +1,67 @@
+{
+  "description": "Request to report attributes of a control route sent from port OS to the control routes provider",
+  "type": "object",
+  "properties": {
+    "items": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "A control route report item with cookies and attributes",
+        "properties": {
+          "associatedPluginRouteId": {
+            "type": "string"
+          },
+          "cookies": {
+            "type": "object",
+            "additionalProperties": true
+          },
+          "attributes": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "namespace": {
+                  "type": "string",
+                  "description": "The namespace of the attribute"
+                },
+                "name": {
+                  "type": "string",
+                  "description": "The name of the attribute"
+                },
+                "version": {
+                  "type": "string",
+                  "description": "The version of the attribute"
+                },
+                "value": {
+                  "type": "object",
+                  "description": "The value of the attribute"
+                },
+                "sampledAt": {
+                  "type": "string",
+                  "format": "date-time",
+                  "description": "Actual observation time in UTC; omit when unknown. Request time is not a sample time."
+                }
+              },
+              "required": [
+                "namespace",
+                "name",
+                "version",
+                "value"
+              ],
+              "title": "AttributeSchema"
+            }
+          }
+        },
+        "required": [
+          "associatedPluginRouteId",
+          "attributes"
+        ],
+        "title": "ControlRouteReportItem"
+      }
+    }
+  },
+  "required": [
+    "items"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/control-routes-provider/message-successful-dispatch.json

@@ -0,0 +1,5 @@
+{
+  "description": "Response to acknowledge a message was successfully dispatched, it confirms that a message was dispatched, and that the result was successful.",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/resources/cooktop/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/cooktop/state-operational-state.json

@@ -0,0 +1,22 @@
+{
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "description": "Operational state of a device. RETURNING_TO_DOCK means a robot is driving back to its dock; DOCKED means it is on the dock and not charging.",
+      "enum": [
+        "STOPPED",
+        "RUNNING",
+        "PAUSED",
+        "ERROR",
+        "CHARGING",
+        "DOCKED",
+        "RETURNING_TO_DOCK"
+      ]
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/dishwasher/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/dishwasher/state-operational-state.json

@@ -0,0 +1,22 @@
+{
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "description": "Operational state of a device. RETURNING_TO_DOCK means a robot is driving back to its dock; DOCKED means it is on the dock and not charging.",
+      "enum": [
+        "STOPPED",
+        "RUNNING",
+        "PAUSED",
+        "ERROR",
+        "CHARGING",
+        "DOCKED",
+        "RETURNING_TO_DOCK"
+      ]
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/doorbell/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/doorbell/message-chime.json

@@ -0,0 +1,16 @@
+{
+  "description": "A distinct doorbell press. A chime does not imply a door was opened.",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "string",
+      "enum": [
+        "PRESSED"
+      ]
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/electrical-conductivity-sensor/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/electrical-conductivity-sensor/state-measured-value.json

@@ -0,0 +1,49 @@
+{
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "object",
+      "description": "A measurement value with optional null support",
+      "properties": {
+        "value": {
+          "type": "number",
+          "description": "The measured value"
+        },
+        "isNull": {
+          "type": "boolean",
+          "description": "True if the measurement is invalid/null",
+          "default": false
+        }
+      },
+      "required": [
+        "value",
+        "isNull"
+      ],
+      "additionalProperties": false,
+      "title": "MeasurementValue"
+    },
+    "unit": {
+      "type": "string",
+      "description": "Unit of measurement",
+      "enum": [
+        "LUX",
+        "PPM",
+        "PPB",
+        "PERCENT",
+        "PASCAL",
+        "LITERS_PER_MINUTE",
+        "PERCENT_VOLUME",
+        "PH",
+        "SIEMENS_PER_METER",
+        "METERS_PER_SECOND",
+        "DEGREES_CELSIUS",
+        "DEGREES_FAHRENHEIT"
+      ]
+    }
+  },
+  "required": [
+    "value",
+    "unit"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/embedding-generation/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/embedding-generation/message-embedding-uri.json

@@ -0,0 +1,21 @@
+{
+  "type": "object",
+  "required": [
+    "uri"
+  ],
+  "properties": {
+    "uri": {
+      "type": "string",
+      "description": "URL of the generated embedding resource"
+    },
+    "format": {
+      "type": "string",
+      "description": "Format of the embedding (e.g., safetensors, onnx)"
+    },
+    "mimeType": {
+      "type": "string",
+      "description": "MIME type of the embedding resource"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/embedding-generation/message-generate-embedding.json

@@ -0,0 +1,17 @@
+{
+  "type": "object",
+  "required": [
+    "audioUrl"
+  ],
+  "properties": {
+    "audioUrl": {
+      "type": "string",
+      "description": "URL or base64 data URI of the audio to generate an embedding from"
+    },
+    "referenceText": {
+      "type": "string",
+      "description": "Optional reference text for the audio content"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/endpoint-registry/configuration.json

@@ -0,0 +1 @@
+null

package/generated/resources/endpoint-registry/message-endpoint-updated.json

@@ -0,0 +1,33 @@
+{
+  "description": "Port OS emitted a durable endpoint metadata or enablement change. Delivery is best effort.",
+  "type": "object",
+  "properties": {
+    "endpointId": {
+      "type": "string",
+      "description": "Full Port OS endpoint identifier."
+    },
+    "name": {
+      "type": "string",
+      "description": "Current endpoint name."
+    },
+    "type": {
+      "type": "string",
+      "description": "Current ontological endpoint type."
+    },
+    "enablement": {
+      "type": "string",
+      "enum": [
+        "ENABLED",
+        "DISABLED"
+      ],
+      "description": "Whether Port OS permits messages to be sent to this endpoint."
+    }
+  },
+  "required": [
+    "endpointId",
+    "name",
+    "type",
+    "enablement"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/equalizer/configuration.json

@@ -0,0 +1,24 @@
+{
+  "type": "object",
+  "properties": {
+    "supportedBands": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "BASS",
+          "MIDRANGE",
+          "TREBLE"
+        ]
+      }
+    },
+    "supportedModes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": false,
+  "description": "Equalizers adjust audio bands and select an equalizer mode. Read the current bands and mode to keep an audio control in step with the device."
+}

package/generated/resources/equalizer/message-adjust-bands.json

@@ -0,0 +1,34 @@
+{
+  "type": "object",
+  "required": [
+    "bands"
+  ],
+  "properties": {
+    "bands": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "An equalizer frequency band adjustment delta",
+        "required": [
+          "name",
+          "valueDelta"
+        ],
+        "properties": {
+          "name": {
+            "type": "string",
+            "enum": [
+              "BASS",
+              "MIDRANGE",
+              "TREBLE"
+            ]
+          },
+          "valueDelta": {
+            "type": "integer"
+          }
+        },
+        "title": "EqualizerBandDelta"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/equalizer/message-set-bands.json

@@ -0,0 +1,34 @@
+{
+  "type": "object",
+  "required": [
+    "bands"
+  ],
+  "properties": {
+    "bands": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "An equalizer frequency band setting",
+        "required": [
+          "name",
+          "value"
+        ],
+        "properties": {
+          "name": {
+            "type": "string",
+            "enum": [
+              "BASS",
+              "MIDRANGE",
+              "TREBLE"
+            ]
+          },
+          "value": {
+            "type": "integer"
+          }
+        },
+        "title": "EqualizerBand"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/equalizer/message-set-mode.json

@@ -0,0 +1,12 @@
+{
+  "type": "object",
+  "required": [
+    "mode"
+  ],
+  "properties": {
+    "mode": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}