Skip to content

Commit f136b71

Browse files
authored
chore: update transcript endpoint description (calcom#25385)
* chore: update transcript endpoint description * chore: update transcript endpoint description
1 parent 179ace2 commit f136b71

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

apps/api/v2/src/ee/bookings/2024-08-13/controllers/bookings.controller.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,9 +230,13 @@ export class BookingsController_2024_08_13 {
230230
@UseGuards(BookingUidGuard)
231231
@ApiOperation({
232232
summary: "Get Cal Video real time transcript download links for the booking",
233-
description: `Fetches all the transcripts download links for the booking \`:bookingUid\`
233+
description: `Fetches all the transcript download links for the booking \`:bookingUid\`
234234
235-
<Note>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.</Note>
235+
<Note>
236+
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.
237+
238+
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.
239+
</Note>
236240
`,
237241
})
238242
async getBookingTranscripts(@Param("bookingUid") bookingUid: string): Promise<GetBookingTranscriptsOutput> {

docs/api-reference/v2/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9943,7 +9943,7 @@
99439943
"get": {
99449944
"operationId": "BookingsController_2024_08_13_getBookingTranscripts",
99459945
"summary": "Get Cal Video real time transcript download links for the booking",
9946-
"description": "Fetches all the transcripts download links for the booking `:bookingUid`\n\n <Note>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.</Note>\n ",
9946+
"description": "Fetches all the transcript download links for the booking `:bookingUid`\n\n <Note>\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 </Note>\n ",
99479947
"parameters": [
99489948
{
99499949
"name": "cal-api-version",

0 commit comments

Comments
 (0)