chore: clean up structure for activeSegmentPart

Author: justandras

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

@@ -0,0 +1,3 @@
+$ref: '../partBase/partBase-example.yaml'
+timing:
+  expectedDurationMs: 15000

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

@@ -0,0 +1,17 @@
+$defs:
+  # TODO: Move this into the parts folder
+  currentSegmentPart:
+    title: CurrentSegmentPart
+    type: object
+    allOf:
+      - $ref: '../partBase/partBase.yaml#/$defs/partBase'
+      - type: object
+        title: CurrentSegmentPart
+        properties:
+          timing:
+            $ref: '../../timing/currentSegmentPartTiming/currentSegmentPartTiming.yaml#/$defs/currentSegmentPartTiming'
+        additionalProperties: false
+    required: [id, name, timing]
+    additionalProperties: false
+  examples:
+    - $ref: './currentSegmentPart-example.yaml'

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

@@ -0,0 +1,3 @@
+id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
+name: 'Intro'
+autoNext: false

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

@@ -0,0 +1,19 @@
+$defs:
+  partBase:
+    type: object
+    title: PartBase
+    properties:
+      id:
+        description: Unique id of the part
+        type: string
+      name:
+        description: User-presentable name of the part
+        type: string
+      autoNext:
+        description: If this part will progress to the next automatically
+        type: boolean
+        default: false
+    required: [id, name, segmentId, pieces]
+    additionalProperties: false
+    examples:
+      - $ref: './partBase-example.yaml'

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

@@ -1,7 +1,5 @@
-id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
-name: 'Intro'
+$ref: '../partBase/partBase-example.yaml'
 segmentId: 'n1mOVd5_K5tt4sfk6HYfTuwumGQ_'
-autoNext: false
 pieces:
   - $ref: '../../piece/pieceStatus/pieceStatus.yaml#/$defs/pieceStatus/examples/0'
 publicData:

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

@@ -2,27 +2,21 @@ $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/pieceStatus/pieceStatus.yaml#/$defs/pieceStatus'
-      publicData:
-        description: Optional arbitrary data
-    required: [id, name, segmentId, pieces]
+    allOf:
+      - $ref: '../partBase/partBase.yaml#/$defs/partBase'
+      - type: object
+        title: PartStatus
+        properties:
+          segmentId:
+            description: Unique id of the segment this part belongs to
+            type: string
+          pieces:
+            description: All pieces in this part
+            type: array
+            items:
+              $ref: '../../piece/pieceStatus/pieceStatus.yaml#/$defs/pieceStatus'
+          publicData:
+            description: Optional arbitrary data
+        required: [id, name, segmentId, pieces]
     examples:
       - $ref: './partStatus-example.yaml'

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

@@ -1,3 +1,4 @@
+# TODO: don't forget this
 title: Active Playlist
 description: Active Playlist schema for websocket subscriptions
 $defs:

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

@@ -1,29 +1,4 @@
 $defs:
-  # TODO: Move this into the parts folder
-  currentSegmentPart:
-    title: CurrentSegmentPart
-    type: object
-    properties:
-      id:
-        description: Unique id of the part
-        type: string
-      name:
-        description: User-presentable name of the part
-        type: string
-      autoNext:
-        description: If this part will progress to the next automatically
-        type: boolean
-        default: false
-      timing:
-        $ref: '../timing/currentSegmentPartTiming.yaml#/$defs/currentSegmentPartTiming'
-    required: [id, name, timing]
-    examples:
-      - id: 'H5CBGYjThrMSmaYvRaa5FVKJIzk_'
-        name: 'Intro'
-        timing:
-          expectedDurationMs: 15000
-    additionalProperties: false
-
   # TODO: move this into it's own folder
   currentSegment:
     title: CurrentSegment
@@ -37,7 +12,7 @@ $defs:
       parts:
         type: array
         items:
-          $ref: '#/$defs/currentSegmentPart'
+          $ref: '../part/currentSegmentPart/currentSegmentPart.yaml#/$defs/currentSegmentPart'
     required: [id, timing, parts]
     additionalProperties: false
 

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

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

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

@@ -3,16 +3,18 @@ $defs:
     type: object
     title: CurrentPartTiming
     description: Timing information about the current part
-    properties:
-      startTime:
-        description: Unix timestamp of when the part started (milliseconds)
-        type: number
-      expectedDurationMs:
-        description: Expected duration of the part (milliseconds)
-        type: number
-      projectedEndTime:
-        description: Unix timestamp of when the part is projected to end (milliseconds). A sum of `startTime` and `expectedDurationMs`.
-        type: number
+    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'