refactor: standardize v2 docs (#22299)

This commit is contained in:
Lauris Skraucis authored and GitHub committed 2025-07-07 14:47:31 +00:00
1 parent 585a12fa48
commit 6091208f8a
9 files changed
+1148 -3582

No files matched your search

@@ -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,
@@ -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(
@@ -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")