@objectstack/spec 2.0.5 → 2.0.7

package/json-schema/api/RestServerConfig.json

@@ -471,6 +471,145 @@
         "nameTransform"
       ],
       "additionalProperties": false
+    },
+    "openApi31": {
+      "description": "OpenAPI 3.1 extensions configuration",
+      "type": "object",
+      "properties": {
+        "webhooks": {
+          "description": "OpenAPI 3.1 webhooks (top-level webhook definitions)",
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "pattern": "^[a-z_][a-z0-9_]*$",
+                "description": "Webhook event identifier (snake_case)"
+              },
+              "description": {
+                "type": "string",
+                "description": "Human-readable event description"
+              },
+              "method": {
+                "default": "POST",
+                "description": "HTTP method for webhook delivery",
+                "type": "string",
+                "enum": [
+                  "GET",
+                  "POST",
+                  "PUT",
+                  "DELETE",
+                  "PATCH",
+                  "HEAD",
+                  "OPTIONS"
+                ]
+              },
+              "payloadSchema": {
+                "type": "string",
+                "description": "JSON Schema $ref for the webhook payload"
+              },
+              "headers": {
+                "description": "Custom headers to include in webhook delivery",
+                "type": "object",
+                "propertyNames": {
+                  "type": "string"
+                },
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "security": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "enum": [
+                    "hmac_sha256",
+                    "basic",
+                    "bearer",
+                    "api_key"
+                  ]
+                },
+                "description": "Supported authentication methods for webhook verification"
+              }
+            },
+            "required": [
+              "name",
+              "description",
+              "method",
+              "payloadSchema",
+              "security"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "callbacks": {
+          "description": "OpenAPI 3.1 callbacks (async response definitions)",
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "pattern": "^[a-z_][a-z0-9_]*$",
+                  "description": "Callback identifier (snake_case)"
+                },
+                "expression": {
+                  "type": "string",
+                  "description": "Runtime expression (e.g., {$request.body#/callbackUrl})"
+                },
+                "method": {
+                  "type": "string",
+                  "enum": [
+                    "GET",
+                    "POST",
+                    "PUT",
+                    "DELETE",
+                    "PATCH",
+                    "HEAD",
+                    "OPTIONS"
+                  ],
+                  "description": "HTTP method for callback request"
+                },
+                "url": {
+                  "type": "string",
+                  "description": "Callback URL template with runtime expressions"
+                }
+              },
+              "required": [
+                "name",
+                "expression",
+                "method",
+                "url"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "jsonSchemaDialect": {
+          "default": "https://json-schema.org/draft/2020-12/schema",
+          "description": "JSON Schema dialect for schema definitions",
+          "type": "string"
+        },
+        "pathItemReferences": {
+          "default": false,
+          "description": "Allow $ref in path items (OpenAPI 3.1 feature)",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "jsonSchemaDialect",
+        "pathItemReferences"
+      ],
+      "additionalProperties": false
     }
   },
   "additionalProperties": false

package/json-schema/api/SubgraphConfig.json

@@ -0,0 +1,183 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Unique subgraph identifier"
+    },
+    "url": {
+      "type": "string",
+      "description": "Subgraph endpoint URL"
+    },
+    "schemaSource": {
+      "default": "introspection",
+      "description": "How to obtain the subgraph schema",
+      "type": "string",
+      "enum": [
+        "introspection",
+        "file",
+        "registry"
+      ]
+    },
+    "schemaPath": {
+      "description": "Path to schema file (SDL format)",
+      "type": "string"
+    },
+    "entities": {
+      "description": "Entity definitions for this subgraph",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "typeName": {
+            "type": "string",
+            "description": "GraphQL type name for this entity"
+          },
+          "keys": {
+            "minItems": 1,
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "fields": {
+                  "type": "string",
+                  "description": "Selection set of fields composing the entity key"
+                },
+                "resolvable": {
+                  "default": true,
+                  "description": "Whether entities can be resolved from this subgraph",
+                  "type": "boolean"
+                }
+              },
+              "required": [
+                "fields",
+                "resolvable"
+              ],
+              "additionalProperties": false
+            },
+            "description": "Entity key definitions"
+          },
+          "externalFields": {
+            "description": "Fields owned by other subgraphs",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "field": {
+                  "type": "string",
+                  "description": "Field name marked as external"
+                },
+                "ownerSubgraph": {
+                  "description": "Subgraph that owns this field",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "field"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "requires": {
+            "description": "Required external fields for computed fields",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "field": {
+                  "type": "string",
+                  "description": "Field with the requirement"
+                },
+                "fields": {
+                  "type": "string",
+                  "description": "Selection set of required fields (e.g., \"price weight\")"
+                }
+              },
+              "required": [
+                "field",
+                "fields"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "provides": {
+            "description": "Fields provided during resolution",
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "field": {
+                  "type": "string",
+                  "description": "Field that provides additional entity fields"
+                },
+                "fields": {
+                  "type": "string",
+                  "description": "Selection set of provided fields (e.g., \"name price\")"
+                }
+              },
+              "required": [
+                "field",
+                "fields"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "owner": {
+            "default": false,
+            "description": "Whether this subgraph is the owner of this entity",
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "typeName",
+          "keys",
+          "owner"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "healthCheck": {
+      "description": "Subgraph health check configuration",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "default": true,
+          "description": "Enable health checking",
+          "type": "boolean"
+        },
+        "path": {
+          "default": "/health",
+          "description": "Health check endpoint path",
+          "type": "string"
+        },
+        "intervalMs": {
+          "default": 30000,
+          "description": "Health check interval in milliseconds",
+          "type": "integer",
+          "minimum": 1000,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "enabled",
+        "path",
+        "intervalMs"
+      ],
+      "additionalProperties": false
+    },
+    "forwardHeaders": {
+      "description": "HTTP headers to forward to this subgraph",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "name",
+    "url",
+    "schemaSource"
+  ],
+  "additionalProperties": false
+}

package/json-schema/api/WebhookConfig.json

@@ -0,0 +1,129 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "default": false,
+      "description": "Enable webhook support",
+      "type": "boolean"
+    },
+    "events": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "pattern": "^[a-z_][a-z0-9_]*$",
+            "description": "Webhook event identifier (snake_case)"
+          },
+          "description": {
+            "type": "string",
+            "description": "Human-readable event description"
+          },
+          "method": {
+            "default": "POST",
+            "description": "HTTP method for webhook delivery",
+            "type": "string",
+            "enum": [
+              "GET",
+              "POST",
+              "PUT",
+              "DELETE",
+              "PATCH",
+              "HEAD",
+              "OPTIONS"
+            ]
+          },
+          "payloadSchema": {
+            "type": "string",
+            "description": "JSON Schema $ref for the webhook payload"
+          },
+          "headers": {
+            "description": "Custom headers to include in webhook delivery",
+            "type": "object",
+            "propertyNames": {
+              "type": "string"
+            },
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "security": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "hmac_sha256",
+                "basic",
+                "bearer",
+                "api_key"
+              ]
+            },
+            "description": "Supported authentication methods for webhook verification"
+          }
+        },
+        "required": [
+          "name",
+          "description",
+          "method",
+          "payloadSchema",
+          "security"
+        ],
+        "additionalProperties": false
+      },
+      "description": "Registered webhook events"
+    },
+    "deliveryConfig": {
+      "type": "object",
+      "properties": {
+        "maxRetries": {
+          "default": 3,
+          "description": "Maximum delivery retry attempts",
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "retryIntervalMs": {
+          "default": 5000,
+          "description": "Milliseconds between retry attempts",
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "timeoutMs": {
+          "default": 30000,
+          "description": "Delivery request timeout in milliseconds",
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "signatureHeader": {
+          "default": "X-Signature-256",
+          "description": "Header name for webhook signature",
+          "type": "string"
+        }
+      },
+      "required": [
+        "maxRetries",
+        "retryIntervalMs",
+        "timeoutMs",
+        "signatureHeader"
+      ],
+      "additionalProperties": false,
+      "description": "Webhook delivery configuration"
+    },
+    "registrationEndpoint": {
+      "default": "/webhooks",
+      "description": "URL path for webhook registration",
+      "type": "string"
+    }
+  },
+  "required": [
+    "enabled",
+    "events",
+    "deliveryConfig",
+    "registrationEndpoint"
+  ],
+  "additionalProperties": false
+}

package/json-schema/api/WebhookEvent.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "pattern": "^[a-z_][a-z0-9_]*$",
+      "description": "Webhook event identifier (snake_case)"
+    },
+    "description": {
+      "type": "string",
+      "description": "Human-readable event description"
+    },
+    "method": {
+      "default": "POST",
+      "description": "HTTP method for webhook delivery",
+      "type": "string",
+      "enum": [
+        "GET",
+        "POST",
+        "PUT",
+        "DELETE",
+        "PATCH",
+        "HEAD",
+        "OPTIONS"
+      ]
+    },
+    "payloadSchema": {
+      "type": "string",
+      "description": "JSON Schema $ref for the webhook payload"
+    },
+    "headers": {
+      "description": "Custom headers to include in webhook delivery",
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "security": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": [
+          "hmac_sha256",
+          "basic",
+          "bearer",
+          "api_key"
+        ]
+      },
+      "description": "Supported authentication methods for webhook verification"
+    }
+  },
+  "required": [
+    "name",
+    "description",
+    "method",
+    "payloadSchema",
+    "security"
+  ],
+  "additionalProperties": false
+}

package/json-schema/data/ExternalLookup.json

@@ -331,6 +331,134 @@
         "requestsPerSecond"
       ],
       "additionalProperties": false
+    },
+    "retry": {
+      "description": "Retry configuration with exponential backoff",
+      "type": "object",
+      "properties": {
+        "maxRetries": {
+          "default": 3,
+          "description": "Maximum retry attempts",
+          "type": "number",
+          "minimum": 0
+        },
+        "initialDelayMs": {
+          "default": 1000,
+          "description": "Initial retry delay in milliseconds",
+          "type": "number"
+        },
+        "maxDelayMs": {
+          "default": 30000,
+          "description": "Maximum retry delay in milliseconds",
+          "type": "number"
+        },
+        "backoffMultiplier": {
+          "default": 2,
+          "description": "Exponential backoff multiplier",
+          "type": "number"
+        },
+        "retryableStatusCodes": {
+          "default": [
+            429,
+            500,
+            502,
+            503,
+            504
+          ],
+          "description": "HTTP status codes that are retryable",
+          "type": "array",
+          "items": {
+            "type": "number"
+          }
+        }
+      },
+      "required": [
+        "maxRetries",
+        "initialDelayMs",
+        "maxDelayMs",
+        "backoffMultiplier",
+        "retryableStatusCodes"
+      ],
+      "additionalProperties": false
+    },
+    "transform": {
+      "description": "Request/response transformation pipeline",
+      "type": "object",
+      "properties": {
+        "request": {
+          "description": "Request transformation",
+          "type": "object",
+          "properties": {
+            "headers": {
+              "description": "Additional request headers",
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "queryParams": {
+              "description": "Additional query parameters",
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "response": {
+          "description": "Response transformation",
+          "type": "object",
+          "properties": {
+            "dataPath": {
+              "description": "JSONPath to extract data (e.g., \"$.data.results\")",
+              "type": "string"
+            },
+            "totalPath": {
+              "description": "JSONPath to extract total count (e.g., \"$.meta.total\")",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "pagination": {
+      "description": "Pagination configuration for external data",
+      "type": "object",
+      "properties": {
+        "type": {
+          "default": "offset",
+          "description": "Pagination type",
+          "type": "string",
+          "enum": [
+            "offset",
+            "cursor",
+            "page"
+          ]
+        },
+        "pageSize": {
+          "default": 100,
+          "description": "Items per page",
+          "type": "number"
+        },
+        "maxPages": {
+          "description": "Maximum number of pages to fetch",
+          "type": "number"
+        }
+      },
+      "required": [
+        "type",
+        "pageSize"
+      ],
+      "additionalProperties": false
     }
   },
   "required": [

package/json-schema/identity/SCIMBulkOperation.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "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
+}