Skip to content

Commit a6b98bd

Browse files
authored
docs: expand Google Calendar event ID description with API endpoint references (calcom#21857)
1 parent 34d4f39 commit a6b98bd

3 files changed

Lines changed: 4 additions & 3 deletions

File tree

apps/api/v2/src/modules/cal-unified-calendars/controllers/cal-unified-calendars.controller.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ export class CalUnifiedCalendarsController {
2525
})
2626
@ApiParam({
2727
name: "eventUid",
28-
description: "The Google Calendar event ID",
28+
description:
29+
"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",
2930
type: String,
3031
})
3132
@Get("/:calendar/event/:eventUid")

apps/api/v2/swagger/documentation.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8142,7 +8142,7 @@
81428142
"name": "eventUid",
81438143
"required": true,
81448144
"in": "path",
8145-
"description": "The Google Calendar event ID",
8145+
"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",
81468146
"schema": {
81478147
"type": "string"
81488148
}

docs/api-reference/v2/openapi.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7792,7 +7792,7 @@
77927792
"name": "eventUid",
77937793
"required": true,
77947794
"in": "path",
7795-
"description": "The Google Calendar event ID",
7795+
"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",
77967796
"schema": {
77977797
"type": "string"
77987798
}

0 commit comments

Comments
 (0)