chore: clean up structure for part components

Author: justandras

packages/live-status-gateway-api/api/refactor/components/part/currentPart/currentPartStatus-example.yaml

@@ -0,0 +1,3 @@
+$ref: '../partStatus/partStatus-example.yaml'
+timing:
+  $ref: '../../timing/currentPartTiming/currentPartTiming-example.yaml'

packages/live-status-gateway-api/api/refactor/components/part/currentPart/currentPartStatus.yaml

@@ -0,0 +1,13 @@
+$defs:
+  currentPartStatus:
+    title: CurrentPartStatus
+    allOf:
+      - $ref: '../partStatus/partStatus.yaml#/$defs/partStatus'
+      - type: object
+        title: CurrentPartStatus
+        properties:
+          timing:
+            $ref: '../../timing/currentPartTiming/currentPartTiming.yaml#/$defs/currentPartTiming'
+        required: [timing]
+    examples:
+      - $ref: './currentPartStatus-example.yaml'

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

@@ -0,0 +1,8 @@
+id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+name: 'Intro'
+segmentId: 'n1mOVd5_K5tt4sfk6HYfTuwumGQ_'
+autoNext: false
+pieces:
+  - $ref: '../../piece/piece.yaml#/$defs/piece/examples/0'
+publicData:
+  partType: 'intro'

packages/live-status-gateway-api/api/refactor/components/part/partStatus/partStatus-example.yaml

@@ -0,0 +1,28 @@
+$defs:
+  partStatus:
+    type: object
+    title: PartStatus
+    properties:
+      id:
+        description: Unique id of the part
+        type: string
+      name:
+        description: User name of the part
+        type: string
+      segmentId:
+        description: Unique id of the segment this part belongs to
+        type: string
+      autoNext:
+        description: If this part will progress to the next automatically
+        type: boolean
+        default: false
+      pieces:
+        description: All pieces in this part
+        type: array
+        items:
+          $ref: '../../piece/piece.yaml#/$defs/piece'
+      publicData:
+        description: Optional arbitrary data
+    required: [id, name, segmentId, pieces]
+    examples:
+      - $ref: './partStatus-example.yaml'

packages/live-status-gateway-api/api/refactor/components/part/partStatus/partStatus.yaml

@@ -27,13 +27,17 @@ $defs:
         items:
           type: string
       currentPart:
-        $ref: '../part/part.yaml#/$defs/currentPart'
+        oneOf:
+          - $ref: '../part/currentPart/currentPartStatus.yaml#/$defs/currentPartStatus'
+          - type: 'null'
       currentSegment:
         oneOf:
           - $ref: '../segment/segment.yaml#/$defs/currentSegment'
           - type: 'null'
       nextPart:
-        $ref: '../part/part.yaml#/$defs/part'
+        oneOf:
+          - $ref: '../part/partStatus/partStatus.yaml#/$defs/partStatus'
+          - type: 'null'
       publicData:
         description: Optional arbitrary data
       timing:

packages/live-status-gateway-api/api/refactor/components/playlist/activePlaylist.yaml

@@ -0,0 +1,3 @@
+startTime: 1600000060000
+expectedDurationMs: 15000
+projectedEndTime: 1600000075000

packages/live-status-gateway-api/api/refactor/components/timing/currentPartTiming/currentPartTiming-example.yaml

@@ -14,3 +14,5 @@ $defs:
         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'