objectstack/packages/spec/json-schema/api/BulkResponse.json at 8ae3d928f9c95dd320e89d8629a52085fc3d2d73 · objectstack-ai/objectstack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
{
  "$ref": "#/definitions/BulkResponse",
  "definitions": {
    "BulkResponse": {
      "type": "object",
      "properties": {
        "success": {
          "type": "boolean",
          "description": "Operation success status"
        },
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "description": "Error code (e.g. validation_error)"
            },
            "message": {
              "type": "string",
              "description": "Readable error message"
            },
            "details": {
              "description": "Additional error context (e.g. field validation errors)"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "additionalProperties": false,
          "description": "Error details if success is false"
        },
        "meta": {
          "type": "object",
          "properties": {
            "timestamp": {
              "type": "string"
            },
            "duration": {
              "type": "number"
            },
            "requestId": {
              "type": "string"
            },
            "traceId": {
              "type": "string"
            }
          },
          "required": [
            "timestamp"
          ],
          "additionalProperties": false,
          "description": "Response metadata"
        },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Record ID if processed"
              },
              "success": {
                "type": "boolean"
              },
              "errors": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "description": "Error code (e.g. validation_error)"
                    },
                    "message": {
                      "type": "string",
                      "description": "Readable error message"
                    },
                    "details": {
                      "description": "Additional error context (e.g. field validation errors)"
                    }
                  },
                  "required": [
                    "code",
                    "message"
                  ],
                  "additionalProperties": false
                }
              }
            },
            "required": [
              "success"
            ],
            "additionalProperties": false
          },
          "description": "Results for each item in the batch"
        }
      },
      "required": [
        "success",
        "data"
      ],
      "additionalProperties": false
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}