@portpowered/reference-data 0.4.1 → 0.4.3

package/generated/public/docs/references/schemas/BaseSecret.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "required": [
+    "id",
+    "type"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "The unique identifier for the secret"
+    },
+    "type": {
+      "type": "string",
+      "description": "The secret type"
+    },
+    "ownerId": {
+      "type": "string",
+      "description": "The owner ID of the secret"
+    },
+    "owner": {
+      "$ref": "/docs/references/schemas/Principal.json"
+    }
+  }
+}

package/generated/public/docs/references/schemas/BatchItemError.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Error for one operation of an atomic batch, correlated by the operation's `requestId`. `status` is the HTTP status the operation would have returned on its own.\n",
+  "additionalProperties": false,
+  "required": [
+    "requestId",
+    "code",
+    "family",
+    "status",
+    "message"
+  ],
+  "properties": {
+    "requestId": {
+      "$ref": "/docs/references/schemas/BatchOperationRequestId.json"
+    },
+    "code": {
+      "$ref": "/docs/references/schemas/ErrorCode.json"
+    },
+    "family": {
+      "$ref": "/docs/references/schemas/ErrorFamily.json"
+    },
+    "status": {
+      "type": "integer",
+      "minimum": 400,
+      "maximum": 599,
+      "description": "HTTP-equivalent status code of the item failure."
+    },
+    "message": {
+      "type": "string",
+      "description": "Plain-language description of the failure and the suggested next action."
+    },
+    "resourceId": {
+      "type": "string",
+      "description": "The resource the failure applies to, when it is not the operation's primary target."
+    }
+  }
+}

package/generated/public/docs/references/schemas/BatchMessageItem.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "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"
+  ]
+}

package/generated/public/docs/references/schemas/BatchOperationRequestId.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "Client-chosen identifier for one operation in a batch request. It must be unique within the request and is echoed in the matching result or error so items are correlated by ID, never by position.\n",
+  "minLength": 1,
+  "maxLength": 64,
+  "example": "merge-kitchen"
+}

package/generated/public/docs/references/schemas/BatchResponseStatus.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "Outcome of an atomic batch. `COMMITTED` means every operation was applied (or, for a validate-only request, would be applied); `FAILED` means nothing was written and `errors` lists every failing operation.\n",
+  "enum": [
+    "COMMITTED",
+    "FAILED"
+  ],
+  "x-enum-varnames": [
+    "BatchResponseStatusCommitted",
+    "BatchResponseStatusFailed"
+  ]
+}

package/generated/public/docs/references/schemas/BatteryInterfaceBatteryAttribute.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/battery",
+  "x-name": "battery",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "level": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100
+    },
+    "health": {
+      "type": "string",
+      "description": "Reported battery condition.",
+      "x-enumDescriptions": {
+        "OK": "The battery is healthy.",
+        "LOW": "The battery is low.",
+        "CRITICAL": "The battery needs immediate charging or replacement."
+      },
+      "enum": [
+        "OK",
+        "LOW",
+        "CRITICAL"
+      ]
+    }
+  },
+  "required": [
+    "level"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/BatteryInterfaceConfiguration.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/battery",
+  "x-name": "battery",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "description": "Battery level and health reported by a connected device.",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/BrandingInformation.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "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
+}

package/generated/public/docs/references/schemas/BrightnessInterfaceBrightnessAttribute.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/brightness",
+  "x-name": "brightness",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "integer",
+      "description": "The brightness level of an endpoint",
+      "minimum": 0,
+      "maximum": 100
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/BrightnessInterfaceConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/brightness",
+  "x-name": "brightness",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/BrightnessInterfaceSetBrightnessMessage.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/brightness",
+  "x-name": "set-brightness",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "brightness": {
+      "type": "integer",
+      "description": "The brightness level to set",
+      "minimum": 0,
+      "maximum": 100
+    }
+  },
+  "required": [
+    "brightness"
+  ]
+}

package/generated/public/docs/references/schemas/CalendarEvent.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "A calendar event",
+  "properties": {
+    "eventId": {
+      "type": "string"
+    },
+    "title": {
+      "type": "string"
+    },
+    "location": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "allDay": {
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "eventId"
+  ]
+}

package/generated/public/docs/references/schemas/CalendarProviderCapabilityInterfaceConfiguration.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "/docs/references/schemas/configuration.json"
+}

package/generated/public/docs/references/schemas/CalendarProviderInterfaceListEventsMessage.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/calendar-provider",
+  "x-name": "list-events",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "description": "Request to list events from a calendar provider",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CalendarProviderInterfaceListEventsResponseMessage.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/calendar-provider",
+  "x-name": "list-events-response",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "description": "Response containing a list of events from a calendar provider",
+  "type": "object",
+  "properties": {
+    "events": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/CalendarEvent.json"
+      }
+    }
+  },
+  "required": [
+    "events"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CameraInterfaceConfiguration.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/camera",
+  "x-name": "camera",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "properties": {
+    "supportedStreamingProtocols": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "RTSP",
+          "HLS",
+          "DASH",
+          "WEBRTC",
+          "OTHER"
+        ]
+      },
+      "description": "Supported streaming protocols"
+    },
+    "supportsPTZ": {
+      "type": "boolean",
+      "description": "Whether the camera supports pan-tilt-zoom controls",
+      "default": false
+    },
+    "supportsMotionDetection": {
+      "type": "boolean",
+      "description": "Whether the camera supports motion detection",
+      "default": false
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CameraInterfaceGetEventImageMessage.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/camera",
+  "x-name": "get-event-image",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "eventId": {
+      "type": "string",
+      "description": "The ID of the camera event to retrieve the image for"
+    },
+    "eventTimestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The timestamp of the camera event (ISO 8601 format)"
+    }
+  },
+  "required": [
+    "eventId"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CameraInterfaceMotionDetectionEnabledAttribute.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/camera",
+  "x-name": "motion-detection-enabled",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "boolean",
+      "description": "Whether motion detection is enabled"
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CameraInterfacePtzControlMessage.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/camera",
+  "x-name": "ptz-control",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "pan": {
+      "type": "number",
+      "description": "Pan value (-100 to 100)",
+      "minimum": -100,
+      "maximum": 100
+    },
+    "tilt": {
+      "type": "number",
+      "description": "Tilt value (-100 to 100)",
+      "minimum": -100,
+      "maximum": 100
+    },
+    "zoom": {
+      "type": "number",
+      "description": "Zoom value (0 to 100)",
+      "minimum": 0,
+      "maximum": 100
+    }
+  },
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CameraInterfaceSetMotionDetectionMessage.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/camera",
+  "x-name": "set-motion-detection",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "description": "Whether to enable motion detection"
+    }
+  },
+  "required": [
+    "enabled"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CameraInterfaceStartStreamingMessage.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/camera",
+  "x-name": "start-streaming",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "streamingProtocol": {
+      "type": "string",
+      "enum": [
+        "RTSP",
+        "HLS",
+        "DASH",
+        "WEBRTC",
+        "OTHER"
+      ],
+      "description": "Streaming protocol to use"
+    },
+    "streamingUrl": {
+      "type": "string",
+      "format": "uri",
+      "description": "URL for streaming (if applicable)"
+    }
+  },
+  "required": [
+    "streamingProtocol"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CameraInterfaceStopStreamingMessage.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/camera",
+  "x-name": "stop-streaming",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonDioxideConcentrationSensorInterfaceConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-dioxide-concentration-sensor",
+  "x-name": "carbon-dioxide-concentration-sensor",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonDioxideConcentrationSensorInterfaceMaxMeasuredValueAttribute.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-dioxide-concentration-sensor",
+  "x-name": "max-measured-value",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "number",
+      "description": "Maximum measured value"
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonDioxideConcentrationSensorInterfaceMeasuredValueAttribute.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-dioxide-concentration-sensor",
+  "x-name": "measured-value",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "$ref": "/docs/references/schemas/MeasurementValue.json"
+    },
+    "unit": {
+      "$ref": "/docs/references/schemas/MeasurementUnit.json"
+    }
+  },
+  "required": [
+    "value",
+    "unit"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonDioxideConcentrationSensorInterfaceMinMeasuredValueAttribute.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-dioxide-concentration-sensor",
+  "x-name": "min-measured-value",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "number",
+      "description": "Minimum measured value"
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonMonoxideConcentrationSensorInterfaceConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-monoxide-concentration-sensor",
+  "x-name": "carbon-monoxide-concentration-sensor",
+  "x-version": "1.0",
+  "x-type": "configuration",
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonMonoxideConcentrationSensorInterfaceMaxMeasuredValueAttribute.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-monoxide-concentration-sensor",
+  "x-name": "max-measured-value",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "number",
+      "description": "Maximum measured value"
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonMonoxideConcentrationSensorInterfaceMeasuredValueAttribute.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-monoxide-concentration-sensor",
+  "x-name": "measured-value",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "$ref": "/docs/references/schemas/MeasurementValue.json"
+    },
+    "unit": {
+      "$ref": "/docs/references/schemas/MeasurementUnit.json"
+    }
+  },
+  "required": [
+    "value",
+    "unit"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/CarbonMonoxideConcentrationSensorInterfaceMinMeasuredValueAttribute.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/carbon-monoxide-concentration-sensor",
+  "x-name": "min-measured-value",
+  "x-version": "1.0",
+  "x-type": "attribute-definition",
+  "type": "object",
+  "properties": {
+    "value": {
+      "type": "number",
+      "description": "Minimum measured value"
+    }
+  },
+  "required": [
+    "value"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/ChannelInfo.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "A channel reference",
+  "properties": {
+    "number": {
+      "type": "string"
+    },
+    "callSign": {
+      "type": "string"
+    },
+    "affiliateCallSign": {
+      "type": "string"
+    },
+    "uri": {
+      "type": "string"
+    }
+  }
+}

package/generated/public/docs/references/schemas/ChannelInterfaceChangeChannelMessage.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/channel",
+  "x-name": "change-channel",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "in",
+  "type": "object",
+  "properties": {
+    "channel": {
+      "$ref": "/docs/references/schemas/ChannelInfo.json"
+    }
+  },
+  "additionalProperties": false
+}