chore: add missing $def to files

justandras · justandras · commit d6a2e5c139e9 · 2025-10-20T11:59:43.000+02:00
diff --git a/packages/live-status-gateway-api/api/refactor/components/adLibs/bucketAdLib/bucketAdLib.yaml b/packages/live-status-gateway-api/api/refactor/components/adLibs/bucketAdLib/bucketAdLib.yaml
diff --git a/packages/live-status-gateway-api/api/refactor/components/adLibs/bucketAdLibStatus/bucketAdLibStatus-example.yaml b/packages/live-status-gateway-api/api/refactor/components/adLibs/bucketAdLibStatus/bucketAdLibStatus-example.yaml
diff --git a/packages/live-status-gateway-api/api/refactor/components/adLibs/bucketAdLibStatus/bucketAdLibStatus.yaml b/packages/live-status-gateway-api/api/refactor/components/adLibs/bucketAdLibStatus/bucketAdLibStatus.yaml
@@ -0,0 +1,14 @@
+$defs:
+  bucketAdLibStatus:
+    title: BucketAdLibStatus
+    allOf:
+      - $ref: '../adLibBase/adLibBase.yaml#/$defs/adLibBase'
+      - type: object
+        title: BucketAdLibStatus
+        properties:
+          externalId:
+            type: string
+            description: Id of the adlib recognizable by the external source. Unique within a bucket.
+        required: [externalId]
+    examples:
+      - $ref: './bucketAdLibStatus-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/buckets/bucketStatus/bucketStatus-example.yaml b/packages/live-status-gateway-api/api/refactor/components/buckets/bucketStatus/bucketStatus-example.yaml
@@ -1,4 +1,4 @@
 id: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
 name: My Bucket
 adLibs:
-  - $ref: '../../adLibs/bucketAdLib/bucketAdLib-example.yaml'
+  - $ref: '../../adLibs/bucketAdLibStatus/bucketAdLibStatus-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/buckets/bucketStatus/bucketStatus.yaml b/packages/live-status-gateway-api/api/refactor/components/buckets/bucketStatus/bucketStatus.yaml
@@ -13,7 +13,7 @@ $defs:
         description: The AdLibs in this bucket
         type: array
         items:
-          $ref: '../../adLibs/bucketAdlib/bucketAdLib.yaml'
+          $ref: '../../adLibs/bucketAdlibStatus/bucketAdLibStatus.yaml#/$defs/bucketAdLibStatus'
     required: [id, name, adLibs]
     additionalProperties: false
     examples:
diff --git a/packages/live-status-gateway-api/api/refactor/components/connection/heartbeatEvent/heartbeatEvent.yaml b/packages/live-status-gateway-api/api/refactor/components/connection/heartbeatEvent/heartbeatEvent.yaml
@@ -1,10 +1,12 @@
-title: HeartbeatEvent
-type: object
-properties:
-  event:
-    type: string
-    const: heartbeat
-required: [event]
-additionalProperties: false
-examples:
-  - $ref: './heartbeatEvent-example.yaml'
+$defs:
+  heartbeatEvent:
+    title: HeartbeatEvent
+    type: object
+    properties:
+      event:
+        type: string
+        const: heartbeat
+    required: [event]
+    additionalProperties: false
+    examples:
+      - $ref: './heartbeatEvent-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/connection/messages/heartbeatMessage.yaml b/packages/live-status-gateway-api/api/refactor/components/connection/messages/heartbeatMessage.yaml
@@ -5,7 +5,7 @@ components:
       messageId: heartbeat
       description: Server heartbeat sent if no subscription traffic within 1 second (approximately)
       payload:
-        $ref: '../heartbeatEvent/heartbeatEvent.yaml'
+        $ref: '../heartbeatEvent/heartbeatEvent.yaml#/$defs/heartbeatEvent'
       examples:
         - payload:
             $ref: '../heartbeatEvent/heartbeatEvent-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/connection/messages/pingMessage.yaml b/packages/live-status-gateway-api/api/refactor/components/connection/messages/pingMessage.yaml
@@ -6,7 +6,7 @@ components:
       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: '../pingEvent/pingEvent.yaml'
+        $ref: '../pingEvent/pingEvent.yaml#/$defs/pingEvent'
       examples:
         - payload:
             $ref: '../pingEvent/pingEvent-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/connection/messages/pongMessage.yaml b/packages/live-status-gateway-api/api/refactor/components/connection/messages/pongMessage.yaml
@@ -6,7 +6,7 @@ components:
       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: '../pongEvent/pongEvent.yaml'
+        $ref: '../pongEvent/pongEvent.yaml#/$defs/pongEvent'
       examples:
         - payload:
             $ref: '../pongEvent/pongEvent-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/connection/pingEvent/pingEvent.yaml b/packages/live-status-gateway-api/api/refactor/components/connection/pingEvent/pingEvent.yaml
@@ -1,12 +1,14 @@
-title: PingEvent
-type: object
-properties:
-  event:
-    type: string
-    const: ping
-  reqid:
-    $ref: '../reqid/reqid.yaml'
-required: [event, reqid]
-additionalProperties: false
-examples:
-  - $ref: './pingEvent-example.yaml'
+$defs:
+  pingEvent:
+    title: PingEvent
+    type: object
+    properties:
+      event:
+        type: string
+        const: ping
+      reqid:
+        $ref: '../reqid/reqid.yaml#/$defs/reqid'
+    required: [event, reqid]
+    additionalProperties: false
+    examples:
+      - $ref: './pingEvent-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/connection/pongEvent/pongEvent.yaml b/packages/live-status-gateway-api/api/refactor/components/connection/pongEvent/pongEvent.yaml
@@ -1,12 +1,14 @@
-title: PongEvent
-type: object
-properties:
-  event:
-    type: string
-    const: pong
-  reqid:
-    $ref: '../reqid/reqid.yaml'
-required: [event, reqid]
-additionalProperties: false
-examples:
-  - $ref: './pongEvent-example.yaml'
+$defs:
+  pongEvent:
+    title: PongEvent
+    type: object
+    properties:
+      event:
+        type: string
+        const: pong
+      reqid:
+        $ref: '../reqid/reqid.yaml#/$defs/reqid'
+    required: [event, reqid]
+    additionalProperties: false
+    examples:
+      - $ref: './pongEvent-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/connection/reqid/reqid.yaml b/packages/live-status-gateway-api/api/refactor/components/connection/reqid/reqid.yaml
@@ -1,2 +1,4 @@
-type: integer
-description: Client originated ID reflected in response message.
+$defs:
+  reqid:
+    type: integer
+    description: Client originated ID reflected in response message.
diff --git a/packages/live-status-gateway-api/api/refactor/components/packages/packageInfoStatus/packageInfoStatus.yaml b/packages/live-status-gateway-api/api/refactor/components/packages/packageInfoStatus/packageInfoStatus.yaml
@@ -1,30 +1,32 @@
-title: PackageInfoStatus
-type: object
-properties:
-  packageName:
-    description: Name of the package
-    type: string
-  status:
-    $ref: '../packageStatus/packageStatus.yaml'
-  rundownId:
-    description: Id of the Rundown that a Piece (or AdLib) expecting this package belongs to
-    type: string
-  partId:
-    description: Id of the Part that a Piece (or AdLib) expecting this package belongs to. It could be an Id of a Part from the Active Playlist topic, or a Part not exposed otherwise by the LSG.
-    type: string
-  segmentId:
-    description: Id of the Segment that a Piece (or AdLib) expecting this package belongs to
-    type: string
-  pieceOrAdLibId:
-    description: Id of the Piece or AdLib that expects this package. It could be an Id of a Piece from the Active Pieces and Active Playlist topics, or an Id of an AdLib from the AdLibs topic. It could also be an Id of a Piece not exposed otherwise by the LSG, but still relevant, e.g. to summarize the status of packages within a specific Part/Segment.
-    type: string
-  thumbnailUrl:
-    description: URL where the thumbnail can be accessed
-    type: string
-  previewUrl:
-    description: URL where the preview can be accessed
-    type: string
-required: [status, rundownId, pieceOrAdLibId]
-additionalProperties: false
-examples:
-  - $ref: './packageInfoStatus-example.yaml'
+$defs:
+  packageInfoStatus:
+    title: PackageInfoStatus
+    type: object
+    properties:
+      packageName:
+        description: Name of the package
+        type: string
+      status:
+        $ref: '../packageStatus/packageStatus.yaml#/$defs/packageStatus'
+      rundownId:
+        description: Id of the Rundown that a Piece (or AdLib) expecting this package belongs to
+        type: string
+      partId:
+        description: Id of the Part that a Piece (or AdLib) expecting this package belongs to. It could be an Id of a Part from the Active Playlist topic, or a Part not exposed otherwise by the LSG.
+        type: string
+      segmentId:
+        description: Id of the Segment that a Piece (or AdLib) expecting this package belongs to
+        type: string
+      pieceOrAdLibId:
+        description: Id of the Piece or AdLib that expects this package. It could be an Id of a Piece from the Active Pieces and Active Playlist topics, or an Id of an AdLib from the AdLibs topic. It could also be an Id of a Piece not exposed otherwise by the LSG, but still relevant, e.g. to summarize the status of packages within a specific Part/Segment.
+        type: string
+      thumbnailUrl:
+        description: URL where the thumbnail can be accessed
+        type: string
+      previewUrl:
+        description: URL where the preview can be accessed
+        type: string
+    required: [status, rundownId, pieceOrAdLibId]
+    additionalProperties: false
+    examples:
+      - $ref: './packageInfoStatus-example.yaml'
diff --git a/packages/live-status-gateway-api/api/refactor/components/packages/packageStatus/packageStatus.yaml b/packages/live-status-gateway-api/api/refactor/components/packages/packageStatus/packageStatus.yaml
@@ -1,21 +1,23 @@
-title: PackageStatus
-type: string
-description: |
-  Status:
-  * `unknown` - status not determined (yet)
-  * `ok` - no faults, can be played
-  * `source_broken` - the source is present, but should not be played due to a technical malfunction (file is broken, camera robotics failed, REMOTE input is just bars, etc.)
-  * `source_has_issues` - technically it can be played, but some issues with it were detected
-  * `source_missing` - the source (file, live input) is missing and cannot be played
-  * `source_not_ready` - can't be played for a non-technical reason (e.g. a placeholder clip with no content)
-  * `source_not_set` - missing a file path
-  * `source_unknown_state` - reported, but unrecognized state
-enum:
-  - unknown
-  - ok
-  - source_broken
-  - source_has_issues
-  - source_missing
-  - source_not_ready
-  - source_not_set
-  - source_unknown_state
+$defs:
+  packageStatus:
+    title: PackageStatus
+    type: string
+    description: |
+      Status:
+      * `unknown` - status not determined (yet)
+      * `ok` - no faults, can be played
+      * `source_broken` - the source is present, but should not be played due to a technical malfunction (file is broken, camera robotics failed, REMOTE input is just bars, etc.)
+      * `source_has_issues` - technically it can be played, but some issues with it were detected
+      * `source_missing` - the source (file, live input) is missing and cannot be played
+      * `source_not_ready` - can't be played for a non-technical reason (e.g. a placeholder clip with no content)
+      * `source_not_set` - missing a file path
+      * `source_unknown_state` - reported, but unrecognized state
+    enum:
+      - unknown
+      - ok
+      - source_broken
+      - source_has_issues
+      - source_missing
+      - source_not_ready
+      - source_not_set
+      - source_unknown_state
diff --git a/packages/live-status-gateway-api/api/refactor/components/packages/packagesEvent/packagesEvent.yaml b/packages/live-status-gateway-api/api/refactor/components/packages/packagesEvent/packagesEvent.yaml
@@ -13,7 +13,7 @@ properties:
     description: The Package statuses for this playlist
     type: array
     items:
-      $ref: '../packageInfoStatus/packageInfoStatus.yaml'
+      $ref: '../packageInfoStatus/packageInfoStatus.yaml#/$defs/packageInfoStatus'
 required: [event, rundownPlaylistId, packages]
 additionalProperties: false
 examples:
diff --git a/packages/live-status-gateway-api/api/refactor/components/subscriptions/events/subscribeEvent/subscribeEvent.yaml b/packages/live-status-gateway-api/api/refactor/components/subscriptions/events/subscribeEvent/subscribeEvent.yaml
@@ -4,9 +4,9 @@ $defs:
     title: SubscribeEvent
     properties:
       event:
-        $ref: '../../subscriptionEventName.yaml'
+        $ref: '../../subscriptionEventName.yaml#/$defs/subscriptionEventName'
       reqid:
-        $ref: '../../../connection/reqid/reqid.yaml'
+        $ref: '../../../connection/reqid/reqid.yaml#/$defs/reqid'
       subscription:
         $ref: '../../subscriptionRequestDetails/subscriptionRequestDetails.yaml#/$defs/subscriptionRequestDetails'
     required: [event, reqid, subscription]
diff --git a/packages/live-status-gateway-api/api/refactor/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusSuccess/subscriptionStatusSuccess.yaml b/packages/live-status-gateway-api/api/refactor/components/subscriptions/events/subscriptionStatusEvent/subscriptionStatusSuccess/subscriptionStatusSuccess.yaml
@@ -7,7 +7,7 @@ $defs:
         type: string
         const: subscriptionStatus
       reqid:
-        $ref: '../../../../connection/reqid/reqid.yaml'
+        $ref: '../../../../connection/reqid/reqid.yaml#/$defs/reqid'
       subscription:
         $ref: '../../../subscriptionDetails/subscriptionDetails.yaml#/$defs/subscriptionDetails'
         required: [name, status]
diff --git a/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionDetails/subscriptionDetails.yaml b/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionDetails/subscriptionDetails.yaml
@@ -4,9 +4,9 @@ $defs:
     title: SubscriptionDetails
     properties:
       name:
-        $ref: '../subscriptionName.yaml'
+        $ref: '../subscriptionName.yaml#/$defs/subscriptionName'
       status:
-        $ref: '../subscriptionStatusName.yaml'
+        $ref: '../subscriptionStatusName.yaml#/$defs/subscriptionStatusName'
     required: [name, status]
     additionalProperties: false
     examples:
diff --git a/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionEventName.yaml b/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionEventName.yaml
@@ -1,6 +1,8 @@
-type: string
-title: SubscriptionEventName
-description: Name of the event when subscribing or unsubscribing to topics.
-enum:
-  - subscribe
-  - unsubscribe
+$defs:
+  subscriptionEventName:
+    type: string
+    title: SubscriptionEventName
+    description: Name of the event when subscribing or unsubscribing to topics.
+    enum:
+      - subscribe
+      - unsubscribe
diff --git a/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionName.yaml b/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionName.yaml
@@ -1,11 +1,13 @@
-type: string
-title: SubscriptionName
-description: The name of the topic related to this status.
-enum:
-  - studio
-  - activePlaylist
-  - activePieces
-  - segments
-  - adLibs
-  - buckets
-  - packages
+$defs:
+  subscriptionName:
+    type: string
+    title: SubscriptionName
+    description: The name of the topic related to this status.
+    enum:
+      - studio
+      - activePlaylist
+      - activePieces
+      - segments
+      - adLibs
+      - buckets
+      - packages
diff --git a/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionStatusName.yaml b/packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionStatusName.yaml
@@ -1,6 +1,8 @@
-type: string
-title: SubscriptionStatus
-description: The current status of the subscription
-enum:
-  - subscribed
-  - unsubscribed
+$defs:
+  subscriptionStatusName:
+    type: string
+    title: SubscriptionStatus
+    description: The current status of the subscription
+    enum:
+      - subscribed
+      - unsubscribed
