refactor: added ApiPropertyOptional decorator for optional fields in api for better documentation (#18208)

* update decorators 1

* update decorators 2

* update decorators 3

* update decorators 4

* update decorators 4

* update decorators 6

* update decorators 7

* added documentation,json and openapi.json

* implemented feedback

* remove default values from update dto's

* update

* removed default from redirectUris
This commit is contained in:
Somay Chauhan authored and GitHub committed 2024-12-17 10:29:07 +00:00
1 parent 5fad7c9478
commit a613c975d3
68 files changed
+1506 -614

No files matched your search

@@ -1,17 +1,21 @@
import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
import { IsNotEmpty, IsOptional, IsString } from "class-validator";
export class AssignOrganizationAttributeOptionToUserInput {
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiPropertyOptional()
readonly value?: string;
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiPropertyOptional()
readonly attributeOptionId?: string;
@IsNotEmpty()
@IsString()
@ApiProperty()
readonly attributeId!: string;
}
@@ -1,4 +1,5 @@
import { CreateOrganizationAttributeOptionInput } from "@/modules/organizations/inputs/attributes/options/create-organization-attribute-option.input";
import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
import { AttributeType } from "@prisma/client";
import { Type } from "class-transformer";
import {
@@ -14,22 +15,27 @@ import {
export class CreateOrganizationAttributeInput {
@IsString()
@IsNotEmpty()
@ApiProperty()
readonly name!: string;
@IsString()
@IsNotEmpty()
@ApiProperty()
readonly slug!: string;
@IsEnum(AttributeType)
@IsNotEmpty()
@ApiProperty({ enum: AttributeType })
readonly type!: AttributeType;
@IsArray()
@ValidateNested()
@ValidateNested({ each: true })
@Type(() => CreateOrganizationAttributeOptionInput)
@ApiProperty({ type: [CreateOrganizationAttributeOptionInput] })
readonly options!: CreateOrganizationAttributeOptionInput[];
@IsBoolean()
@IsOptional()
@ApiPropertyOptional()
readonly enabled?: boolean;
}
@@ -1,11 +1,14 @@
import { IsNotEmpty, IsOptional, IsString } from "class-validator";
import { ApiPropertyOptional } from "@nestjs/swagger";
import { IsString, IsOptional } from "class-validator";
export class UpdateOrganizationAttributeOptionInput {
@IsString()
@IsOptional()
@ApiPropertyOptional()
readonly value?: string;
@IsString()
@IsOptional()
@ApiPropertyOptional()
readonly slug?: string;
}
@@ -1,20 +1,25 @@
import { ApiPropertyOptional } from "@nestjs/swagger";
import { AttributeType } from "@prisma/client";
import { IsBoolean, IsEnum, IsOptional, IsString } from "class-validator";
export class UpdateOrganizationAttributeInput {
@IsString()
@IsOptional()
@ApiPropertyOptional()
readonly name?: string;
@IsString()
@IsOptional()
@ApiPropertyOptional()
readonly slug?: string;
@IsEnum(AttributeType)
@IsOptional()
@ApiPropertyOptional({ enum: AttributeType })
readonly type?: AttributeType;
@IsBoolean()
@IsOptional()
@ApiPropertyOptional()
readonly enabled?: boolean;
}
@@ -1,13 +1,15 @@
import { ApiProperty } from "@nestjs/swagger";
import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
import { MembershipRole } from "@prisma/client";
import { IsBoolean, IsOptional, IsEnum, IsInt } from "class-validator";
export class CreateOrgMembershipDto {
@IsInt()
@ApiProperty()
readonly userId!: number;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional({ type: Boolean, default: false })
readonly accepted?: boolean = false;
@IsEnum(MembershipRole)
@@ -16,5 +18,6 @@ export class CreateOrgMembershipDto {
@IsOptional()
@IsBoolean()
@ApiPropertyOptional({ type: Boolean, default: false })
readonly disableImpersonation?: boolean = false;
}
@@ -1,12 +1,14 @@
import { ApiProperty } from "@nestjs/swagger";
import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
import { MembershipRole } from "@prisma/client";
import { IsBoolean, IsOptional, IsEnum, IsInt } from "class-validator";
export class CreateOrgTeamMembershipDto {
@IsInt()
@ApiProperty()
readonly userId!: number;
@IsOptional()
@ApiPropertyOptional({ type: Boolean, default: false })
@IsBoolean()
readonly accepted?: boolean = false;
@@ -15,6 +17,7 @@ export class CreateOrgTeamMembershipDto {
readonly role: MembershipRole = MembershipRole.MEMBER;
@IsOptional()
@ApiPropertyOptional({ type: Boolean, default: false })
@IsBoolean()
readonly disableImpersonation?: boolean = false;
}
@@ -9,7 +9,7 @@ export class CreateOrgTeamDto {
@IsOptional()
@IsString()
@ApiPropertyOptional({ type: String, description: "Team slug", example: "caltel", required: false })
@ApiPropertyOptional({ type: String, description: "Team slug", example: "caltel" })
readonly slug?: string;
@IsOptional()
@@ -18,52 +18,62 @@ export class CreateOrgTeamDto {
type: String,
example: "https://i.cal.com/api/avatar/b0b58752-68ad-4c0d-8024-4fa382a77752.png",
description: `URL of the teams logo image`,
required: false,
})
readonly logoUrl?: string;
@IsOptional()
@IsUrl()
@ApiPropertyOptional()
readonly calVideoLogo?: string;
@IsOptional()
@IsUrl()
@ApiPropertyOptional()
readonly appLogo?: string;
@IsOptional()
@IsUrl()
@ApiPropertyOptional()
readonly appIconLogo?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly bio?: string;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional({ type: Boolean, default: false })
readonly hideBranding?: boolean = false;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional()
readonly isPrivate?: boolean;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional()
readonly hideBookATeamMember?: boolean;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly metadata?: string; // Assuming metadata is a JSON string. Adjust accordingly if it's a nested object.
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly theme?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly brandColor?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly darkBrandColor?: string;
@IsOptional()
@@ -78,6 +88,7 @@ export class CreateOrgTeamDto {
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly timeFormat?: number;
@IsOptional()
@@ -96,12 +107,12 @@ export class CreateOrgTeamDto {
@ApiPropertyOptional({
type: String,
example: "Monday",
required: false,
default: "Sunday",
})
readonly weekStart?: string = "Sunday";
@IsOptional()
@IsBoolean()
@ApiPropertyOptional({ type: Boolean, default: true })
readonly autoAcceptCreator?: boolean = true;
}
@@ -1,17 +1,21 @@
import { CreateUserInput } from "@/modules/users/inputs/create-user.input";
import { ApiPropertyOptional } from "@nestjs/swagger";
import { MembershipRole } from "@prisma/client";
import { IsString, IsOptional, IsBoolean, IsEnum } from "class-validator";
export class CreateOrganizationUserInput extends CreateUserInput {
@IsOptional()
@IsString()
@ApiPropertyOptional({ type: String, default: "en" })
locale = "en";
@IsOptional()
@IsEnum(MembershipRole)
@ApiPropertyOptional({ enum: MembershipRole, default: MembershipRole.MEMBER })
organizationRole: MembershipRole = MembershipRole.MEMBER;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional({ type: Boolean, default: true })
autoAccept = true;
}
@@ -1,17 +1,20 @@
import { ApiProperty } from "@nestjs/swagger";
import { ApiPropertyOptional } from "@nestjs/swagger";
import { MembershipRole } from "@prisma/client";
import { IsBoolean, IsOptional, IsEnum } from "class-validator";
export class UpdateOrgMembershipDto {
@IsOptional()
@IsBoolean()
readonly accepted?: boolean = false;
@ApiPropertyOptional()
readonly accepted?: boolean;
@IsOptional()
@IsEnum(MembershipRole)
@ApiProperty({ enum: ["MEMBER", "OWNER", "ADMIN"] })
readonly role?: MembershipRole = MembershipRole.MEMBER;
@ApiPropertyOptional({ enum: ["MEMBER", "OWNER", "ADMIN"] })
readonly role?: MembershipRole;
@IsOptional()
@IsBoolean()
readonly disableImpersonation?: boolean = false;
@ApiPropertyOptional()
readonly disableImpersonation?: boolean;
}
@@ -1,17 +1,20 @@
import { ApiProperty } from "@nestjs/swagger";
import { ApiPropertyOptional } from "@nestjs/swagger";
import { MembershipRole } from "@prisma/client";
import { IsBoolean, IsOptional, IsEnum } from "class-validator";
export class UpdateOrgTeamMembershipDto {
@IsOptional()
@IsBoolean()
readonly accepted?: boolean = false;
@ApiPropertyOptional()
readonly accepted?: boolean;
@IsOptional()
@IsEnum(MembershipRole)
@ApiProperty({ enum: ["MEMBER", "OWNER", "ADMIN"] })
readonly role?: MembershipRole = MembershipRole.MEMBER;
@ApiPropertyOptional({ enum: ["MEMBER", "OWNER", "ADMIN"] })
readonly role?: MembershipRole;
@IsOptional()
@IsBoolean()
readonly disableImpersonation?: boolean = false;
@ApiPropertyOptional()
readonly disableImpersonation?: boolean;
}
@@ -4,12 +4,12 @@ import { IsBoolean, IsOptional, IsString, IsUrl, Length } from "class-validator"
export class UpdateOrgTeamDto {
@IsString()
@Length(1)
@ApiPropertyOptional({ description: "Name of the team", example: "CalTeam", required: false })
@ApiPropertyOptional({ description: "Name of the team", example: "CalTeam" })
readonly name?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional({ type: String, description: "Team slug", example: "caltel", required: false })
@ApiPropertyOptional({ type: String, description: "Team slug", example: "caltel" })
readonly slug?: string;
@IsOptional()
@@ -18,52 +18,62 @@ export class UpdateOrgTeamDto {
type: String,
example: "https://i.cal.com/api/avatar/b0b58752-68ad-4c0d-8024-4fa382a77752.png",
description: `URL of the teams logo image`,
required: false,
})
readonly logoUrl?: string;
@IsOptional()
@IsUrl()
@ApiPropertyOptional()
readonly calVideoLogo?: string;
@IsOptional()
@IsUrl()
@ApiPropertyOptional()
readonly appLogo?: string;
@IsOptional()
@IsUrl()
@ApiPropertyOptional()
readonly appIconLogo?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly bio?: string;
@IsOptional()
@IsBoolean()
readonly hideBranding?: boolean = false;
@ApiPropertyOptional()
readonly hideBranding?: boolean;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional()
readonly isPrivate?: boolean;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional()
readonly hideBookATeamMember?: boolean;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly metadata?: string; // Assuming metadata is a JSON string. Adjust accordingly if it's a nested object.
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly theme?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly brandColor?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly darkBrandColor?: string;
@IsOptional()
@@ -72,12 +82,12 @@ export class UpdateOrgTeamDto {
type: String,
example: "https://i.cal.com/api/avatar/949be534-7a88-4185-967c-c020b0c0bef3.png",
description: `URL of the teams banner image which is shown on booker`,
required: false,
})
readonly bannerUrl?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly timeFormat?: number;
@IsOptional()
@@ -86,26 +96,24 @@ export class UpdateOrgTeamDto {
type: String,
example: "America/New_York",
description: `Timezone is used to create teams's default schedule from Monday to Friday from 9AM to 5PM. It will default to Europe/London if not passed.`,
required: false,
default: "Europe/London",
})
readonly timeZone?: string = "Europe/London";
readonly timeZone?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional({
type: String,
example: "Monday",
required: false,
default: "Sunday",
})
readonly weekStart?: string = "Sunday";
readonly weekStart?: string;
@IsOptional()
@IsString()
@ApiPropertyOptional()
readonly bookingLimits?: string;
@IsOptional()
@IsBoolean()
@ApiPropertyOptional()
readonly includeManagedEventsInLimits?: boolean;
}