feat: Add type, is_enabled to expenses custom fields key (#386)

* testing * Auto generate API docs * typo * Auto generate API docs * typo * Auto generate API docs --------- Co-authored-by: Siva <siva@fylehq.com>
fylein · Nov 6, 2023 · 39e4d1e · 39e4d1e
1 parent da456f4
commit 39e4d1e
Show file tree

Hide file tree

Showing 5 changed files with 234 additions and 25 deletions.
diff --git a/reference/admin.yaml b/reference/admin.yaml
@@ -2678,6 +2678,58 @@ components:
     null_field:
       type: string
       nullable: true
+    expense_custom_field:
+      type: object
+      description: |
+        Expense custom field
+      properties:
+        name:
+          type: string
+          example: cf1
+        value:
+          nullable: true
+          oneOf:
+            - type: string
+              example: string1
+            - type: boolean
+              example: true
+            - type: integer
+              example: 123
+            - $ref: '#/components/schemas/location'
+            - type: array
+              items:
+                type: string
+              example:
+                - v1
+                - v2
+        type:
+          type: string
+          nullable: true
+          enum:
+            - TEXT
+            - NUMBER
+            - SELECT
+            - BOOLEAN
+            - MULTI_SELECT
+            - LOCATION
+            - USER_LIST
+            - DATE
+            - DEPENDENT_SELECT
+            - null
+          description: |
+            This field specifies the type of the expense field.
+          example: SELECT
+        is_enabled:
+          anyOf:
+            - $ref: '#/components/schemas/null_field'
+            - $ref: '#/components/schemas/is_enabled'
+          nullable: true
+    expense_custom_fields:
+      type: array
+      description: |
+        Expense custom fields
+      items:
+        $ref: '#/components/schemas/expense_custom_field'
     amount:
       type: number
       description: |
@@ -3481,7 +3533,7 @@ components:
           items:
             $ref: '#/components/schemas/location'
         custom_fields:
-          $ref: '#/components/schemas/custom_fields'
+          $ref: '#/components/schemas/expense_custom_fields'
         custom_fields_flattened:
           $ref: '#/components/schemas/flattened_custom_field'
         code:

diff --git a/reference/approver.yaml b/reference/approver.yaml
@@ -676,10 +676,19 @@ components:
           type: number
           nullable: true
           example: 77.594566
-    custom_field:
+    null_field:
+      type: string
+      nullable: true
+    is_enabled:
+      type: boolean
+      description: |
+        This indicates if the resource is enabled for use within the organisation.
+      default: true
+      example: true
+    expense_custom_field:
       type: object
       description: |
-        Custom field
+        Expense custom field
       properties:
         name:
           type: string
@@ -700,12 +709,34 @@ components:
               example:
                 - v1
                 - v2
-    custom_fields:
+        type:
+          type: string
+          nullable: true
+          enum:
+            - TEXT
+            - NUMBER
+            - SELECT
+            - BOOLEAN
+            - MULTI_SELECT
+            - LOCATION
+            - USER_LIST
+            - DATE
+            - DEPENDENT_SELECT
+            - null
+          description: |
+            This field specifies the type of the expense field.
+          example: SELECT
+        is_enabled:
+          anyOf:
+            - $ref: '#/components/schemas/null_field'
+            - $ref: '#/components/schemas/is_enabled'
+          nullable: true
+    expense_custom_fields:
       type: array
       description: |
-        Custom fields
+        Expense custom fields
       items:
-        $ref: '#/components/schemas/custom_field'
+        $ref: '#/components/schemas/expense_custom_field'
     flattened_custom_field:
       type: object
       description: |
@@ -736,9 +767,6 @@ components:
       example:
         cf1: string1
         custom_field_2: Value 2
-    null_field:
-      type: string
-      nullable: true
     report_out_embed:
       type: object
       nullable: true
@@ -906,12 +934,36 @@ components:
         - id
         - name
         - band
-    is_enabled:
-      type: boolean
+    custom_field:
+      type: object
       description: |
-        This indicates if the resource is enabled for use within the organisation.
-      default: true
-      example: true
+        Custom field
+      properties:
+        name:
+          type: string
+          example: cf1
+        value:
+          nullable: true
+          oneOf:
+            - type: string
+              example: string1
+            - type: boolean
+              example: true
+            - type: integer
+              example: 123
+            - $ref: '#/components/schemas/location'
+            - type: array
+              items:
+                type: string
+              example:
+                - v1
+                - v2
+    custom_fields:
+      type: array
+      description: |
+        Custom fields
+      items:
+        $ref: '#/components/schemas/custom_field'
     employee_out_embed_for_expense:
       type: object
       additionalProperties: false
@@ -1555,7 +1607,7 @@ components:
           items:
             $ref: '#/components/schemas/location'
         custom_fields:
-          $ref: '#/components/schemas/custom_fields'
+          $ref: '#/components/schemas/expense_custom_fields'
         custom_fields_flattened:
           $ref: '#/components/schemas/flattened_custom_field'
         code:

diff --git a/reference/spender.yaml b/reference/spender.yaml
@@ -769,10 +769,13 @@ components:
           type: number
           nullable: true
           example: 77.594566
-    custom_field:
+    null_field:
+      type: string
+      nullable: true
+    expense_custom_field:
       type: object
       description: |
-        Custom field
+        Expense custom field
       properties:
         name:
           type: string
@@ -793,12 +796,34 @@ components:
               example:
                 - v1
                 - v2
-    custom_fields:
+        type:
+          type: string
+          nullable: true
+          enum:
+            - TEXT
+            - NUMBER
+            - SELECT
+            - BOOLEAN
+            - MULTI_SELECT
+            - LOCATION
+            - USER_LIST
+            - DATE
+            - DEPENDENT_SELECT
+            - null
+          description: |
+            This field specifies the type of the expense field.
+          example: SELECT
+        is_enabled:
+          anyOf:
+            - $ref: '#/components/schemas/null_field'
+            - $ref: '#/components/schemas/is_enabled'
+          nullable: true
+    expense_custom_fields:
       type: array
       description: |
-        Custom fields
+        Expense custom fields
       items:
-        $ref: '#/components/schemas/custom_field'
+        $ref: '#/components/schemas/expense_custom_field'
     flattened_custom_field:
       type: object
       description: |
@@ -829,9 +854,6 @@ components:
       example:
         cf1: string1
         custom_field_2: Value 2
-    null_field:
-      type: string
-      nullable: true
     amount:
       type: number
       description: |
@@ -1056,6 +1078,36 @@ components:
         - id
         - name
         - band
+    custom_field:
+      type: object
+      description: |
+        Custom field
+      properties:
+        name:
+          type: string
+          example: cf1
+        value:
+          nullable: true
+          oneOf:
+            - type: string
+              example: string1
+            - type: boolean
+              example: true
+            - type: integer
+              example: 123
+            - $ref: '#/components/schemas/location'
+            - type: array
+              items:
+                type: string
+              example:
+                - v1
+                - v2
+    custom_fields:
+      type: array
+      description: |
+        Custom fields
+      items:
+        $ref: '#/components/schemas/custom_field'
     employee_out_embed_for_expense:
       type: object
       additionalProperties: false
@@ -1699,7 +1751,7 @@ components:
           items:
             $ref: '#/components/schemas/location'
         custom_fields:
-          $ref: '#/components/schemas/custom_fields'
+          $ref: '#/components/schemas/expense_custom_fields'
         custom_fields_flattened:
           $ref: '#/components/schemas/flattened_custom_field'
         code:

diff --git a/src/components/schemas/expense.yaml b/src/components/schemas/expense.yaml
@@ -278,7 +278,7 @@ expense_out:
       items:
         $ref: './fields.yaml#/location'
     custom_fields:
-      $ref: './fields.yaml#/custom_fields'
+      $ref: './fields.yaml#/expense_custom_fields'
     custom_fields_flattened:
       $ref: './fields.yaml#/flattened_custom_field'
     code:

diff --git a/src/components/schemas/fields.yaml b/src/components/schemas/fields.yaml
@@ -700,6 +700,59 @@ custom_fields:
   items:
     $ref: '#/custom_field'
 
+expense_custom_field:
+  type: object
+  description: |
+    Expense custom field
+  properties:
+    name:
+      type: string
+      example: cf1
+    value:
+      nullable: true
+      oneOf:
+        - type: string
+          example: string1
+        - type: boolean
+          example: True
+        - type: integer
+          example: 123
+        - $ref: '#/location'
+        - type: array
+          items:
+            type: string
+          example: [ 'v1', 'v2' ]
+    type:
+      type: string
+      nullable: true
+      enum:
+        - TEXT
+        - NUMBER
+        - SELECT
+        - BOOLEAN
+        - MULTI_SELECT
+        - LOCATION
+        - USER_LIST
+        - DATE
+        - DEPENDENT_SELECT
+        - null
+      description: |
+        This field specifies the type of the expense field.
+      example: SELECT
+    is_enabled:
+      anyOf:
+        - $ref: '#/null_field'
+        - $ref: '#/is_enabled'
+      nullable: true
+
+expense_custom_fields:
+  type: array
+  description: |
+    Expense custom fields
+  items:
+    $ref: '#/expense_custom_field'
+
+
 flattened_custom_field:
   type: object
   description: |