@bbc/sofie-live-status-gateway-api 1.53.0-in-development

package/api/components/studio/studioStatus/studioStatus-example.yaml

@@ -0,0 +1,4 @@
+id: 'B0avqzSM41UJDpbyf3U28'
+name: 'Studio 0'
+playlists:
+  - $ref: '../../playlist/playlistStatus/playlistStatus-example.yaml'

package/api/components/studio/studioStatus/studioStatus.yaml

@@ -0,0 +1,21 @@
+$defs:
+  studioStatus:
+    title: StudioStatus
+    type: object
+    properties:
+      id:
+        description: Unique id of the studio
+        oneOf:
+          - type: string
+          - type: 'null'
+      name:
+        description: User-presentable name for the studio installation
+        type: string
+      playlists:
+        description: The playlists that are currently loaded in the studio
+        type: array
+        items:
+          $ref: '../../playlist/playlistStatus/playlistStatus.yaml#/$defs/playlistStatus'
+    required: [id, name, playlists]
+    examples:
+      - ref: './studioStatus-example.yaml'

package/api/components/subscriptions/events/subscribeEvent/subscribeEvent-example.yaml

@@ -0,0 +1,4 @@
+event: subscribe
+reqid: 27
+subscription:
+  name: studio

package/api/components/subscriptions/events/subscribeEvent/subscribeEvent.yaml

@@ -0,0 +1,15 @@
+$defs:
+  subscribeEvent:
+    type: object
+    title: SubscribeEvent
+    properties:
+      event:
+        $ref: '../../subscriptionEventName.yaml#/$defs/subscriptionEventName'
+      reqid:
+        $ref: '../../../connection/reqid/reqid.yaml#/$defs/reqid'
+      subscription:
+        $ref: '../../subscriptionRequestDetails/subscriptionRequestDetails.yaml#/$defs/subscriptionRequestDetails'
+    required: [event, reqid, subscription]
+    additionalProperties: false
+    examples:
+      - $ref: './subscribeEvent-example.yaml'

package/api/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusError/subscriptionStatusError-example.yaml

@@ -0,0 +1,2 @@
+errorMessage: 'Subscribe to studio topic failed'
+$ref: '../subscriptionStatusSuccess/subscriptionStatusSuccess-example.yaml'

package/api/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusError/subscriptionStatusError.yaml

@@ -0,0 +1,14 @@
+$defs:
+  subscriptionStatusError:
+    type: object
+    title: SubscriptionStatusError
+    allOf:
+      - type: object
+        title: SubscriptionStatusError
+        properties:
+          errorMessage:
+            type: string
+        required: [errorMessage]
+      - $ref: '../subscriptionStatusSuccess/subscriptionStatusSuccess.yaml#/$defs/subscriptionStatusSuccess'
+    examples:
+      - $ref: './subscriptionStatusError-example.yaml'

package/api/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusEvent-example.yaml

@@ -0,0 +1,4 @@
+title: Subscription Status Event Examples
+examples:
+  - $ref: './subscriptionStatusError/subscriptionStatusError-example.yaml'
+  - $ref: './subscriptionStatusSuccess/subscriptionStatusSuccess-example.yaml'

package/api/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusEvent.yaml

@@ -0,0 +1,10 @@
+$defs:
+  subscriptionStatusEvent:
+    type: object
+    title: SubscriptionStatus
+    oneOf:
+      - $ref: './subscriptionStatusError/subscriptionStatusError.yaml#/$defs/subscriptionStatusError'
+      - $ref: './subscriptionStatusSuccess/subscriptionStatusSuccess.yaml#/$defs/subscriptionStatusSuccess'
+    examples:
+      - $ref: './subscriptionStatusEvent-example.yaml#/examples/0'
+      - $ref: './subscriptionStatusEvent-example.yaml#/examples/1'

package/api/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusSuccess/subscriptionStatusSuccess-example.yaml

@@ -0,0 +1,4 @@
+event: subscriptionStatus
+reqid: 27
+subscription:
+  $ref: '../../../subscriptionDetails/subscriptionDetails-example.yaml'

package/api/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusSuccess/subscriptionStatusSuccess.yaml

@@ -0,0 +1,16 @@
+$defs:
+  subscriptionStatusSuccess:
+    type: object
+    title: SubscriptionStatusSuccess
+    properties:
+      event:
+        type: string
+        const: subscriptionStatus
+      reqid:
+        $ref: '../../../../connection/reqid/reqid.yaml#/$defs/reqid'
+      subscription:
+        $ref: '../../../subscriptionDetails/subscriptionDetails.yaml#/$defs/subscriptionDetails'
+        required: [name, status]
+    required: [event, reqid, subscription]
+    examples:
+      - $ref: './subscriptionStatusSuccess-example.yaml'

package/api/components/subscriptions/messages/subscribeMessage.yaml

@@ -0,0 +1,12 @@
+components:
+  messages:
+    subscribeMessage:
+      name: subscribe
+      messageId: subscribe
+      title: Subscribe Event Message
+      description: Subscribe or unsubscribe to a topic
+      payload:
+        $ref: '../events/subscribeEvent/subscribeEvent.yaml#/$defs/subscribeEvent'
+      examples:
+        - payload:
+            $ref: '../events/subscribeEvent/subscribeEvent-example.yaml'

package/api/components/subscriptions/messages/subscriptionStatusErrorMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    subscriptionStatusErrorMessage:
+      messageId: subscriptionStatusError
+      description: Subscription status response to subscribe or unsubscribe
+      payload:
+        $ref: '../events/subscriptionStatusEvent/subscriptionStatusError/subscriptionStatusError.yaml#/$defs/subscriptionStatusError'
+      examples:
+        - payload:
+            $ref: '../events/subscriptionStatusEvent/subscriptionStatusError/subscriptionStatusError-example.yaml'

package/api/components/subscriptions/messages/subscriptionStatusSuccessMessage.yaml

@@ -0,0 +1,10 @@
+components:
+  messages:
+    subscriptionStatusSuccessMessage:
+      messageId: subscriptionStatusSuccess
+      description: Subscription status response to subscribe or unsubscribe
+      payload:
+        $ref: '../events/subscriptionStatusEvent/subscriptionStatusSuccess/subscriptionStatusSuccess.yaml#/$defs/subscriptionStatusSuccess'
+      examples:
+        - payload:
+            $ref: '../events/subscriptionStatusEvent/subscriptionStatusSuccess/subscriptionStatusSuccess-example.yaml'

package/api/components/subscriptions/subscriptionDetails/subscriptionDetails-example.yaml

@@ -0,0 +1,2 @@
+name: studio
+status: subscribed

package/api/components/subscriptions/subscriptionDetails/subscriptionDetails.yaml

@@ -0,0 +1,13 @@
+$defs:
+  subscriptionDetails:
+    type: object
+    title: SubscriptionDetails
+    properties:
+      name:
+        $ref: '../subscriptionName.yaml#/$defs/subscriptionName'
+      status:
+        $ref: '../subscriptionStatusName.yaml#/$defs/subscriptionStatusName'
+    required: [name, status]
+    additionalProperties: false
+    examples:
+      - $ref: './subscriptionDetails-example.yaml'

package/api/components/subscriptions/subscriptionEventName.yaml

@@ -0,0 +1,8 @@
+$defs:
+  subscriptionEventName:
+    type: string
+    title: SubscriptionEventName
+    description: Name of the event when subscribing or unsubscribing to topics.
+    enum:
+      - subscribe
+      - unsubscribe

package/api/components/subscriptions/subscriptionName.yaml

@@ -0,0 +1,14 @@
+$defs:
+  subscriptionName:
+    type: string
+    title: SubscriptionName
+    description: The name of the topic related to this status.
+    enum:
+      - studio
+      - activePlaylist
+      - activePieces
+      - segments
+      - adLibs
+      - notifications
+      - buckets
+      - packages

package/api/components/subscriptions/subscriptionRequestDetails/subscriptionRequestDetails.yaml

@@ -0,0 +1,11 @@
+$defs:
+  subscriptionRequestDetails:
+    type: object
+    title: SubscriptionRequestDetails
+    properties:
+      name:
+        $ref: '../subscriptionDetails/subscriptionDetails.yaml#/$defs/subscriptionDetails/properties/name'
+    required: [name]
+    additionalProperties: false
+    examples:
+      - $ref: '../subscriptionDetails/subscriptionDetails-example.yaml'

package/api/components/subscriptions/subscriptionStatusName.yaml

@@ -0,0 +1,8 @@
+$defs:
+  subscriptionStatusName:
+    type: string
+    title: SubscriptionStatus
+    description: The current status of the subscription
+    enum:
+      - subscribed
+      - unsubscribed

package/api/components/timing/activePlaylistTiming/activePlaylistTiming-example.yaml

@@ -0,0 +1,3 @@
+timingMode: 'forward-time'
+expectedStart: 1728895750727
+expectedDurationMs: 180000

package/api/components/timing/activePlaylistTiming/activePlaylistTiming.yaml

@@ -0,0 +1,24 @@
+$defs:
+  activePlaylistTiming:
+    type: object
+    title: ActivePlaylistTiming
+    description: Timing information about the active playlist
+    properties:
+      timingMode:
+        $ref: './activePlaylistTimingMode.yaml'
+      startedPlayback:
+        description: Unix timestamp of when the playlist started (milliseconds)
+        type: number
+      expectedStart:
+        description: Unix timestamp of when the playlist is expected to start (milliseconds). Required when the timingMode is set to forward-time.
+        type: number
+      expectedDurationMs:
+        description: Duration of the playlist in ms
+        type: number
+      expectedEnd:
+        description: Unix timestamp of when the playlist is expected to end (milliseconds) Required when the timingMode is set to back-time.
+        type: number
+    required: [timingMode]
+    additionalProperties: false
+    examples:
+      - $ref: './activePlaylistTiming-example.yaml'

package/api/components/timing/activePlaylistTiming/activePlaylistTimingMode.yaml

@@ -0,0 +1,7 @@
+type: string
+title: ActivePlaylistTimingMode
+description: Timing mode for the playlist.
+enum:
+  - none
+  - forward-time
+  - back-time

package/api/components/timing/currentPartTiming/currentPartTiming-example.yaml

@@ -0,0 +1,3 @@
+$ref: '../currentSegmentPartTiming/currentSegmentPartTiming-example.yaml'
+startTime: 1600000060000
+projectedEndTime: 1600000075000

package/api/components/timing/currentPartTiming/currentPartTiming.yaml

@@ -0,0 +1,20 @@
+$defs:
+  currentPartTiming:
+    type: object
+    title: CurrentPartTiming
+    description: Timing information about the current part
+    allOf:
+      - $ref: '../currentSegmentPartTiming/currentSegmentPartTiming.yaml#/$defs/currentSegmentPartTiming'
+      - type: object
+        title: CurrentPartTiming
+        description: Timing information about the current part
+        properties:
+          startTime:
+            description: Unix timestamp of when the part started (milliseconds)
+            type: number
+          projectedEndTime:
+            description: Unix timestamp of when the part is projected to end (milliseconds). A sum of `startTime` and `expectedDurationMs`.
+            type: number
+    required: [startTime, expectedDurationMs, projectedEndTime]
+    examples:
+      - $ref: './currentPartTiming-example.yaml'

package/api/components/timing/currentSegmentPartTiming/currentSegmentPartTiming-example.yaml

@@ -0,0 +1 @@
+expectedDurationMs: 15000

package/api/components/timing/currentSegmentPartTiming/currentSegmentPartTiming.yaml

@@ -0,0 +1,8 @@
+$defs:
+  currentSegmentPartTiming:
+    type: object
+    title: CurrentSegmentPartTiming
+    properties:
+      expectedDurationMs:
+        description: Expected duration of the part (milliseconds)
+        type: number

package/api/components/timing/currentSegmentTiming/currentSegmentTiming-example.yaml

@@ -0,0 +1,2 @@
+$ref: '../segmentTiming/segmentTiming-example.yaml'
+projectedEndTime: 1600000075000

package/api/components/timing/currentSegmentTiming/currentSegmentTiming.yaml

@@ -0,0 +1,16 @@
+$defs:
+  currentSegmentTiming:
+    type: object
+    title: CurrentSegmentTiming
+    description: Timing information about the current segment
+    allOf:
+      - $ref: '../segmentTiming/segmentTiming.yaml#/$defs/segmentTiming'
+      - type: object
+        title: CurrentSegmentTiming
+        properties:
+          projectedEndTime:
+            description: Unix timestamp of when the segment is projected to end (milliseconds). The time this segment started, offset by its budget duration, if the segment has a defined budget duration. Otherwise, the time the current part started, offset by the difference between expected durations of all parts in this segment and the as-played durations of the parts that already stopped.
+            type: number
+    required: [expectedDurationMs, projectedEndTime]
+    examples:
+      - $ref: './currentSegmentTiming-example.yaml'

package/api/components/timing/segmentCountdownType.yaml

@@ -0,0 +1,6 @@
+type: string
+title: SegmentCountdownType
+description: 'Countdown type within the segment. Default: `part_expected_duration`'
+enum:
+  - part_expected_duration
+  - segment_budget_duration

package/api/components/timing/segmentTiming/segmentTiming-example.yaml

@@ -0,0 +1,3 @@
+expectedDurationMs: 15000
+budgetDurationMs: 20000
+countdownType: segment_budget_duration

package/api/components/timing/segmentTiming/segmentTiming.yaml

@@ -0,0 +1,19 @@
+title: Segment Timing
+description: Timing information for a segment
+$defs:
+  segmentTiming:
+    type: object
+    title: SegmentTiming
+    properties:
+      expectedDurationMs:
+        description: Expected duration of the segment (milliseconds)
+        type: number
+      budgetDurationMs:
+        description: Budget duration of the segment (milliseconds)
+        type: number
+      countdownType:
+        description: 'Countdown type within the segment. Default: `part_expected_duration`'
+        $ref: '../segmentCountdownType.yaml'
+    required: [expectedDurationMs]
+    examples:
+      - ref: './segmentTiming-example.yaml'

package/api/topics/activePieces/activePiecesTopic.yaml

@@ -0,0 +1,8 @@
+description: Topic for active pieces updates
+
+subscribe:
+  operationId: receiveActivePieces
+  description: Server sends active pieces events
+  message:
+    oneOf:
+      - $ref: '../../components/piece/messages/activePiecesMessage.yaml#/components/messages/activePiecesMessage'

package/api/topics/activePlaylist/activePlaylistTopic.yaml

@@ -0,0 +1,8 @@
+description: Topic for active playlist updates
+
+subscribe:
+  operationId: receiveActivePlaylist
+  description: Server sends active playlist events
+  message:
+    oneOf:
+      - $ref: '../../components/playlist/messages/activePlaylistMessage.yaml#/components/messages/activePlaylistMessage'

package/api/topics/adLibs/adLibsTopic.yaml

@@ -0,0 +1,8 @@
+description: Topic for AdLibs updates
+
+subscribe:
+  operationId: receiveAdLibs
+  description: Server publishes AdLibs updates
+  message:
+    oneOf:
+      - $ref: '../../components/adLibs/messages/adLibsMessage.yaml#/components/messages/adLibsMessage'

package/api/topics/buckets/bucketsTopic.yaml

@@ -0,0 +1,8 @@
+description: Buckets schema for websocket subscriptions
+
+subscribe:
+  operationId: receiveBucketsUpdate
+  description: Server publishes Buckets updates
+  message:
+    oneOf:
+      - $ref: '../../components/buckets/messages/bucketsMessage.yaml#/components/messages/bucketsMessage'

package/api/topics/heartbeat/heartbeatTopic.yaml

@@ -0,0 +1,7 @@
+description: Topic for server heartbeat messages
+subscribe:
+  operationId: receiveHeartbeat
+  description: Server sends heartbeat messages when no other communication is happening.
+  message:
+    oneOf:
+      - $ref: '../../components/connection/messages/heartbeatMessage.yaml#/components/messages/heartbeatMessage'

package/api/topics/notifications/notificationsTopic.yaml

@@ -0,0 +1,7 @@
+description: Notifications topic for websocket subscriptions.
+subscribe:
+  operationId: receiveNotifications
+  description: Server sends notifications updates
+  message:
+    oneOf:
+      - $ref: '../../components/notifications/messages/notificationsMessage.yaml#/components/messages/notificationsMessage'

package/api/topics/packages/packagesTopic.yaml

@@ -0,0 +1,7 @@
+description: Packages topic for websocket subscriptions. Packages are assets that need to be prepared by Sofie Package Manager or third-party systems to make AdLibs and Pieces playable.
+subscribe:
+  operationId: receivePackagesUpdate
+  description: Server sends packages updates
+  message:
+    oneOf:
+      - $ref: '../../components/packages/messages/packagesMessage.yaml#/components/messages/packagesMessage'

package/api/topics/ping/pingTopic.yaml

@@ -0,0 +1,11 @@
+description: Topic for ping/pong communication
+publish:
+  operationId: sendPing
+  message:
+    oneOf:
+      - $ref: '../../components/connection/messages/pingMessage.yaml#/components/messages/pingMessage'
+subscribe:
+  operationId: receivePong
+  message:
+    oneOf:
+      - $ref: '../../components/connection/messages/pongMessage.yaml#/components/messages/pongMessage'

package/api/topics/segments/segmentsTopic.yaml

@@ -0,0 +1,7 @@
+description: Topic for Segment updates
+
+subscribe:
+  operationId: receiveSegments
+  description: Server publishes Segment updates
+  message:
+    $ref: '../../components/segment/messages/segmentsMessage.yaml#/components/messages/segmentsMessage'

package/api/topics/studio/studioTopic.yaml

@@ -0,0 +1,7 @@
+description: Studio topic for websocket subscriptions
+subscribe:
+  operationId: receiveStudioUpdate
+  description: Server sends studio status updates
+  message:
+    oneOf:
+      - $ref: '../../components/studio/messages/studioUpdate.yaml#/components/messages/studioUpdate'

package/api/topics/subscriptions/subscriptionsTopic.yaml

@@ -0,0 +1,16 @@
+description: Topic for managing subscription events.
+
+subscribe:
+  operationId: receiveSubscriptionStatus
+  description: Server sends subscription status updates
+  message:
+    oneOf:
+      - $ref: '../../components/subscriptions/messages/subscriptionStatusErrorMessage.yaml#/components/messages/subscriptionStatusErrorMessage'
+      - $ref: '../../components/subscriptions/messages/subscriptionStatusSuccessMessage.yaml#/components/messages/subscriptionStatusSuccessMessage'
+
+publish:
+  operationId: sendSubscriptionRequest
+  description: Client publishes subscription requests (subscribe/unsubscribe)
+  message:
+    oneOf:
+      - $ref: '../../components/subscriptions/messages/subscribeMessage.yaml#/components/messages/subscribeMessage'