Merge pull request #1543 from SuperFlyTV/chore/refactor-lsg-asyncapi-schema

chore: refactor lsg asyncapi schema

Author: ianshade

packages/live-status-gateway-api/.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+temp
 test
 src/**.js
 

packages/live-status-gateway-api/api/asyncapi.yaml

@@ -1,20 +1,20 @@
-asyncapi: 2.6.0
-id: 'urn:nrk:no:sofie:live-status-gateway:server'
+asyncapi: '2.6.0'
+id: 'sofie:live-status-gateway:server'
 info:
   title: Sofie Live Status Service
+  version: '2.0.1'
   description: This service provides subscriptions for status updates from Sofie
-  version: 2.0.0
   license:
     name: MIT License
     url: http://opensource.org/licenses/MIT
   contact:
-    name: Sofie TV Automation - NRK Team
+    name: Sofie TV Automation
     url: https://github.com/Sofie-Automation/sofie-core/issues
 
 servers:
   development:
     url: localhost
-    description: Server available without authorisation
+    description: Server available without authorization
     protocol: ws
     protocolVersion: '13'
 
@@ -26,114 +26,24 @@ tags:
   - name: broadcast
 
 channels:
-  /:
-    publish:
-      description: Send messages to the root API
-      operationId: processRootMessage
-      message:
-        oneOf:
-          - $ref: '#/components/messages/ping'
-          - $ref: '#/components/messages/subscribe'
-          - $ref: '#/components/messages/unsubscribe'
-    subscribe:
-      description: Messages that are received from the API
-      operationId: sendRootMessage
-      message:
-        oneOf:
-          - $ref: '#/components/messages/pong'
-          - $ref: '#/components/messages/heartbeat'
-          - $ref: '#/components/messages/subscriptionStatus'
-          - $ref: '#/components/messages/studio'
-          - $ref: '#/components/messages/activePlaylist'
-          - $ref: '#/components/messages/activePieces'
-          - $ref: '#/components/messages/segments'
-          - $ref: '#/components/messages/adLibs'
-          - $ref: '#/components/messages/packages'
-          - $ref: '#/components/messages/buckets'
-components:
-  messages:
-    ping:
-      name: ping
-      messageId: ping
-      summary: Ping server to determine whether connection is alive
-      description: Client can ping server to determine whether connection is alive, server responds with pong. This is an application level ping as opposed to default ping in websockets standard which is server initiated
-      payload:
-        $ref: './schemas/root.yaml#/$defs/ping'
-      x-response:
-        $ref: '#/components/messages/pong'
-    pong:
-      name: pong
-      messageId: pong
-      summary: Pong is a response to ping message
-      description: Server pong response to a ping to determine whether connection is alive. This is an application level pong as opposed to default pong in websockets standard which is sent by client in response to a ping
-      payload:
-        $ref: './schemas/root.yaml#/$defs/pong'
-    heartbeat:
-      name: heartbeat
-      messageId: heartbeat
-      description: Server heartbeat sent if no subscription traffic within 1 second (approximately)
-      payload:
-        $ref: './schemas/root.yaml#/$defs/heartbeat'
-    subscribe:
-      name: subscribe
-      messageId: subscribe
-      description: Subscribe to a topic
-      payload:
-        $ref: './schemas/root.yaml#/$defs/subscribe'
-      x-response:
-        $ref: './schemas/root.yaml#/$defs/subscriptionStatus'
-    unsubscribe:
-      name: unsubscribe
-      messageId: unsubscribe
-      description: Unsubscribe from a topic
-      payload:
-        $ref: './schemas/root.yaml#/$defs/unsubscribe'
-      x-response:
-        $ref: './schemas/root.yaml#/$defs/subscriptionStatus'
-    subscriptionStatus:
-      messageId: subscriptionStatus
-      description: Subscription status response to subscribe or unsubscribe
-      payload:
-        $ref: './schemas/root.yaml#/$defs/subscriptionStatus'
-    studio:
-      name: studio
-      messageId: studioUpdate
-      description: Studio status
-      payload:
-        $ref: './schemas/studio.yaml#/$defs/studio'
-    activePlaylist:
-      name: activePlaylist
-      messageId: activePlaylistUpdate
-      description: Active Playlist status
-      payload:
-        $ref: './schemas/activePlaylist.yaml#/$defs/activePlaylist'
-    activePieces:
-      name: activePieces
-      messageId: activePiecesUpdate
-      summary: Active Pieces status
-      description: Pieces from the active Playlist that are currently active (on air)
-      payload:
-        $ref: './schemas/activePieces.yaml#/$defs/activePieces'
-    segments:
-      name: segments
-      messageId: segmentsUpdate
-      description: Segments in active Playlist
-      payload:
-        $ref: './schemas/segments.yaml#/$defs/segments'
-    adLibs:
-      name: adLibs
-      messageId: adLibsUpdate
-      description: AdLibs in active Playlist
-      payload:
-        $ref: './schemas/adLibs.yaml#/$defs/adLibs'
-    packages:
-      name: packages
-      messageId: packages
-      description: Status of Packages expected by Pieces
-      payload:
-        $ref: './schemas/packages.yaml#/$defs/packages'
-    buckets:
-      name: buckets
-      description: Buckets in Studio
-      payload:
-        $ref: './schemas/buckets.yaml#/$defs/buckets'
+  # As the LSG is websocket only, channels are only used for logical grouping for the generated docs and folder structure.
+  ping:
+    $ref: './topics/ping/pingTopic.yaml'
+  heartbeat:
+    $ref: './topics/heartbeat/heartbeatTopic.yaml'
+  subscriptions:
+    $ref: './topics/subscriptions/subscriptionsTopic.yaml'
+  studio:
+    $ref: './topics/studio/studioTopic.yaml'
+  activePlaylist:
+    $ref: './topics/activePlaylist/activePlaylistTopic.yaml'
+  activePieces:
+    $ref: './topics/activePieces/activePiecesTopic.yaml'
+  segments:
+    $ref: './topics/segments/segmentsTopic.yaml'
+  adLibs:
+    $ref: './topics/adLibs/adLibsTopic.yaml'
+  packages:
+    $ref: './topics/packages/packagesTopic.yaml'
+  buckets:
+    $ref: './topics/buckets/bucketsTopic.yaml'

packages/live-status-gateway-api/api/components/adLibs/actionType/actionType-example.yaml

@@ -0,0 +1,2 @@
+name: pvw
+label: Preview

packages/live-status-gateway-api/api/components/adLibs/actionType/actionType.yaml

@@ -0,0 +1,15 @@
+$defs:
+  adLibActionType:
+    title: AdLibActionType
+    type: object
+    properties:
+      name:
+        type: string
+        description: The string to be passed to the ExecuteAdlib function
+      label:
+        type: string
+        description: The label for the AdLib type
+    required: [name, label]
+    additionalProperties: false
+    examples:
+      - $ref: './actionType-example.yaml'

packages/live-status-gateway-api/api/components/adLibs/adLibBase/adLibBase-example.yaml

@@ -0,0 +1,9 @@
+id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
+name: Music video clip
+sourceLayer: Video Clip
+actionType:
+  - $ref: '../actionType/actionType-example.yaml'
+tags: ['music_video']
+publicData:
+  fileName: MV000123.mxf
+optionsSchema: '{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Play Video Clip","type":"object","properties":{"type":"adlib_action_video_clip","label":{"type":"string"},"clipId":{"type":"string"},"vo":{"type":"boolean"},"target":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Object Id","description":"Id of an object sent to Sofie","type":"string"},"duration":{"type":"number","exclusiveMinimum":0},"takeType":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"AdLib Action Take Type","type":"string","enum":["take_immediate","queue"]},"transition":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"AdLib Action Transition Type","oneOf":[{"type":"object","properties":{"type":"cut"},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":"mix","duration":{"type":"number","exclusiveMinimum":0,"description":"Duration in ms"}},"required":["type","duration"],"additionalProperties":false},{"type":"object","properties":{"type":"wipe","duration":{"type":"number","exclusiveMinimum":0,"description":"Duration in ms"},"patternId":{"type":"string","description":"Type of wipe to use"}},"required":["type","duration","patternId"],"additionalProperties":false},{"type":"object","properties":{"type":"macro","macroId":{"type":"string","description":"Macro template to recall"}},"required":["type","macroId"],"additionalProperties":false}]}},"required":["type","clipId","vo","target"],"additionalProperties":false}"'

packages/live-status-gateway-api/api/components/adLibs/adLibBase/adLibBase.yaml

@@ -0,0 +1,35 @@
+$defs:
+  adLibBase:
+    title: AdLibBase
+    type: object
+    properties:
+      id:
+        type: string
+        description: Unique id of the AdLib
+      name:
+        type: string
+        description: The user defined AdLib name
+      sourceLayer:
+        type: string
+        description: The source layer name for this AdLib
+      outputLayer:
+        type: string
+        description: The output layer name for this AdLib
+      actionType:
+        type: array
+        description: The available action type names that can be used to modify the execution of the AdLib
+        items:
+          $ref: '../actionType/actionType.yaml#/$defs/adLibActionType'
+      tags:
+        type: array
+        description: Tags attached to this AdLib
+        items:
+          type: string
+      publicData:
+        description: Optional arbitrary data
+      optionsSchema:
+        type: string
+        description: JSON schema definition of the adLib properties that can be modified using the adLibOptions property in executeAdLib
+    required: [id, name, sourceLayer, actionType]
+    examples:
+      - $ref: './adLibBase-example.yaml'

packages/live-status-gateway-api/api/components/adLibs/adLibStatus/adLibStatus-example.yaml

@@ -0,0 +1,3 @@
+$ref: '../adLibBase/adLibBase-example.yaml'
+segmentId: HsD8_QwE1ZmR5vN3XcK_Ab7y
+partId: JkL3_OpR6WxT1bF8Vq2_Zy9u

packages/live-status-gateway-api/api/components/adLibs/adLibStatus/adLibStatus.yaml

@@ -0,0 +1,17 @@
+$defs:
+  adLibStatus:
+    title: AdLibStatus
+    allOf:
+      - $ref: '../adLibBase/adLibBase.yaml#/$defs/adLibBase'
+      - type: object
+        title: AdLibStatus
+        properties:
+          segmentId:
+            description: Unique id of the segment this adLib belongs to
+            type: string
+          partId:
+            description: Unique id of the part this adLib belongs to
+            type: string
+        required: [segmentId, partId]
+    examples:
+      - $ref: './adLibStatus-example.yaml'

packages/live-status-gateway-api/api/components/adLibs/adLibsEvent/adLibsEvent-example.yaml

@@ -0,0 +1,6 @@
+event: 'adLibs'
+rundownPlaylistId: 'OKAgZmZ0Buc99lE_2uPPSKVbMrQ_'
+adLibs:
+  - $ref: '../adLibStatus/adLibStatus-example.yaml'
+globalAdLibs:
+  - $ref: '../globalAdLibStatus/globalAdLibStatus-example.yaml'

packages/live-status-gateway-api/api/components/adLibs/adLibsEvent/adLibsEvent.yaml

@@ -0,0 +1,29 @@
+$defs:
+  adLibsEvent:
+    type: object
+    title: AdLibsEvent
+    properties:
+      event:
+        type: string
+        const: adLibs
+      rundownPlaylistId:
+        description: Unique id of the rundown playlist, or null if no playlist is active
+        oneOf:
+          - type: string
+            title: Unique id of the rundown playlist
+          - type: 'null'
+            title: Null if no playlist is active
+      adLibs:
+        type: array
+        description: The available AdLibs for this playlist
+        items:
+          $ref: '../adLibStatus/adLibStatus.yaml#/$defs/adLibStatus'
+      globalAdLibs:
+        type: array
+        description: The available Global AdLibs for this playlist
+        items:
+          $ref: '../globalAdLibStatus/globalAdLibStatus.yaml#/$defs/globalAdLibStatus'
+    required: [event, rundownPlaylistId, adLibs, globalAdLibs]
+    additionalProperties: false
+    examples:
+      - $ref: './adLibsEvent-example.yaml'