@portpowered/reference-data 0.0.0-stage → 0.4.0

package/generated/resources/route-discovery/message-remove-group-route-members.json

@@ -0,0 +1,22 @@
+{
+  "description": "Request to remove members from a group route",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "groupRouteId",
+    "memberPluginRouteIds"
+  ],
+  "properties": {
+    "groupRouteId": {
+      "type": "string",
+      "description": "The ID of the group route to remove members from"
+    },
+    "memberPluginRouteIds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "List of plugin route IDs to remove as members from the group route"
+    }
+  }
+}

package/generated/resources/route-discovery/message-route-discovery-report.json

@@ -0,0 +1,251 @@
+{
+  "description": "Report of discovered routes, group routes and their relationships. Decodes to the same model as SynchronizationRequest.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "routes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "A discovered route",
+        "properties": {
+          "pluginRouteId": {
+            "type": "string",
+            "description": "The external ID of the route"
+          },
+          "name": {
+            "type": "string",
+            "description": "The name of the route"
+          },
+          "description": {
+            "type": "string",
+            "description": "The description of the route"
+          },
+          "type": {
+            "type": "string",
+            "description": "The type of the route that has been discovered"
+          },
+          "interfaces": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "description": "A reference to a route interface",
+              "properties": {
+                "namespace": {
+                  "type": "string",
+                  "description": "The name of the interface"
+                },
+                "version": {
+                  "type": "string",
+                  "description": "The version of the interface"
+                }
+              },
+              "title": "RouteInterfaceRef"
+            }
+          }
+        },
+        "additionalProperties": false,
+        "title": "DiscoveredRoute"
+      }
+    },
+    "groupRoutes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "A provider-reported group route (for example a vacuum map or room, a lighting room or a speaker group) as carried by discovery. It is shared by the route-discovery report message and `SynchronizationRequest.groupRoutes` so both decode to the same model.\n",
+        "required": [
+          "pluginRouteId",
+          "name"
+        ],
+        "properties": {
+          "pluginRouteId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Plugin-owned stable identifier of the group route. Must be unique across routes and group routes within one plugin and auth link.\n"
+          },
+          "name": {
+            "type": "string",
+            "description": "The name of the associated group route"
+          },
+          "interfaces": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "name"
+              ],
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "The name of the interface"
+                },
+                "version": {
+                  "type": "string",
+                  "description": "the version of the interface"
+                },
+                "messages": {
+                  "type": "array",
+                  "nullable": true,
+                  "minItems": 1,
+                  "description": "Supported inbound message subset for the declared interface version. Omission or null retains the interface's full message contract; a supplied array must be nonempty and contain distinct canonical names for implemented messages.",
+                  "items": {
+                    "type": "object",
+                    "required": [
+                      "name"
+                    ],
+                    "properties": {
+                      "name": {
+                        "type": "string",
+                        "description": "The name of the command"
+                      }
+                    },
+                    "title": "ApplicationInterfaceMessage"
+                  }
+                },
+                "attributes": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "required": [
+                      "name"
+                    ],
+                    "properties": {
+                      "name": {
+                        "type": "string",
+                        "description": "The name of the attribute"
+                      },
+                      "value": {
+                        "description": "the value of the attribute, this is an opaque resource object, so it can be any type of struct.",
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    },
+                    "title": "ApplicationInterfaceAttribute"
+                  },
+                  "description": "Supported attribute subset. An omitted or empty list retains catalog-default behavior."
+                },
+                "configuration": {
+                  "type": "object",
+                  "additionalProperties": true,
+                  "description": "The configuration of the interface"
+                }
+              },
+              "title": "RouteInterface"
+            }
+          },
+          "memberPluginRouteIds": {
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+              "type": "string"
+            },
+            "description": "List of plugin route IDs that are members of this group route"
+          },
+          "pluginCustomMetadata": {
+            "type": "object",
+            "additionalProperties": true,
+            "description": "Private plugin metadata (native map, segment or cloud room addressing) returned to the plugin on dispatch; never exposed as application data.\n"
+          }
+        },
+        "additionalProperties": false,
+        "title": "GroupRoute"
+      }
+    },
+    "relationships": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "A provider-reported relationship between routes and group routes. Identity is `externalId` within the reporting plugin and auth link; resubmitting the same `externalId` updates the relationship. Omission from a later synchronization is not a deletion instruction.\n",
+        "additionalProperties": false,
+        "required": [
+          "externalId",
+          "type",
+          "source",
+          "target"
+        ],
+        "properties": {
+          "externalId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Plugin-owned stable identifier of the relationship."
+          },
+          "type": {
+            "type": "string",
+            "description": "Typed relationship between provider routes and group routes. `IS_PART_OF`: a group route is contained in a parent group route (spatial hierarchy, acyclic). `CAN_CONTROL`: an endpoint route can act on a group route with the listed interface messages; it never grants authorization. `LOCATED_IN`: an endpoint route is currently observed inside a group route; it is an observation, not membership.\n",
+            "enum": [
+              "IS_PART_OF",
+              "CAN_CONTROL",
+              "LOCATED_IN"
+            ]
+          },
+          "source": {
+            "type": "object",
+            "description": "One end of a discovered relationship, addressed by plugin-owned identity within the reporting plugin and auth link. Exactly one of `pluginRouteId` (a route) or `groupPluginRouteId` (a group route) must be set.\n",
+            "additionalProperties": false,
+            "minProperties": 1,
+            "maxProperties": 1,
+            "properties": {
+              "pluginRouteId": {
+                "type": "string",
+                "minLength": 1,
+                "description": "The plugin route ID of a route reported in the same or an earlier synchronization."
+              },
+              "groupPluginRouteId": {
+                "type": "string",
+                "minLength": 1,
+                "description": "The plugin route ID of a group route reported in the same or an earlier synchronization."
+              }
+            },
+            "title": "PluginDiscoveryRelationshipVertex"
+          },
+          "target": {
+            "$ref": "#/properties/relationships/items/properties/source"
+          },
+          "interfaces": {
+            "type": "array",
+            "minItems": 1,
+            "description": "Optional interface applicability; used by `CAN_CONTROL` to declare which messages the source supports on the target.",
+            "items": {
+              "type": "object",
+              "description": "Capability-interface applicability of a relationship, for example the robotic-vacuum-cleaner messages a `CAN_CONTROL` edge supports on a room.\n",
+              "additionalProperties": false,
+              "required": [
+                "name",
+                "version"
+              ],
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "minLength": 1,
+                  "description": "The capability interface namespace.",
+                  "example": "port1/systems/zero/capability-interfaces/robotic-vacuum-cleaner"
+                },
+                "version": {
+                  "type": "string",
+                  "minLength": 1,
+                  "description": "The capability interface version.",
+                  "example": "1.0"
+                },
+                "messages": {
+                  "type": "array",
+                  "minItems": 1,
+                  "uniqueItems": true,
+                  "description": "Message names of the interface the relationship applies to. Omitted means every message of the interface.",
+                  "items": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "example": [
+                    "clean-room"
+                  ]
+                }
+              },
+              "title": "RelationshipInterface"
+            }
+          }
+        },
+        "title": "PluginDiscoveryRelationship"
+      }
+    }
+  }
+}

package/generated/resources/route-discovery/message-set-group-route-name.json

@@ -0,0 +1,34 @@
+{
+  "description": "Request to set the name of a group route",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "groupRouteId",
+    "name"
+  ],
+  "properties": {
+    "groupRouteId": {
+      "type": "string",
+      "description": "The ID of the group route to set the name for"
+    },
+    "name": {
+      "type": "object",
+      "description": "A route name value",
+      "required": [
+        "type",
+        "value"
+      ],
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "The type identifier of the name value, defined as plain when not defined"
+        },
+        "value": {
+          "type": "string",
+          "description": "The raw value of a plain name or localizable asset reference"
+        }
+      },
+      "title": "RouteName"
+    }
+  }
+}

package/generated/resources/rtc-session/configuration.json

@@ -0,0 +1,213 @@
+{
+  "type": "object",
+  "properties": {
+    "iceServers": {
+      "type": "array",
+      "maxItems": 8,
+      "description": "Optional public STUN configuration passed to the browser's standard RTCIceServer interface. Omitted or empty means no ICE servers. Gathering starts only when a caller deliberately initiates a session. TURN and credentials are excluded.",
+      "items": {
+        "type": "object",
+        "description": "The credential-free public STUN subset of the standard WebRTC RTCIceServer dictionary. URLs are discoverable configuration, never session credentials.",
+        "required": [
+          "urls"
+        ],
+        "properties": {
+          "urls": {
+            "oneOf": [
+              {
+                "type": "string",
+                "description": "Public, credential-free STUN URI using the RFC 7064 stun:host[:port] form. This version supports DNS names and IPv4 hosts, with ports 1 through 65535. IPv6 literals, secure STUN, TURN, paths, queries and fragments are not supported by this configuration subset.",
+                "minLength": 6,
+                "maxLength": 256,
+                "not": {
+                  "pattern": "\\s"
+                },
+                "pattern": "^stun:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?(?:\\.[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?)*(?::(?:[1-9][0-9]{0,3}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5]))?$"
+              },
+              {
+                "type": "array",
+                "minItems": 1,
+                "maxItems": 8,
+                "items": {
+                  "$ref": "#/properties/iceServers/items/properties/urls/oneOf/0"
+                }
+              }
+            ]
+          }
+        },
+        "additionalProperties": false,
+        "title": "RtcIceServer"
+      }
+    },
+    "supportedStreams": {
+      "type": "array",
+      "description": "Discoverable media streams in SDP offer order. Directions describe the endpoint; the browser reverses SENDONLY and RECVONLY. Omitted means a legacy video SENDONLY stream.",
+      "items": {
+        "type": "object",
+        "description": "A discoverable RTC media stream supported by an endpoint.",
+        "additionalProperties": false,
+        "required": [
+          "id",
+          "mediaKind",
+          "direction"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Stable identifier for the stream within the endpoint contract."
+          },
+          "mediaKind": {
+            "type": "string",
+            "enum": [
+              "AUDIO",
+              "VIDEO"
+            ]
+          },
+          "direction": {
+            "type": "string",
+            "description": "Direction from the endpoint perspective; browser SENDONLY and RECVONLY are reversed.",
+            "enum": [
+              "SENDRECV",
+              "SENDONLY",
+              "RECVONLY",
+              "INACTIVE"
+            ]
+          },
+          "codecs": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "uniqueItems": true,
+            "description": "Ordered permitted RTP codec MIME types, such as audio/opus or video/H264. Omitted uses browser defaults.",
+            "items": {
+              "type": "string",
+              "pattern": "^(audio|video)/[A-Za-z0-9.+-]+$",
+              "maxLength": 128
+            }
+          }
+        },
+        "title": "RtcSessionSupportedStream"
+      }
+    },
+    "dataChannels": {
+      "type": "array",
+      "maxItems": 8,
+      "description": "Data channels the browser creates after media transceivers, using the standard RTCDataChannelInit options. Omitted means no data channels.",
+      "items": {
+        "type": "object",
+        "description": "Standard WebRTC RTCDataChannelInit options plus the required label passed to createDataChannel. Channels are bidirectional.",
+        "additionalProperties": false,
+        "required": [
+          "label"
+        ],
+        "properties": {
+          "label": {
+            "type": "string",
+            "maxLength": 256
+          },
+          "ordered": {
+            "type": "boolean"
+          },
+          "protocol": {
+            "type": "string",
+            "maxLength": 256
+          },
+          "maxPacketLifeTime": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 65535
+          },
+          "maxRetransmits": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 65535
+          },
+          "negotiated": {
+            "type": "boolean"
+          },
+          "id": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 65534
+          }
+        },
+        "not": {
+          "required": [
+            "maxPacketLifeTime",
+            "maxRetransmits"
+          ]
+        },
+        "allOf": [
+          {
+            "if": {
+              "properties": {
+                "negotiated": {
+                  "const": true
+                }
+              },
+              "required": [
+                "negotiated"
+              ]
+            },
+            "then": {
+              "required": [
+                "id"
+              ]
+            }
+          }
+        ],
+        "title": "RtcDataChannel"
+      }
+    },
+    "iceMode": {
+      "type": "string",
+      "description": "Whether the endpoint expects a full offer up front or supports trickle ICE.",
+      "enum": [
+        "FULL_OFFER",
+        "TRICKLE"
+      ]
+    },
+    "messageAuthorizationRequirements": {
+      "type": "array",
+      "description": "Per-message authorization requirements for RTC session messages.",
+      "items": {
+        "type": "object",
+        "description": "Authorization requirements for a specific RTC session message.",
+        "additionalProperties": false,
+        "required": [
+          "messageName",
+          "authorization"
+        ],
+        "properties": {
+          "messageName": {
+            "type": "string"
+          },
+          "authorization": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "description": "A typed authorization requirement for an RTC session message.",
+              "additionalProperties": false,
+              "required": [
+                "type",
+                "required"
+              ],
+              "properties": {
+                "type": {
+                  "type": "string"
+                },
+                "required": {
+                  "type": "boolean"
+                }
+              },
+              "title": "RtcSessionAuthorizationRequirement"
+            }
+          }
+        },
+        "title": "RtcSessionMessageAuthorizationRequirement"
+      }
+    }
+  },
+  "additionalProperties": false,
+  "description": "RTC sessions initiate a connection using an offer and return an answer for the session. Follow disconnection events and close the session when the connection is no longer needed."
+}

package/generated/resources/rtc-session/message-answer-generated-for-session.json

@@ -0,0 +1,50 @@
+{
+  "type": "object",
+  "required": [
+    "answer"
+  ],
+  "properties": {
+    "answer": {
+      "type": "object",
+      "description": "An RTC session answer",
+      "properties": {
+        "format": {
+          "type": "string",
+          "enum": [
+            "sdp"
+          ]
+        },
+        "value": {
+          "type": "object",
+          "properties": {
+            "sdp": {
+              "type": "string",
+              "description": "The SDP answer session contents"
+            },
+            "streamToken": {
+              "type": "string",
+              "description": "Provider token for the established stream"
+            },
+            "streamExtensionToken": {
+              "type": "string",
+              "description": "Provider token used to extend the established stream"
+            },
+            "expiresAt": {
+              "type": "string",
+              "description": "Provider-reported stream expiration"
+            },
+            "streamUrl": {
+              "type": "string",
+              "description": "Provider stream URL when the answer is not SDP"
+            }
+          },
+          "additionalProperties": false,
+          "description": "The content of the answer",
+          "title": "RtcAnswerValue"
+        }
+      },
+      "title": "RtcAnswer"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/rtc-session/message-disconnect-session.json

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

package/generated/resources/rtc-session/message-initiate-session-with-offer.json

@@ -0,0 +1,89 @@
+{
+  "description": "The initiate session with offer message is used to initiate an RTC session between the client and an endpoint.  The offer is expected to be a standard RTC SDP (standard description protocol) offer. The offer must contain all ICE candidates for the session to be established.",
+  "type": "object",
+  "required": [
+    "sessionId",
+    "sessionDomain",
+    "offer"
+  ],
+  "properties": {
+    "sessionId": {
+      "type": "string"
+    },
+    "sessionDomain": {
+      "type": "string",
+      "description": "The logical RTC session domain requested by the caller."
+    },
+    "offer": {
+      "type": "object",
+      "description": "An RTC session offer",
+      "properties": {
+        "format": {
+          "type": "string",
+          "enum": [
+            "sdp"
+          ]
+        },
+        "value": {
+          "type": "string",
+          "description": "The SDP offer session contents"
+        }
+      },
+      "title": "RtcOffer"
+    },
+    "authorization": {
+      "type": "array",
+      "description": "Message-specific session authorization entries required by the target endpoint.",
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "description": "A Roborock session authorization entry carrying the PIN required to initiate a camera stream.",
+            "additionalProperties": false,
+            "required": [
+              "type",
+              "pin"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "ROBOROCK_PIN"
+                ]
+              },
+              "pin": {
+                "type": "string",
+                "description": "The Roborock PIN in dotted numeric format.",
+                "pattern": "^[0-9]+(\\.[0-9]+)*$"
+              }
+            },
+            "title": "RtcSessionRoborockPinAuthorization"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "ROBOROCK_PIN": "./RtcSessionRoborockPinAuthorization.yaml"
+          }
+        }
+      }
+    },
+    "sessionDuration": {
+      "type": "integer",
+      "description": "The duration of the session in seconds. If not provided, the default is 60 seconds. If provided, the session will be terminated after the duration has elapsed. To reestablish the session, the client must initiate a new session with a new offer.",
+      "minimum": 1,
+      "maximum": 3600,
+      "default": 60,
+      "examples": [
+        {
+          "value": 60,
+          "description": "1 minute"
+        }
+      ]
+    },
+    "autoAnswer": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false
+}

package/generated/resources/rtc-session/message-session-disconnected.json

@@ -0,0 +1,4 @@
+{
+  "type": "object",
+  "additionalProperties": false
+}

package/generated/resources/rtsp-session/configuration.json

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