chore: clean up structure for studio topic

Author: justandras

packages/live-status-gateway-api/api/refactor/components/segment/segmentsEvent/segmentsEvent.yaml

@@ -19,3 +19,4 @@ $defs:
         items:
           $ref: '../segment/segment.yaml#/$defs/segment'
     required: [event, rundownPlaylistId, segments]
+# TODO: add examples back to segment definitions

packages/live-status-gateway-api/api/refactor/components/studio/messages/studioUpdate.yaml

@@ -5,4 +5,7 @@ components:
       messageId: studioUpdate
       description: Studio status
       payload:
-        $ref: '../studio.yaml'
+        $ref: '../studioEvent/studioEvent.yaml#/$defs/studioEvent'
+      examples:
+        - payload:
+            $ref: '../studioEvent/studioEvent-example.yaml'

packages/live-status-gateway-api/api/refactor/components/studio/studio.yaml

@@ -0,0 +1,2 @@
+event: studio
+$ref: '../studioStatus/studioStatus-example.yaml'

packages/live-status-gateway-api/api/refactor/components/studio/studioEvent/studioEvent-example.yaml

@@ -0,0 +1,14 @@
+$defs:
+  studioEvent:
+    title: StudioEvent
+    type: object
+    allOf:
+      - title: StudioEvent
+        type: object
+        properties:
+          event:
+            type: string
+            const: studio
+        required: [event]
+      - $ref: '../studioStatus/studioStatus.yaml#/$defs/studioStatus'
+    required: [event, id, name, playlists]

packages/live-status-gateway-api/api/refactor/components/studio/studioEvent/studioEvent.yaml

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

…/refactor/components/studio/example.yaml …o/studioStatus/studioStatus-example.yamlpackages/live-status-gateway-api/api/refactor/components/studio/example.yaml renamed to packages/live-status-gateway-api/api/refactor/components/studio/studioStatus/studioStatus-example.yaml packages/live-status-gateway-api/api/refactor/components/studio/example.yaml renamed to packages/live-status-gateway-api/api/refactor/components/studio/studioStatus/studioStatus-example.yaml

@@ -0,0 +1,19 @@
+$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/playlist.yaml'
+    required: [id, name, playlists]

packages/live-status-gateway-api/api/refactor/components/studio/studioStatus/studioStatus.yaml

@@ -36,17 +36,17 @@ channels:
   subscriptions:
     $ref: './topics/subscriptions/subscriptions.yaml'
   studio:
-    $ref: './topics/studio/studio.yaml'
+    $ref: './topics/studio/studioTopic.yaml'
   activePlaylist:
     $ref: './topics/activePlaylist/activePlaylist.yaml'
   activePieces:
     $ref: './topics/activePieces/activePieces.yaml'
   segments:
-    $ref: './topics/segments/segments.yaml'
+    $ref: './topics/segments/segmentsTopic.yaml'
   adLibs:
     $ref: './topics/adLibs/adLibsTopic.yaml'
   packages:
-    $ref: './topics/packages/packages.yaml'
+    $ref: './topics/packages/packagesTopic.yaml'
   buckets:
     $ref: './topics/buckets/bucketsTopic.yaml'