Skip to content

Commit 6cb24a9

Browse files
committed
chore(LSG): update packages topic docs
1 parent 3edfcd8 commit 6cb24a9

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ components:
127127
$ref: './schemas/adLibs.yaml#/$defs/adLibs'
128128
packages:
129129
name: packages
130+
messageId: packages
130131
description: Status of Packages expected by Pieces
131132
payload:
132133
$ref: './schemas/packages.yaml#/$defs/packages'

packages/live-status-gateway/api/schemas/activePlaylist.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $defs:
1414
description: User-presentable name for the active playlist
1515
type: string
1616
rundownIds:
17-
description: The set of rundownIds in the active playlist
17+
description: The set of rundownIds in the active playlist, in order
1818
type: array
1919
items:
2020
type: string

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,28 +34,28 @@ $defs:
3434
description: Status code
3535
type: number
3636
rundownId:
37-
description: Id of the Rundown that expects this package
37+
description: Id of the Rundown that a Piece (or AdLib) expecting this package belongs to
3838
type: string
3939
partId:
40-
description: Id of the Part that expects this package
40+
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.
4141
type: string
4242
segmentId:
43-
description: Id of the Segment that expects this package
43+
description: Id of the Segment that a Piece (or AdLib) expecting this package belongs to
4444
type: string
45-
pieceId:
46-
description: Id of the Piece that expects this package
45+
pieceOrAdLibId:
46+
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.
4747
type: string
4848
thumbnailUrl:
4949
description: URL where the thumbnail can be accessed
5050
type: string
5151
previewUrl:
5252
description: URL where the preview can be accessed
5353
type: string
54-
required: [statusCode, rundownId, pieceId]
54+
required: [statusCode, rundownId, pieceOrAdLibId]
5555
additionalProperties: false
5656
examples:
5757
- packageName: 'MV000123.mxf'
5858
statusCode: 0
5959
rundownId: 'y9HauyWkcxQS3XaAOsW40BRLLsI_'
60-
pieceId: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
60+
pieceOrAdLibId: 'C6K_yIMuGFUk8X_L9A9_jRT6aq4_'
6161
thumbnailUrl: 'https://package-manager.local/package/MV000123.mov_thumbnail.jpg'

0 commit comments

Comments
 (0)