feat: rename Error to GridError and add additionalProperties to error schemas

pengying · pengying · commit a1379cdf4048 · 2026-01-27T05:24:55.000Z
diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml
diff --git a/openapi.yaml b/openapi.yaml
diff --git a/openapi/components/schemas/common/GridError.yaml b/openapi/components/schemas/common/GridError.yaml
@@ -0,0 +1,13 @@
+type: object
+title: GridError
+properties:
+  code:
+    type: string
+    description: Error code
+  message:
+    type: string
+    description: Error message
+  details:
+    type: object
+    description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/customers/BulkCustomerImportErrorEntry.yaml b/openapi/components/schemas/customers/BulkCustomerImportErrorEntry.yaml
@@ -0,0 +1,11 @@
+allOf:
+  - $ref: ../common/GridError.yaml
+  - type: object
+    description: Error information for a failed bulk import entry
+    required:
+      - correlationId
+    properties:
+      correlationId:
+        type: string
+        description: Platform customer ID or row number for the failed entry
+        example: biz456
diff --git a/openapi/components/schemas/customers/BulkCustomerImportJob.yaml b/openapi/components/schemas/customers/BulkCustomerImportJob.yaml
@@ -45,17 +45,7 @@ properties:
     type: array
     description: Detailed error information for failed entries
     items:
-      type: object
-      required:
-        - correlationId
-        - error
-      properties:
-        correlationId:
-          type: string
-          description: Platform customer ID or row number for the failed entry
-          example: biz456
-        error:
-          $ref: ../common/Error.yaml
+      $ref: BulkCustomerImportErrorEntry.yaml
   completedAt:
     type: string
     format: date-time
diff --git a/openapi/components/schemas/errors/Error400.yaml b/openapi/components/schemas/errors/Error400.yaml
@@ -74,3 +74,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error401.yaml b/openapi/components/schemas/errors/Error401.yaml
@@ -24,3 +24,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error403.yaml b/openapi/components/schemas/errors/Error403.yaml
@@ -28,3 +28,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error404.yaml b/openapi/components/schemas/errors/Error404.yaml
@@ -36,3 +36,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error409.yaml b/openapi/components/schemas/errors/Error409.yaml
@@ -24,3 +24,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error412.yaml b/openapi/components/schemas/errors/Error412.yaml
@@ -21,3 +21,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error424.yaml b/openapi/components/schemas/errors/Error424.yaml
@@ -28,3 +28,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error500.yaml b/openapi/components/schemas/errors/Error500.yaml
@@ -24,3 +24,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/errors/Error501.yaml b/openapi/components/schemas/errors/Error501.yaml
@@ -24,3 +24,4 @@ properties:
   details:
     type: object
     description: Additional error details
+    additionalProperties: true
diff --git a/openapi/components/schemas/webhooks/IncomingPaymentWebhookForbiddenResponse.yaml b/openapi/components/schemas/webhooks/IncomingPaymentWebhookForbiddenResponse.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: ../common/Error.yaml
+  - $ref: ../common/GridError.yaml
   - type: object
     properties:
       reason:
diff --git a/openapi/components/schemas/webhooks/IncomingPaymentWebhookUnprocessableResponse.yaml b/openapi/components/schemas/webhooks/IncomingPaymentWebhookUnprocessableResponse.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: ../common/Error.yaml
+  - $ref: ../common/GridError.yaml
   - type: object
     properties:
       requiredFields:
