@objectstack/spec 0.6.1 → 0.7.2

package/json-schema/api/BatchOperationResult.json

@@ -0,0 +1,57 @@
+{
+  "$ref": "#/definitions/BatchOperationResult",
+  "definitions": {
+    "BatchOperationResult": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Record ID if operation succeeded"
+        },
+        "success": {
+          "type": "boolean",
+          "description": "Whether this record was processed successfully"
+        },
+        "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
+          },
+          "description": "Array of errors if operation failed"
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Full record data (if returnRecords=true)"
+        },
+        "index": {
+          "type": "number",
+          "description": "Index of the record in the request array"
+        }
+      },
+      "required": [
+        "success"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/BatchOperationType.json

@@ -0,0 +1,15 @@
+{
+  "$ref": "#/definitions/BatchOperationType",
+  "definitions": {
+    "BatchOperationType": {
+      "type": "string",
+      "enum": [
+        "create",
+        "update",
+        "upsert",
+        "delete"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/BatchOptions.json

@@ -0,0 +1,32 @@
+{
+  "$ref": "#/definitions/BatchOptions",
+  "definitions": {
+    "BatchOptions": {
+      "type": "object",
+      "properties": {
+        "atomic": {
+          "type": "boolean",
+          "default": true,
+          "description": "If true, rollback entire batch on any failure (transaction mode)"
+        },
+        "returnRecords": {
+          "type": "boolean",
+          "default": false,
+          "description": "If true, return full record data in response"
+        },
+        "continueOnError": {
+          "type": "boolean",
+          "default": false,
+          "description": "If true (and atomic=false), continue processing remaining records after errors"
+        },
+        "validateOnly": {
+          "type": "boolean",
+          "default": false,
+          "description": "If true, validate records without persisting changes (dry-run mode)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/BatchRecord.json

@@ -0,0 +1,25 @@
+{
+  "$ref": "#/definitions/BatchRecord",
+  "definitions": {
+    "BatchRecord": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Record ID (required for update/delete)"
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Record data (required for create/update/upsert)"
+        },
+        "externalId": {
+          "type": "string",
+          "description": "External ID for upsert matching"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/BatchUpdateRequest.json

@@ -0,0 +1,78 @@
+{
+  "$ref": "#/definitions/BatchUpdateRequest",
+  "definitions": {
+    "BatchUpdateRequest": {
+      "type": "object",
+      "properties": {
+        "operation": {
+          "type": "string",
+          "enum": [
+            "create",
+            "update",
+            "upsert",
+            "delete"
+          ],
+          "description": "Type of batch operation"
+        },
+        "records": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Record ID (required for update/delete)"
+              },
+              "data": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Record data (required for create/update/upsert)"
+              },
+              "externalId": {
+                "type": "string",
+                "description": "External ID for upsert matching"
+              }
+            },
+            "additionalProperties": false
+          },
+          "minItems": 1,
+          "maxItems": 200,
+          "description": "Array of records to process (max 200 per batch)"
+        },
+        "options": {
+          "type": "object",
+          "properties": {
+            "atomic": {
+              "type": "boolean",
+              "default": true,
+              "description": "If true, rollback entire batch on any failure (transaction mode)"
+            },
+            "returnRecords": {
+              "type": "boolean",
+              "default": false,
+              "description": "If true, return full record data in response"
+            },
+            "continueOnError": {
+              "type": "boolean",
+              "default": false,
+              "description": "If true (and atomic=false), continue processing remaining records after errors"
+            },
+            "validateOnly": {
+              "type": "boolean",
+              "default": false,
+              "description": "If true, validate records without persisting changes (dry-run mode)"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Batch operation options"
+        }
+      },
+      "required": [
+        "operation",
+        "records"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/BatchUpdateResponse.json

@@ -0,0 +1,144 @@
+{
+  "$ref": "#/definitions/BatchUpdateResponse",
+  "definitions": {
+    "BatchUpdateResponse": {
+      "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"
+        },
+        "operation": {
+          "type": "string",
+          "enum": [
+            "create",
+            "update",
+            "upsert",
+            "delete"
+          ],
+          "description": "Operation type that was performed"
+        },
+        "total": {
+          "type": "number",
+          "description": "Total number of records in the batch"
+        },
+        "succeeded": {
+          "type": "number",
+          "description": "Number of records that succeeded"
+        },
+        "failed": {
+          "type": "number",
+          "description": "Number of records that failed"
+        },
+        "results": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Record ID if operation succeeded"
+              },
+              "success": {
+                "type": "boolean",
+                "description": "Whether this record was processed successfully"
+              },
+              "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
+                },
+                "description": "Array of errors if operation failed"
+              },
+              "data": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Full record data (if returnRecords=true)"
+              },
+              "index": {
+                "type": "number",
+                "description": "Index of the record in the request array"
+              }
+            },
+            "required": [
+              "success"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Detailed results for each record"
+        }
+      },
+      "required": [
+        "success",
+        "total",
+        "succeeded",
+        "failed",
+        "results"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CacheControl.json

@@ -0,0 +1,42 @@
+{
+  "$ref": "#/definitions/CacheControl",
+  "definitions": {
+    "CacheControl": {
+      "type": "object",
+      "properties": {
+        "directives": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "public",
+              "private",
+              "no-cache",
+              "no-store",
+              "must-revalidate",
+              "max-age"
+            ]
+          },
+          "description": "Cache control directives"
+        },
+        "maxAge": {
+          "type": "number",
+          "description": "Maximum cache age in seconds"
+        },
+        "staleWhileRevalidate": {
+          "type": "number",
+          "description": "Allow serving stale content while revalidating (seconds)"
+        },
+        "staleIfError": {
+          "type": "number",
+          "description": "Allow serving stale content on error (seconds)"
+        }
+      },
+      "required": [
+        "directives"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CacheDirective.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/CacheDirective",
+  "definitions": {
+    "CacheDirective": {
+      "type": "string",
+      "enum": [
+        "public",
+        "private",
+        "no-cache",
+        "no-store",
+        "must-revalidate",
+        "max-age"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CacheInvalidationRequest.json

@@ -0,0 +1,43 @@
+{
+  "$ref": "#/definitions/CacheInvalidationRequest",
+  "definitions": {
+    "CacheInvalidationRequest": {
+      "type": "object",
+      "properties": {
+        "target": {
+          "type": "string",
+          "enum": [
+            "all",
+            "object",
+            "field",
+            "permission",
+            "layout",
+            "custom"
+          ],
+          "description": "What to invalidate"
+        },
+        "identifiers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Specific resources to invalidate (e.g., object names)"
+        },
+        "cascade": {
+          "type": "boolean",
+          "default": false,
+          "description": "If true, invalidate dependent resources"
+        },
+        "pattern": {
+          "type": "string",
+          "description": "Pattern for custom invalidation (supports wildcards)"
+        }
+      },
+      "required": [
+        "target"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CacheInvalidationResponse.json

@@ -0,0 +1,31 @@
+{
+  "$ref": "#/definitions/CacheInvalidationResponse",
+  "definitions": {
+    "CacheInvalidationResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Whether invalidation succeeded"
+        },
+        "invalidated": {
+          "type": "number",
+          "description": "Number of cache entries invalidated"
+        },
+        "targets": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of invalidated resources"
+        }
+      },
+      "required": [
+        "success",
+        "invalidated"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CacheInvalidationTarget.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/CacheInvalidationTarget",
+  "definitions": {
+    "CacheInvalidationTarget": {
+      "type": "string",
+      "enum": [
+        "all",
+        "object",
+        "field",
+        "permission",
+        "layout",
+        "custom"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CreateDataRequest.json

@@ -0,0 +1,25 @@
+{
+  "$ref": "#/definitions/CreateDataRequest",
+  "definitions": {
+    "CreateDataRequest": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "Object name"
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Record data to create"
+        }
+      },
+      "required": [
+        "object",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CreateDataResponse.json

@@ -0,0 +1,30 @@
+{
+  "$ref": "#/definitions/CreateDataResponse",
+  "definitions": {
+    "CreateDataResponse": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "Object name"
+        },
+        "id": {
+          "type": "string",
+          "description": "Created record ID"
+        },
+        "record": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Created record (with server-generated fields)"
+        }
+      },
+      "required": [
+        "object",
+        "id",
+        "record"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CreateManyDataRequest.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/CreateManyDataRequest",
+  "definitions": {
+    "CreateManyDataRequest": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "Object name"
+        },
+        "records": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": {}
+          },
+          "description": "Array of records to create"
+        }
+      },
+      "required": [
+        "object",
+        "records"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/CreateManyDataResponse.json

@@ -0,0 +1,33 @@
+{
+  "$ref": "#/definitions/CreateManyDataResponse",
+  "definitions": {
+    "CreateManyDataResponse": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "Object name"
+        },
+        "records": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": {}
+          },
+          "description": "Created records"
+        },
+        "count": {
+          "type": "number",
+          "description": "Number of records created"
+        }
+      },
+      "required": [
+        "object",
+        "records",
+        "count"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}