From a6b98bd35d4eba2c235e55c647aba89fe7903b94 Mon Sep 17 00:00:00 2001 From: Somay Chauhan Date: Tue, 17 Jun 2025 10:32:50 +0530 Subject: [PATCH] docs: expand Google Calendar event ID description with API endpoint references (#21857) --- .../controllers/cal-unified-calendars.controller.ts | 3 ++- apps/api/v2/swagger/documentation.json | 2 +- docs/api-reference/v2/openapi.json | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/apps/api/v2/src/modules/cal-unified-calendars/controllers/cal-unified-calendars.controller.ts b/apps/api/v2/src/modules/cal-unified-calendars/controllers/cal-unified-calendars.controller.ts index 6f11276764..0e3b66be01 100644 --- a/apps/api/v2/src/modules/cal-unified-calendars/controllers/cal-unified-calendars.controller.ts +++ b/apps/api/v2/src/modules/cal-unified-calendars/controllers/cal-unified-calendars.controller.ts @@ -25,7 +25,8 @@ export class CalUnifiedCalendarsController { }) @ApiParam({ name: "eventUid", - description: "The Google Calendar event ID", + description: + "The Google Calendar event ID. You can retrieve this by getting booking references from the following endpoints:\n\n- For team events: https://cal.com/docs/api-reference/v2/orgs-teams-bookings/get-booking-references-for-a-booking\n\n- For user events: https://cal.com/docs/api-reference/v2/bookings/get-booking-references-for-a-booking", type: String, }) @Get("/:calendar/event/:eventUid") diff --git a/apps/api/v2/swagger/documentation.json b/apps/api/v2/swagger/documentation.json index 42734465b9..ea2ed740b6 100644 --- a/apps/api/v2/swagger/documentation.json +++ b/apps/api/v2/swagger/documentation.json @@ -8142,7 +8142,7 @@ "name": "eventUid", "required": true, "in": "path", - "description": "The Google Calendar event ID", + "description": "The Google Calendar event ID. You can retrieve this by getting booking references from the following endpoints:\n\n- For team events: https://cal.com/docs/api-reference/v2/orgs-teams-bookings/get-booking-references-for-a-booking\n\n- For user events: https://cal.com/docs/api-reference/v2/bookings/get-booking-references-for-a-booking", "schema": { "type": "string" } diff --git a/docs/api-reference/v2/openapi.json b/docs/api-reference/v2/openapi.json index f1781d79ea..89e56c494c 100644 --- a/docs/api-reference/v2/openapi.json +++ b/docs/api-reference/v2/openapi.json @@ -7792,7 +7792,7 @@ "name": "eventUid", "required": true, "in": "path", - "description": "The Google Calendar event ID", + "description": "The Google Calendar event ID. You can retrieve this by getting booking references from the following endpoints:\n\n- For team events: https://cal.com/docs/api-reference/v2/orgs-teams-bookings/get-booking-references-for-a-booking\n\n- For user events: https://cal.com/docs/api-reference/v2/bookings/get-booking-references-for-a-booking", "schema": { "type": "string" }