vynte-infra/calendar
2
0
Fork 0
Code Issues Pull Requests Actions 2.3k Packages Projects Releases Wiki Activity

refactor: standardize v2 docs (#22299)

Browse Source
This commit is contained in:
Lauris Skraucis
2025-07-07 14:47:31 +00:00
committed by GitHub
parent 585a12fa48
commit 6091208f8a
9 changed files with 1148 additions and 3582 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/api/v2/src/modules/cal-unified-calendars/controllers/cal-unified-calendars.controller.ts
+1 -1
View File
@@ -34,7 +34,7 @@ export class CalUnifiedCalendarsController {
@UseGuards(ApiAuthGuard, PermissionsGuard)
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@ApiOperation({
summary: "Get meeting Details from calendar",
summary: "Get meeting details from calendar",
description: "Returns detailed information about a meeting including attendance metrics",
})
async getCalendarEventDetails(
apps/api/v2/src/modules/organizations/stripe/organizations-stripe.controller.ts
+1 -1
View File
@@ -53,7 +53,7 @@ export type OAuthCallbackState = {
path: "/v2/organizations/:orgId/teams/:teamId/stripe",
version: API_VERSIONS_VALUES,
})
@DocsTags("Organizations/Teams Stripe")
@DocsTags("Orgs / Teams / Stripe")
export class OrganizationsStripeController {
constructor(
private readonly organizationsStripeService: OrganizationsStripeService,
apps/api/v2/src/modules/organizations/teams/bookings/organizations-teams-bookings.controller.ts
+1 -1
View File
@@ -80,7 +80,7 @@ export class OrganizationsTeamsBookingsController {
IsAdminAPIEnabledGuard
)
@ApiOperation({
summary: "Get 'Booking References' for a booking",
summary: "Get booking references",
})
@HttpCode(HttpStatus.OK)
async getBookingReferences(
apps/api/v2/src/modules/organizations/teams/verified-resources/org-teams-verified-resources.controller.ts
+10 -10
View File
@@ -52,8 +52,8 @@ import { SkipTakePagination } from "@calcom/platform-types";
export class OrgTeamsVerifiedResourcesController {
constructor(private readonly verifiedResourcesService: VerifiedResourcesService) {}
@ApiOperation({
summary: "Request Email Verification Code",
description: `Sends a verification code to the email.`,
summary: "Request email verification code",
description: `Sends a verification code to the email`,
})
@Roles("TEAM_ADMIN")
@Throttle({
@@ -82,8 +82,8 @@ export class OrgTeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Request Phone Number Verification Code",
description: `Sends a verification code to the phone number.`,
summary: "Request phone number verification code",
description: `Sends a verification code to the phone number`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
@@ -108,7 +108,7 @@ export class OrgTeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Verify an email for an org team.",
summary: "Verify an email for an org team",
description: `Use code to verify an email`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@@ -134,7 +134,7 @@ export class OrgTeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Verify a phone number for an org team.",
summary: "Verify a phone number for an org team",
description: `Use code to verify a phone number`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@@ -166,7 +166,7 @@ export class OrgTeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get list of verified emails of an org team.",
summary: "Get list of verified emails of an org team",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
@@ -189,7 +189,7 @@ export class OrgTeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get list of verified phone numbers of an org team.",
summary: "Get list of verified phone numbers of an org team",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@PlatformPlan("ESSENTIALS")
@@ -214,7 +214,7 @@ export class OrgTeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get verified email of an org team by id.",
summary: "Get verified email of an org team by id",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
@@ -233,7 +233,7 @@ export class OrgTeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get verified phone number of an org team by id.",
summary: "Get verified phone number of an org team by id",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
apps/api/v2/src/modules/teams/verified-resources/teams-verified-resources.controller.ts
+10 -10
View File
@@ -47,8 +47,8 @@ import { SkipTakePagination } from "@calcom/platform-types";
export class TeamsVerifiedResourcesController {
constructor(private readonly verifiedResourcesService: VerifiedResourcesService) {}
@ApiOperation({
summary: "Request Email Verification Code",
description: `Sends a verification code to the Email.`,
summary: "Request email verification code",
description: `Sends a verification code to the Email`,
})
@Roles("TEAM_ADMIN")
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@@ -71,8 +71,8 @@ export class TeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Request Phone Number Verification Code",
description: `Sends a verification code to the phone number.`,
summary: "Request phone number verification code",
description: `Sends a verification code to the phone number`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
@@ -92,7 +92,7 @@ export class TeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Verify an email for a team.",
summary: "Verify an email for a team",
description: `Use code to verify an email`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@@ -117,7 +117,7 @@ export class TeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Verify a phone number for an org team.",
summary: "Verify a phone number for an org team",
description: `Use code to verify a phone number`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@@ -143,7 +143,7 @@ export class TeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get list of verified emails of a team.",
summary: "Get list of verified emails of a team",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
@@ -165,7 +165,7 @@ export class TeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get list of verified phone numbers of a team.",
summary: "Get list of verified phone numbers of a team",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Get("/phones")
@@ -189,7 +189,7 @@ export class TeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get verified email of a team by id.",
summary: "Get verified email of a team by id",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
@@ -207,7 +207,7 @@ export class TeamsVerifiedResourcesController {
}
@ApiOperation({
summary: "Get verified phone number of a team by id.",
summary: "Get verified phone number of a team by id",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Roles("TEAM_ADMIN")
apps/api/v2/src/modules/verified-resources/controllers/users-verified-resources.controller.ts
+10 -10
View File
@@ -34,8 +34,8 @@ import { SkipTakePagination } from "@calcom/platform-types";
export class UserVerifiedResourcesController {
constructor(private readonly verifiedResourcesService: VerifiedResourcesService) {}
@ApiOperation({
summary: "Request Email Verification Code",
description: `Sends a verification code to the email.`,
summary: "Request email verification code",
description: `Sends a verification code to the email`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Post("/emails/verification-code/request")
@@ -57,8 +57,8 @@ export class UserVerifiedResourcesController {
}
@ApiOperation({
summary: "Request Phone Number Verification Code",
description: `Sends a verification code to the phone number.`,
summary: "Request phone number verification code",
description: `Sends a verification code to the phone number`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Post("/phones/verification-code/request")
@@ -77,7 +77,7 @@ export class UserVerifiedResourcesController {
}
@ApiOperation({
summary: "Verify an email.",
summary: "Verify an email",
description: `Use code to verify an email`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@@ -96,7 +96,7 @@ export class UserVerifiedResourcesController {
}
@ApiOperation({
summary: "Verify a phone number.",
summary: "Verify a phone number",
description: `Use code to verify a phone number`,
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@@ -114,7 +114,7 @@ export class UserVerifiedResourcesController {
}
@ApiOperation({
summary: "Get list of verified emails.",
summary: "Get list of verified emails",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Get("/emails")
@@ -135,7 +135,7 @@ export class UserVerifiedResourcesController {
}
@ApiOperation({
summary: "Get list of verified phone numbers.",
summary: "Get list of verified phone numbers",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Get("/phones")
@@ -158,7 +158,7 @@ export class UserVerifiedResourcesController {
}
@ApiOperation({
summary: "Get verified email by id.",
summary: "Get verified email by id",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Get("/emails/:id")
@@ -175,7 +175,7 @@ export class UserVerifiedResourcesController {
}
@ApiOperation({
summary: "Get verified phone number by id.",
summary: "Get verified phone number by id",
})
@ApiHeader(API_KEY_OR_ACCESS_TOKEN_HEADER)
@Get("/phones/:id")