chore: improve ooo reason documentation apiv2 (#18582)

calcom · Jan 10, 2025 · dabd3b0 · dabd3b0
1 parent 95f9a02
commit dabd3b0
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 8 deletions.
diff --git a/apps/api/v2/src/modules/ooo/inputs/ooo.input.ts b/apps/api/v2/src/modules/ooo/inputs/ooo.input.ts
@@ -74,6 +74,7 @@ export class CreateOutOfOfficeEntryDto {
   @ApiPropertyOptional({
     description: "the reason for the out of office entry, if applicable",
     example: "vacation",
+    enum: OutOfOfficeReason,
   })
   reason?: OutOfOfficeReasonType;
 }

diff --git a/apps/api/v2/src/modules/ooo/outputs/ooo.output.ts b/apps/api/v2/src/modules/ooo/outputs/ooo.output.ts
@@ -69,6 +69,7 @@ export class UserOooOutputDto {
   @ApiPropertyOptional({
     description: "the reason for the out of office entry, if applicable",
     example: "vacation",
+    enum: OutOfOfficeReason,
   })
   @Expose()
   reason?: OutOfOfficeReason;

diff --git a/apps/api/v2/swagger/documentation.json b/apps/api/v2/swagger/documentation.json
@@ -13620,9 +13620,16 @@
             "example": 2
           },
           "reason": {
-            "type": "object",
+            "type": "string",
             "description": "the reason for the out of office entry, if applicable",
-            "example": "vacation"
+            "example": "vacation",
+            "enum": [
+              "unspecified",
+              "vacation",
+              "travel",
+              "sick",
+              "public_holiday"
+            ]
           }
         },
         "required": [
@@ -13656,9 +13663,16 @@
             "example": 2
           },
           "reason": {
-            "type": "object",
+            "type": "string",
             "description": "the reason for the out of office entry, if applicable",
-            "example": "vacation"
+            "example": "vacation",
+            "enum": [
+              "unspecified",
+              "vacation",
+              "travel",
+              "sick",
+              "public_holiday"
+            ]
           }
         }
       },

diff --git a/docs/api-reference/v2/openapi.json b/docs/api-reference/v2/openapi.json
@@ -12315,9 +12315,10 @@
             "example": 2
           },
           "reason": {
-            "type": "object",
+            "type": "string",
             "description": "the reason for the out of office entry, if applicable",
-            "example": "vacation"
+            "example": "vacation",
+            "enum": ["unspecified", "vacation", "travel", "sick", "public_holiday"]
           }
         },
         "required": ["start", "end"]
@@ -12348,9 +12349,10 @@
             "example": 2
           },
           "reason": {
-            "type": "object",
+            "type": "string",
             "description": "the reason for the out of office entry, if applicable",
-            "example": "vacation"
+            "example": "vacation",
+            "enum": ["unspecified", "vacation", "travel", "sick", "public_holiday"]
           }
         }
       },