Skip to content

Commit

Permalink
feat: changes ingest/playlists response
Browse files Browse the repository at this point in the history
Lists internal playlistId and also lists all Rundowns with their externalIds
  • Loading branch information
jesperstarkar committed Nov 15, 2023
1 parent a64c090 commit 610d7e9
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions packages/openapi/api/definitions/ingest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ resources:
summary: Gets ingest data for all Playlists in Sofie.
responses:
200:
description: Command successfully handled - returns an array of Playlist Ids.
description: Command successfully handled - returns an array of Playlists with their playlistIds and list of Rundow.
content:
application/json:
schema:
Expand Down Expand Up @@ -1177,11 +1177,17 @@ components:
ingestPlaylistItem:
type: object
properties:
externalId:
playlistId:
type: string
description: The Id provided by a system external to Sofie that can be used by the same external system to identify this Playlist.
description: The Id provided by Sofie. This Id will be used for /playlist commands for controlling playlist activations, playback etc.
rundowns:
type: array
description: All rundowns in a Playlist.
items:
$ref: '#/components/schemas/ingestRundownItem'
required:
- externalId
- playlistId
- rundowns
additionalProperties: false
ingestRundownItem:
type: object
Expand Down

0 comments on commit 610d7e9

Please sign in to comment.