@portpowered/reference-data 0.4.1 → 0.4.2

package/generated/public/docs/references/capability-interfaces/robotic-vacuum-cleaner.yaml

@@ -2,24 +2,21 @@ name: robotic-vacuum-cleaner
 namespace: port1/systems/zero/capability-interfaces/robotic-vacuum-cleaner
 version: '1.0'
 description: >-
-  Robotic vacuum cleaners start, pause, stop, and return to their dock. Set a
-  cleaning mode and read the reported mode and operational state to follow a
-  cleaning session.
+  Robotic vacuum cleaners start, pause, stop, and return to their dock. Set a cleaning mode and read
+  the reported mode and operational state to follow a cleaning session.
 messages:
   - name: clean-room
     description: >-
-      Clean one or more rooms, in the requested order. Each entry is a canonical
-      endpoint group the robot can control through a CAN_CONTROL relationship.
-      More than one room requires the configuration to declare
-      supportsMultiRoomCleaning; otherwise the request is rejected with
+      Clean one or more rooms, in the requested order. Each entry is a canonical endpoint group the
+      robot can control through a CAN_CONTROL relationship. More than one room requires the
+      configuration to declare supportsMultiRoomCleaning; otherwise the request is rejected with
       MULTI_ROOM_UNSUPPORTED.
     directionality: in
     schema:
       description: >-
-        Clean one or more rooms, in the requested order. Each entry is a
-        canonical endpoint group the robot can control through a CAN_CONTROL
-        relationship. More than one room requires the configuration to declare
-        supportsMultiRoomCleaning; otherwise the request is rejected with
+        Clean one or more rooms, in the requested order. Each entry is a canonical endpoint group
+        the robot can control through a CAN_CONTROL relationship. More than one room requires the
+        configuration to declare supportsMultiRoomCleaning; otherwise the request is rejected with
         MULTI_ROOM_UNSUPPORTED.
       type: object
       properties:
@@ -108,9 +105,10 @@ attributes:
         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.
+            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; DOCK_MAINTENANCE means it is on
+            the dock while the dock services it (emptying the dust bin, washing or drying the mop),
+            and it does not start cleaning until that finishes.
           enum:
             - STOPPED
             - RUNNING
@@ -119,6 +117,7 @@ attributes:
             - CHARGING
             - DOCKED
             - RETURNING_TO_DOCK
+            - DOCK_MAINTENANCE
       required:
         - value
       additionalProperties: false
@@ -144,21 +143,19 @@ configuration:
     supportsRoomCleaning:
       type: boolean
       description: >-
-        Whether the vacuum accepts clean-room for rooms it declares CAN_CONTROL
-        on. Vacuums that omit it do not advertise clean-room.
+        Whether the vacuum accepts clean-room for rooms it declares CAN_CONTROL on. Vacuums that
+        omit it do not advertise clean-room.
       default: false
     supportsMultiRoomCleaning:
       type: boolean
       description: >-
-        Whether clean-room accepts more than one room in one request. When
-        false, more than one groupId is rejected with MULTI_ROOM_UNSUPPORTED
-        before dispatch.
+        Whether clean-room accepts more than one room in one request. When false, more than one
+        groupId is rejected with MULTI_ROOM_UNSUPPORTED before dispatch.
       default: false
   additionalProperties: false
   description: >-
-    Robotic vacuum cleaners start, pause, stop, and return to their dock. Set a
-    cleaning mode and read the reported mode and operational state to follow a
-    cleaning session.
+    Robotic vacuum cleaners start, pause, stop, and return to their dock. Set a cleaning mode and
+    read the reported mode and operational state to follow a cleaning session.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read

package/generated/public/docs/references/capability-interfaces/route-discovery.yaml

@@ -2,8 +2,8 @@ name: route-discovery
 namespace: port1/systems/zero/capability-interfaces/route-discovery
 version: '1.0'
 description: >-
-  Route discovery reports the control routes available to an integration. Use
-  its group commands to name a group or update the routes that belong to it.
+  Route discovery reports the control routes available to an integration. Use its group commands to
+  name a group or update the routes that belong to it.
 messages:
   - name: add-group-route-members
     description: Request to add members to a group route
@@ -52,13 +52,13 @@ messages:
           description: List of plugin route IDs to remove as members from the group route
   - name: route-discovery-report
     description: >-
-      Report of discovered routes, group routes and their relationships. Decodes
-      to the same model as SynchronizationRequest.
+      Report of discovered routes, group routes and their relationships. Decodes to the same model
+      as SynchronizationRequest.
     directionality: out
     schema:
       description: >-
-        Report of discovered routes, group routes and their relationships.
-        Decodes to the same model as SynchronizationRequest.
+        Report of discovered routes, group routes and their relationships. Decodes to the same model
+        as SynchronizationRequest.
       type: object
       additionalProperties: false
       properties:
@@ -100,11 +100,9 @@ messages:
           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.
+              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.
             required:
               - pluginRouteId
               - name
@@ -113,9 +111,8 @@ messages:
                 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.
+                  Plugin-owned stable identifier of the group route. Must be unique across routes
+                  and group routes within one plugin and auth link.
               name:
                 type: string
                 description: The name of the associated group route
@@ -137,11 +134,10 @@ messages:
                       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.
+                        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:
@@ -163,14 +159,14 @@ messages:
                             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.
+                              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.
+                        Supported attribute subset. An omitted or empty list retains catalog-default
+                        behavior.
                     configuration:
                       type: object
                       additionalProperties: true
@@ -186,9 +182,8 @@ messages:
                 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.
+                  Private plugin metadata (native map, segment or cloud room addressing) returned to
+                  the plugin on dispatch; never exposed as application data.
             additionalProperties: false
             title: GroupRoute
         relationships:
@@ -196,11 +191,10 @@ messages:
           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.
+              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.
             additionalProperties: false
             required:
               - externalId
@@ -215,13 +209,11 @@ messages:
               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.
+                  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.
                 enum:
                   - IS_PART_OF
                   - CAN_CONTROL
@@ -229,9 +221,8 @@ messages:
               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
+                  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.
                 additionalProperties: false
                 minProperties: 1
@@ -241,14 +232,14 @@ messages:
                     type: string
                     minLength: 1
                     description: >-
-                      The plugin route ID of a route reported in the same or an
-                      earlier synchronization.
+                      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.
+                      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'
@@ -256,14 +247,13 @@ messages:
                 type: array
                 minItems: 1
                 description: >-
-                  Optional interface applicability; used by `CAN_CONTROL` to
-                  declare which messages the source supports on the target.
+                  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.
+                    Capability-interface applicability of a relationship, for example the
+                    robotic-vacuum-cleaner messages a `CAN_CONTROL` edge supports on a room.
                   additionalProperties: false
                   required:
                     - name
@@ -273,8 +263,7 @@ messages:
                       type: string
                       minLength: 1
                       description: The capability interface namespace.
-                      example: >-
-                        port1/systems/zero/capability-interfaces/robotic-vacuum-cleaner
+                      example: port1/systems/zero/capability-interfaces/robotic-vacuum-cleaner
                     version:
                       type: string
                       minLength: 1
@@ -285,8 +274,8 @@ messages:
                       minItems: 1
                       uniqueItems: true
                       description: >-
-                        Message names of the interface the relationship applies
-                        to. Omitted means every message of the interface.
+                        Message names of the interface the relationship applies to. Omitted means
+                        every message of the interface.
                       items:
                         type: string
                         minLength: 1
@@ -317,9 +306,7 @@ messages:
           properties:
             type:
               type: string
-              description: >-
-                The type identifier of the name value, defined as plain when not
-                defined
+              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

package/generated/public/docs/references/capability-interfaces/rtc-session/1.0/configuration.yaml

@@ -0,0 +1,172 @@
+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/public/docs/references/capability-interfaces/rtc-session/1.0/messages/answer-generated-for-session.yaml

@@ -9,7 +9,7 @@ properties:
       format:
         type: string
         enum:
-          - sdp
+          - SDP
       value:
         type: object
         properties:

package/generated/public/docs/references/capability-interfaces/rtc-session/1.0/messages/initiate-session-with-offer.yaml

@@ -21,7 +21,7 @@ properties:
       format:
         type: string
         enum:
-          - sdp
+          - SDP
       value:
         type: string
         description: The SDP offer session contents

package/generated/public/docs/references/capability-interfaces/rtc-session/1.0.yaml

@@ -20,7 +20,7 @@ messages:
             format:
               type: string
               enum:
-                - sdp
+                - SDP
             value:
               type: object
               properties:
@@ -85,7 +85,7 @@ messages:
             format:
               type: string
               enum:
-                - sdp
+                - SDP
             value:
               type: string
               description: The SDP offer session contents