@objectstack/spec 3.0.8 → 3.0.9

package/json-schema/api/GetDiscoveryResponse.json

@@ -107,9 +107,44 @@
             "description": "e.g. \"objectql\", \"plugin-redis\", \"driver-memory\"",
             "type": "string"
           },
+          "version": {
+            "description": "Semantic version of the service implementation (e.g. \"3.0.6\")",
+            "type": "string"
+          },
           "message": {
             "description": "e.g. \"Install plugin-workflow to enable\"",
             "type": "string"
+          },
+          "rateLimit": {
+            "description": "Rate limit and quota info for this service",
+            "type": "object",
+            "properties": {
+              "requestsPerMinute": {
+                "description": "Maximum requests per minute",
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              "requestsPerHour": {
+                "description": "Maximum requests per hour",
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              "burstLimit": {
+                "description": "Maximum burst request count",
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              },
+              "retryAfterMs": {
+                "description": "Suggested retry-after delay in milliseconds when rate-limited",
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              }
+            },
+            "additionalProperties": false
           }
         },
         "required": [
@@ -118,6 +153,50 @@
         ],
         "additionalProperties": false
       }
+    },
+    "capabilities": {
+      "description": "Well-known capability flags for frontend adaptation",
+      "type": "object",
+      "properties": {
+        "feed": {
+          "type": "boolean",
+          "description": "Whether the backend supports Feed / Chatter API"
+        },
+        "comments": {
+          "type": "boolean",
+          "description": "Whether the backend supports comments (a subset of Feed)"
+        },
+        "automation": {
+          "type": "boolean",
+          "description": "Whether the backend supports Automation CRUD (flows, triggers)"
+        },
+        "cron": {
+          "type": "boolean",
+          "description": "Whether the backend supports cron scheduling"
+        },
+        "search": {
+          "type": "boolean",
+          "description": "Whether the backend supports full-text search"
+        },
+        "export": {
+          "type": "boolean",
+          "description": "Whether the backend supports async export"
+        },
+        "chunkedUpload": {
+          "type": "boolean",
+          "description": "Whether the backend supports chunked (multipart) uploads"
+        }
+      },
+      "required": [
+        "feed",
+        "comments",
+        "automation",
+        "cron",
+        "search",
+        "export",
+        "chunkedUpload"
+      ],
+      "additionalProperties": false
     }
   },
   "required": [
@@ -125,6 +204,6 @@
     "apiName"
   ],
   "additionalProperties": false,
-  "$id": "https://schema.objectstack.io/v3.0.8/api/GetDiscoveryResponse.json",
-  "x-spec-version": "3.0.8"
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetDiscoveryResponse.json",
+  "x-spec-version": "3.0.9"
 }

package/json-schema/api/GetEffectivePermissionsRequest.json

@@ -3,6 +3,6 @@
   "type": "object",
   "properties": {},
   "additionalProperties": false,
-  "$id": "https://schema.objectstack.io/v3.0.8/api/GetEffectivePermissionsRequest.json",
-  "x-spec-version": "3.0.8"
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetEffectivePermissionsRequest.json",
+  "x-spec-version": "3.0.9"
 }

package/json-schema/api/GetEffectivePermissionsResponse.json

@@ -84,6 +84,6 @@
     "systemPermissions"
   ],
   "additionalProperties": false,
-  "$id": "https://schema.objectstack.io/v3.0.8/api/GetEffectivePermissionsResponse.json",
-  "x-spec-version": "3.0.8"
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetEffectivePermissionsResponse.json",
+  "x-spec-version": "3.0.9"
 }

package/json-schema/api/GetExportJobDownloadRequest.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "jobId": {
+      "type": "string",
+      "description": "Export job ID"
+    }
+  },
+  "required": [
+    "jobId"
+  ],
+  "additionalProperties": false,
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetExportJobDownloadRequest.json",
+  "x-spec-version": "3.0.9"
+}

package/json-schema/api/GetExportJobDownloadResponse.json

@@ -0,0 +1,122 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "success": {
+      "type": "boolean",
+      "description": "Operation success status"
+    },
+    "error": {
+      "description": "Error details if success is false",
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "string",
+          "description": "Error code (e.g. validation_error)"
+        },
+        "message": {
+          "type": "string",
+          "description": "Readable error message"
+        },
+        "category": {
+          "description": "Error category (e.g. validation, authorization)",
+          "type": "string"
+        },
+        "details": {
+          "description": "Additional error context (e.g. field validation errors)"
+        },
+        "requestId": {
+          "description": "Request ID for tracking",
+          "type": "string"
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "additionalProperties": false
+    },
+    "meta": {
+      "description": "Response metadata",
+      "type": "object",
+      "properties": {
+        "timestamp": {
+          "type": "string"
+        },
+        "duration": {
+          "type": "number"
+        },
+        "requestId": {
+          "type": "string"
+        },
+        "traceId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "timestamp"
+      ],
+      "additionalProperties": false
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "jobId": {
+          "type": "string",
+          "description": "Export job ID"
+        },
+        "downloadUrl": {
+          "type": "string",
+          "description": "Presigned download URL"
+        },
+        "fileName": {
+          "type": "string",
+          "description": "Suggested file name"
+        },
+        "fileSize": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991,
+          "description": "File size in bytes"
+        },
+        "format": {
+          "type": "string",
+          "enum": [
+            "csv",
+            "json",
+            "jsonl",
+            "xlsx",
+            "parquet"
+          ],
+          "description": "Export file format"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+          "description": "Download URL expiration timestamp"
+        },
+        "checksum": {
+          "description": "File checksum (SHA-256)",
+          "type": "string"
+        }
+      },
+      "required": [
+        "jobId",
+        "downloadUrl",
+        "fileName",
+        "fileSize",
+        "format",
+        "expiresAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "success",
+    "data"
+  ],
+  "additionalProperties": false,
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetExportJobDownloadResponse.json",
+  "x-spec-version": "3.0.9"
+}

package/json-schema/api/GetFeedRequest.json

@@ -40,6 +40,6 @@
     "limit"
   ],
   "additionalProperties": false,
-  "$id": "https://schema.objectstack.io/v3.0.8/api/GetFeedRequest.json",
-  "x-spec-version": "3.0.8"
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetFeedRequest.json",
+  "x-spec-version": "3.0.9"
 }

package/json-schema/api/GetFeedResponse.json

@@ -263,6 +263,32 @@
                 "minimum": 0,
                 "maximum": 9007199254740991
               },
+              "pinned": {
+                "default": false,
+                "description": "Whether the feed item is pinned to the top of the timeline",
+                "type": "boolean"
+              },
+              "pinnedAt": {
+                "description": "Timestamp when the item was pinned",
+                "type": "string",
+                "format": "date-time",
+                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
+              },
+              "pinnedBy": {
+                "description": "User ID who pinned the item",
+                "type": "string"
+              },
+              "starred": {
+                "default": false,
+                "description": "Whether the feed item is starred/bookmarked by the current user",
+                "type": "boolean"
+              },
+              "starredAt": {
+                "description": "Timestamp when the item was starred",
+                "type": "string",
+                "format": "date-time",
+                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
+              },
               "visibility": {
                 "default": "public",
                 "description": "Visibility: public (all users), internal (team only), private (author + mentioned)",
@@ -304,6 +330,8 @@
               "recordId",
               "actor",
               "replyCount",
+              "pinned",
+              "starred",
               "visibility",
               "createdAt",
               "isEdited"
@@ -339,6 +367,6 @@
     "data"
   ],
   "additionalProperties": false,
-  "$id": "https://schema.objectstack.io/v3.0.8/api/GetFeedResponse.json",
-  "x-spec-version": "3.0.8"
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetFeedResponse.json",
+  "x-spec-version": "3.0.9"
 }

package/json-schema/api/GetFieldLabelsRequest.json

@@ -16,6 +16,6 @@
     "locale"
   ],
   "additionalProperties": false,
-  "$id": "https://schema.objectstack.io/v3.0.8/api/GetFieldLabelsRequest.json",
-  "x-spec-version": "3.0.8"
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetFieldLabelsRequest.json",
+  "x-spec-version": "3.0.9"
 }

package/json-schema/api/GetFieldLabelsResponse.json

@@ -51,6 +51,6 @@
     "labels"
   ],
   "additionalProperties": false,
-  "$id": "https://schema.objectstack.io/v3.0.8/api/GetFieldLabelsResponse.json",
-  "x-spec-version": "3.0.8"
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetFieldLabelsResponse.json",
+  "x-spec-version": "3.0.9"
 }

package/json-schema/api/GetFlowRequest.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Flow machine name (snake_case)"
+    }
+  },
+  "required": [
+    "name"
+  ],
+  "additionalProperties": false,
+  "$id": "https://schema.objectstack.io/v3.0.9/api/GetFlowRequest.json",
+  "x-spec-version": "3.0.9"
+}