From f136b7145fc9de028624c76a69d9f785661166b3 Mon Sep 17 00:00:00 2001 From: Udit Takkar <53316345+Udit-takkar@users.noreply.github.com> Date: Fri, 28 Nov 2025 01:47:40 +0530 Subject: [PATCH] chore: update transcript endpoint description (#25385) * chore: update transcript endpoint description * chore: update transcript endpoint description --- .../2024-08-13/controllers/bookings.controller.ts | 8 ++++++-- docs/api-reference/v2/openapi.json | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts b/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts index 1468e0e528..23a5f73c2b 100644 --- a/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts +++ b/apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts @@ -230,9 +230,13 @@ export class BookingsController_2024_08_13 { @UseGuards(BookingUidGuard) @ApiOperation({ summary: "Get Cal Video real time transcript download links for the booking", - description: `Fetches all the transcripts download links for the booking \`:bookingUid\` + description: `Fetches all the transcript download links for the booking \`:bookingUid\` - Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint. + + Transcripts are generated when clicking "Transcribe" during a Cal Video meeting. Download links are valid for 1 hour only - make a new request to generate fresh links after expiration. + + Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint. + `, }) async getBookingTranscripts(@Param("bookingUid") bookingUid: string): Promise { diff --git a/docs/api-reference/v2/openapi.json b/docs/api-reference/v2/openapi.json index e21aee3668..6e2edd1453 100644 --- a/docs/api-reference/v2/openapi.json +++ b/docs/api-reference/v2/openapi.json @@ -9943,7 +9943,7 @@ "get": { "operationId": "BookingsController_2024_08_13_getBookingTranscripts", "summary": "Get Cal Video real time transcript download links for the booking", - "description": "Fetches all the transcripts download links for the booking `:bookingUid`\n\n Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.\n ", + "description": "Fetches all the transcript download links for the booking `:bookingUid`\n\n \n Transcripts are generated when clicking \"Transcribe\" during a Cal Video meeting. Download links are valid for 1 hour only - make a new request to generate fresh links after expiration.\n\n Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.\n \n ", "parameters": [ { "name": "cal-api-version",