feat: add the ability to create rundowns without specifying a playlist

Author: justandras

meteor/server/api/rest/v1/ingest.ts

@@ -456,11 +456,11 @@ class IngestServerAPI implements IngestRestAPI {
 		_connection: Meteor.Connection,
 		_event: string,
 		studioId: StudioId,
-		playlistId: string,
+		playlistId: string | undefined,
 		ingestRundown: RestApiIngestRundown
 	): Promise<ClientAPI.ClientResponse<void>> {
 		check(studioId, String)
-		check(playlistId, String)
+		if (playlistId !== undefined) check(playlistId, String)
 		check(ingestRundown, Object)
 
 		const studio = await this.findStudio(studioId)
@@ -488,7 +488,8 @@ class IngestServerAPI implements IngestRestAPI {
 
 		await runIngestOperation(studio._id, IngestJobs.UpdateRundown, {
 			rundownExternalId: ingestRundown.externalId,
-			ingestRundown: { ...ingestRundown, playlistExternalId: playlistId },
+			ingestRundown:
+				playlistId !== undefined ? { ...ingestRundown, playlistExternalId: playlistId } : ingestRundown,
 			isCreateAction: true,
 			rundownSource: {
 				type: 'restApi',
@@ -1249,6 +1250,26 @@ export function registerRoutes(registerRoute: APIRegisterHook<IngestRestAPI>): v
 	)
 
 	// Create rundown
+	registerRoute<{ studioId: string }, never, void>(
+		'post',
+		'/ingest/:studioId/rundowns',
+		new Map(),
+		ingestAPIFactory,
+		async (serverAPI, connection, event, params, body) => {
+			logger.info(`INGEST API POST: Rundowns (studio-scoped)`)
+
+			const studioId = protectString<StudioId>(params.studioId)
+			check(studioId, String)
+
+			const ingestRundown = body as RestApiIngestRundown
+			if (!ingestRundown) throw new Meteor.Error(400, 'Upload rundown: Missing request body')
+			if (typeof ingestRundown !== 'object') throw new Meteor.Error(400, 'Upload rundown: Invalid request body')
+
+			return await serverAPI.postRundown(connection, event, studioId, undefined, ingestRundown)
+		}
+	)
+
+	// Create rundown in a playlist
 	registerRoute<{ studioId: string; playlistId: string; rundownId: string }, never, void>(
 		'post',
 		'/ingest/:studioId/playlists/:playlistId/rundowns',

meteor/server/lib/rest/v1/ingest.ts

@@ -60,7 +60,7 @@ export interface IngestRestAPI {
 		_connection: Meteor.Connection,
 		_event: string,
 		studioId: StudioId,
-		playlistId: string,
+		playlistId: string | undefined,
 		ingestRundown: RestApiIngestRundown
 	): Promise<ClientAPI.ClientResponse<void>>
 

packages/openapi/api/actions.yaml

@@ -118,6 +118,8 @@ paths:
     $ref: 'definitions/ingest.yaml#/resources/playlists'
   /ingest/{studioId}/playlists/{playlistId}:
     $ref: 'definitions/ingest.yaml#/resources/playlist'
+  /ingest/{studioId}/rundowns:
+    $ref: 'definitions/ingest.yaml#/resources/rundownsInStudio'
   /ingest/{studioId}/playlists/{playlistId}/rundowns:
     $ref: 'definitions/ingest.yaml#/resources/rundowns'
   /ingest/{studioId}/playlists/{playlistId}/rundowns/{rundownId}:

packages/openapi/api/definitions/ingest.yaml

@@ -212,6 +212,31 @@ resources:
           description: Request accepted.
         404:
           $ref: '#/components/responses/idNotFound'
+  rundownsInStudio:
+    post:
+      operationId: postRundownInStudio
+      summary: Creates a Rundown in a specified Studio. For all other rundown operations use the /ingest/{studioId}/playlists/{playlistId}/rundowns routes.
+      tags:
+        - ingest
+      parameters:
+        - name: studioId
+          in: path
+          description: ID of the studio that is performing ingest operation.
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: Rundown data to ingest. Must include playlistExternalId.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/rundown'
+      responses:
+        202:
+          description: Request has been accepted.
+        400:
+          description: Bad request.
   rundown:
     get:
       operationId: getRundown
@@ -1104,6 +1129,9 @@ components:
         payload:
           type: object
           additionalProperties: true
+        playlistExternalId:
+          type: string
+          example: playlist1
       required:
         - externalId
         - name

packages/openapi/src/__tests__/ingest.spec.ts

@@ -143,6 +143,15 @@ describe('Ingest API', () => {
 		expect(result).toBe(undefined)
 	})
 
+	test('Can create rundown (studio-scoped)', async () => {
+		const result = await ingestApi.postRundown({
+			studioId,
+			playlistId: undefined,
+			rundown,
+		})
+		expect(result).toBe(undefined)
+	})
+
 	test('Can update multiple rundowns', async () => {
 		const result = await ingestApi.putRundowns({ studioId, playlistId: playlistIds[0], rundown: [rundown] })
 		expect(result).toBe(undefined)