fix: correct @ApiProperty types in verified resources outputs (#28340)

* fix(docs): corrects output response type for verified resources endpoints

* fix: udpate oasdiff-err-ignore.txt
This commit is contained in:
Romit
2026-03-09 22:09:09 -03:00
committed by GitHub
parent d6741a1e2b
commit c8e1b4e66d
4 changed files with 291 additions and 131 deletions
+109 -121
View File
@@ -33297,129 +33297,27 @@
},
"required": ["email", "code"]
},
"WorkingHours": {
"type": "object",
"properties": {
"days": {
"type": "array",
"items": {
"type": "number"
}
},
"startTime": {
"type": "number"
},
"endTime": {
"type": "number"
},
"userId": {
"type": "number",
"nullable": true
}
},
"required": ["days", "startTime", "endTime"]
},
"AvailabilityModel": {
"UserVerifiedEmailOutputData": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"userId": {
"type": "number",
"nullable": true
"description": "The unique identifier for the verified email.",
"example": 789
},
"eventTypeId": {
"type": "number",
"nullable": true
},
"days": {
"type": "array",
"items": {
"type": "number"
}
},
"startTime": {
"format": "date-time",
"type": "string"
},
"endTime": {
"format": "date-time",
"type": "string"
},
"date": {
"format": "date-time",
"email": {
"type": "string",
"nullable": true
"description": "The verified email address.",
"example": "user@example.com",
"format": "email"
},
"scheduleId": {
"userId": {
"type": "number",
"nullable": true
"description": "The ID of the associated user, if applicable.",
"example": 45
}
},
"required": ["id", "days", "startTime", "endTime"]
},
"ScheduleOutput": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"isManaged": {
"type": "boolean"
},
"workingHours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkingHours"
}
},
"schedule": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailabilityModel"
}
},
"availability": {
"items": {
"type": "array"
},
"type": "array"
},
"timeZone": {
"type": "string"
},
"dateOverrides": {
"type": "array",
"items": {
"type": "object"
}
},
"isDefault": {
"type": "boolean"
},
"isLastSchedule": {
"type": "boolean"
},
"readOnly": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"isManaged",
"workingHours",
"schedule",
"availability",
"timeZone",
"isDefault",
"isLastSchedule",
"readOnly"
]
"required": ["id", "email", "userId"]
},
"UserVerifiedEmailOutput": {
"type": "object",
@@ -33430,7 +33328,7 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"$ref": "#/components/schemas/UserVerifiedEmailOutputData"
}
},
"required": ["status", "data"]
@@ -33451,6 +33349,28 @@
},
"required": ["phone", "code"]
},
"UserVerifiedPhoneOutputData": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The unique identifier for the verified email.",
"example": 789
},
"phoneNumber": {
"type": "string",
"description": "The verified phone number.",
"example": "+37255556666",
"format": "phone"
},
"userId": {
"type": "number",
"description": "The ID of the associated user, if applicable.",
"example": 45
}
},
"required": ["id", "phoneNumber", "userId"]
},
"UserVerifiedPhoneOutput": {
"type": "object",
"properties": {
@@ -33460,7 +33380,7 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"$ref": "#/components/schemas/UserVerifiedPhoneOutputData"
}
},
"required": ["status", "data"]
@@ -33474,7 +33394,10 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"type": "array",
"items": {
"$ref": "#/components/schemas/UserVerifiedEmailOutputData"
}
}
},
"required": ["status", "data"]
@@ -33488,11 +33411,42 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"type": "array",
"items": {
"$ref": "#/components/schemas/UserVerifiedPhoneOutputData"
}
}
},
"required": ["status", "data"]
},
"TeamVerifiedEmailOutputData": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The unique identifier for the verified email.",
"example": 789
},
"email": {
"type": "string",
"description": "The verified email address.",
"example": "user@example.com",
"format": "email"
},
"teamId": {
"type": "number",
"description": "The ID of the associated team, if applicable.",
"example": 89
},
"userId": {
"type": "number",
"nullable": true,
"description": "The ID of the associated user, if applicable.",
"example": 45
}
},
"required": ["id", "email", "teamId"]
},
"TeamVerifiedEmailOutput": {
"type": "object",
"properties": {
@@ -33502,11 +33456,39 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"$ref": "#/components/schemas/TeamVerifiedEmailOutputData"
}
},
"required": ["status", "data"]
},
"TeamVerifiedPhoneOutputData": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The unique identifier for the verified email.",
"example": 789
},
"phoneNumber": {
"type": "string",
"description": "The verified phone number.",
"example": "+37255556666",
"format": "phone"
},
"userId": {
"type": "number",
"nullable": true,
"description": "The ID of the associated user, if applicable.",
"example": 45
},
"teamId": {
"type": "number",
"description": "The ID of the associated team, if applicable.",
"example": 89
}
},
"required": ["id", "phoneNumber", "teamId"]
},
"TeamVerifiedPhoneOutput": {
"type": "object",
"properties": {
@@ -33516,7 +33498,7 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"$ref": "#/components/schemas/TeamVerifiedPhoneOutputData"
}
},
"required": ["status", "data"]
@@ -33530,7 +33512,10 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamVerifiedEmailOutputData"
}
}
},
"required": ["status", "data"]
@@ -33544,7 +33529,10 @@
"enum": ["success", "error"]
},
"data": {
"$ref": "#/components/schemas/ScheduleOutput"
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamVerifiedPhoneOutputData"
}
}
},
"required": ["status", "data"]