@objectstack/spec 2.0.5 → 2.0.7

package/json-schema/identity/SCIMBulkRequest.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemas": {
+      "default": [
+        "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
+      ],
+      "description": "SCIM schema URIs (BulkRequest)",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "const": "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
+      }
+    },
+    "operations": {
+      "minItems": 1,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "method": {
+            "type": "string",
+            "enum": [
+              "POST",
+              "PUT",
+              "PATCH",
+              "DELETE"
+            ],
+            "description": "HTTP method for the bulk operation"
+          },
+          "path": {
+            "type": "string",
+            "description": "Resource endpoint path (e.g. /Users, /Groups/{id})"
+          },
+          "bulkId": {
+            "description": "Client-assigned ID for cross-referencing between operations",
+            "type": "string"
+          },
+          "data": {
+            "description": "Request body for POST/PUT/PATCH operations",
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {}
+          },
+          "version": {
+            "description": "ETag for optimistic concurrency control",
+            "type": "string"
+          }
+        },
+        "required": [
+          "method",
+          "path"
+        ],
+        "additionalProperties": false
+      },
+      "description": "Bulk operations to execute (minimum 1)"
+    },
+    "failOnErrors": {
+      "description": "Stop processing after this many errors",
+      "type": "integer",
+      "minimum": -9007199254740991,
+      "maximum": 9007199254740991
+    }
+  },
+  "required": [
+    "schemas",
+    "operations"
+  ],
+  "additionalProperties": false
+}

package/json-schema/identity/SCIMBulkResponse.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemas": {
+      "default": [
+        "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
+      ],
+      "description": "SCIM schema URIs (BulkResponse)",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "const": "urn:ietf:params:scim:api:messages:2.0:BulkResponse"
+      }
+    },
+    "operations": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "method": {
+            "type": "string",
+            "enum": [
+              "POST",
+              "PUT",
+              "PATCH",
+              "DELETE"
+            ],
+            "description": "HTTP method that was executed"
+          },
+          "bulkId": {
+            "description": "Client-assigned bulk operation ID",
+            "type": "string"
+          },
+          "location": {
+            "description": "URL of the created or modified resource",
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "description": "HTTP status code as string (e.g. \"201\", \"400\")"
+          },
+          "response": {
+            "description": "Response body (typically present for errors)"
+          }
+        },
+        "required": [
+          "method",
+          "status"
+        ],
+        "additionalProperties": false
+      },
+      "description": "Results for each bulk operation"
+    }
+  },
+  "required": [
+    "schemas",
+    "operations"
+  ],
+  "additionalProperties": false
+}

package/json-schema/identity/SCIMBulkResponseOperation.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "method": {
+      "type": "string",
+      "enum": [
+        "POST",
+        "PUT",
+        "PATCH",
+        "DELETE"
+      ],
+      "description": "HTTP method that was executed"
+    },
+    "bulkId": {
+      "description": "Client-assigned bulk operation ID",
+      "type": "string"
+    },
+    "location": {
+      "description": "URL of the created or modified resource",
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "description": "HTTP status code as string (e.g. \"201\", \"400\")"
+    },
+    "response": {
+      "description": "Response body (typically present for errors)"
+    }
+  },
+  "required": [
+    "method",
+    "status"
+  ],
+  "additionalProperties": false
+}

package/json-schema/integration/CircuitBreakerConfig.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "description": "Enable circuit breaker"
+    },
+    "failureThreshold": {
+      "default": 5,
+      "description": "Failures before opening circuit",
+      "type": "number"
+    },
+    "resetTimeoutMs": {
+      "default": 30000,
+      "description": "Time in open state before half-open",
+      "type": "number"
+    },
+    "halfOpenMaxRequests": {
+      "default": 1,
+      "description": "Requests allowed in half-open state",
+      "type": "number"
+    },
+    "monitoringWindow": {
+      "default": 60000,
+      "description": "Rolling window for failure count in ms",
+      "type": "number"
+    },
+    "fallbackStrategy": {
+      "description": "Fallback strategy when circuit is open",
+      "type": "string",
+      "enum": [
+        "cache",
+        "default_value",
+        "error",
+        "queue"
+      ]
+    }
+  },
+  "required": [
+    "enabled",
+    "failureThreshold",
+    "resetTimeoutMs",
+    "halfOpenMaxRequests",
+    "monitoringWindow"
+  ],
+  "additionalProperties": false,
+  "description": "Circuit breaker configuration"
+}

package/json-schema/integration/Connector.json

@@ -906,6 +906,229 @@
       "description": "Enable connector",
       "type": "boolean"
     },
+    "errorMapping": {
+      "description": "Error mapping configuration",
+      "type": "object",
+      "properties": {
+        "rules": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "sourceCode": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  }
+                ],
+                "description": "External system error code"
+              },
+              "sourceMessage": {
+                "description": "Pattern to match against error message",
+                "type": "string"
+              },
+              "targetCode": {
+                "type": "string",
+                "description": "ObjectStack standard error code"
+              },
+              "targetCategory": {
+                "type": "string",
+                "enum": [
+                  "validation",
+                  "authorization",
+                  "not_found",
+                  "conflict",
+                  "rate_limit",
+                  "timeout",
+                  "server_error",
+                  "integration_error"
+                ],
+                "description": "Error category"
+              },
+              "severity": {
+                "type": "string",
+                "enum": [
+                  "low",
+                  "medium",
+                  "high",
+                  "critical"
+                ],
+                "description": "Error severity level"
+              },
+              "retryable": {
+                "type": "boolean",
+                "description": "Whether the error is retryable"
+              },
+              "userMessage": {
+                "description": "Human-readable message to show users",
+                "type": "string"
+              }
+            },
+            "required": [
+              "sourceCode",
+              "targetCode",
+              "targetCategory",
+              "severity",
+              "retryable"
+            ],
+            "additionalProperties": false,
+            "description": "Error mapping rule"
+          },
+          "description": "Error mapping rules"
+        },
+        "defaultCategory": {
+          "default": "integration_error",
+          "description": "Default category for unmapped errors",
+          "type": "string",
+          "enum": [
+            "validation",
+            "authorization",
+            "not_found",
+            "conflict",
+            "rate_limit",
+            "timeout",
+            "server_error",
+            "integration_error"
+          ]
+        },
+        "unmappedBehavior": {
+          "type": "string",
+          "enum": [
+            "passthrough",
+            "generic_error",
+            "throw"
+          ],
+          "description": "What to do with unmapped errors"
+        },
+        "logUnmapped": {
+          "default": true,
+          "description": "Log unmapped errors",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "rules",
+        "defaultCategory",
+        "unmappedBehavior",
+        "logUnmapped"
+      ],
+      "additionalProperties": false
+    },
+    "health": {
+      "description": "Health and resilience configuration",
+      "type": "object",
+      "properties": {
+        "healthCheck": {
+          "description": "Health check configuration",
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Enable health checks"
+            },
+            "intervalMs": {
+              "default": 60000,
+              "description": "Health check interval in milliseconds",
+              "type": "number"
+            },
+            "timeoutMs": {
+              "default": 5000,
+              "description": "Health check timeout in milliseconds",
+              "type": "number"
+            },
+            "endpoint": {
+              "description": "Health check endpoint path",
+              "type": "string"
+            },
+            "method": {
+              "description": "HTTP method for health check",
+              "type": "string",
+              "enum": [
+                "GET",
+                "HEAD",
+                "OPTIONS"
+              ]
+            },
+            "expectedStatus": {
+              "default": 200,
+              "description": "Expected HTTP status code",
+              "type": "number"
+            },
+            "unhealthyThreshold": {
+              "default": 3,
+              "description": "Consecutive failures before marking unhealthy",
+              "type": "number"
+            },
+            "healthyThreshold": {
+              "default": 1,
+              "description": "Consecutive successes before marking healthy",
+              "type": "number"
+            }
+          },
+          "required": [
+            "enabled",
+            "intervalMs",
+            "timeoutMs",
+            "expectedStatus",
+            "unhealthyThreshold",
+            "healthyThreshold"
+          ],
+          "additionalProperties": false
+        },
+        "circuitBreaker": {
+          "description": "Circuit breaker configuration",
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Enable circuit breaker"
+            },
+            "failureThreshold": {
+              "default": 5,
+              "description": "Failures before opening circuit",
+              "type": "number"
+            },
+            "resetTimeoutMs": {
+              "default": 30000,
+              "description": "Time in open state before half-open",
+              "type": "number"
+            },
+            "halfOpenMaxRequests": {
+              "default": 1,
+              "description": "Requests allowed in half-open state",
+              "type": "number"
+            },
+            "monitoringWindow": {
+              "default": 60000,
+              "description": "Rolling window for failure count in ms",
+              "type": "number"
+            },
+            "fallbackStrategy": {
+              "description": "Fallback strategy when circuit is open",
+              "type": "string",
+              "enum": [
+                "cache",
+                "default_value",
+                "error",
+                "queue"
+              ]
+            }
+          },
+          "required": [
+            "enabled",
+            "failureThreshold",
+            "resetTimeoutMs",
+            "halfOpenMaxRequests",
+            "monitoringWindow"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
     "metadata": {
       "description": "Custom connector metadata",
       "type": "object",

package/json-schema/integration/ConnectorHealth.json

@@ -0,0 +1,113 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "healthCheck": {
+      "description": "Health check configuration",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Enable health checks"
+        },
+        "intervalMs": {
+          "default": 60000,
+          "description": "Health check interval in milliseconds",
+          "type": "number"
+        },
+        "timeoutMs": {
+          "default": 5000,
+          "description": "Health check timeout in milliseconds",
+          "type": "number"
+        },
+        "endpoint": {
+          "description": "Health check endpoint path",
+          "type": "string"
+        },
+        "method": {
+          "description": "HTTP method for health check",
+          "type": "string",
+          "enum": [
+            "GET",
+            "HEAD",
+            "OPTIONS"
+          ]
+        },
+        "expectedStatus": {
+          "default": 200,
+          "description": "Expected HTTP status code",
+          "type": "number"
+        },
+        "unhealthyThreshold": {
+          "default": 3,
+          "description": "Consecutive failures before marking unhealthy",
+          "type": "number"
+        },
+        "healthyThreshold": {
+          "default": 1,
+          "description": "Consecutive successes before marking healthy",
+          "type": "number"
+        }
+      },
+      "required": [
+        "enabled",
+        "intervalMs",
+        "timeoutMs",
+        "expectedStatus",
+        "unhealthyThreshold",
+        "healthyThreshold"
+      ],
+      "additionalProperties": false
+    },
+    "circuitBreaker": {
+      "description": "Circuit breaker configuration",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Enable circuit breaker"
+        },
+        "failureThreshold": {
+          "default": 5,
+          "description": "Failures before opening circuit",
+          "type": "number"
+        },
+        "resetTimeoutMs": {
+          "default": 30000,
+          "description": "Time in open state before half-open",
+          "type": "number"
+        },
+        "halfOpenMaxRequests": {
+          "default": 1,
+          "description": "Requests allowed in half-open state",
+          "type": "number"
+        },
+        "monitoringWindow": {
+          "default": 60000,
+          "description": "Rolling window for failure count in ms",
+          "type": "number"
+        },
+        "fallbackStrategy": {
+          "description": "Fallback strategy when circuit is open",
+          "type": "string",
+          "enum": [
+            "cache",
+            "default_value",
+            "error",
+            "queue"
+          ]
+        }
+      },
+      "required": [
+        "enabled",
+        "failureThreshold",
+        "resetTimeoutMs",
+        "halfOpenMaxRequests",
+        "monitoringWindow"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "description": "Connector health configuration"
+}