@objectstack/spec 2.0.5 → 2.0.7

package/json-schema/api/FederationEntity.json

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

package/json-schema/api/FederationEntityKey.json

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

package/json-schema/api/FederationExternalField.json

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

package/json-schema/api/FederationGateway.json

@@ -0,0 +1,327 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "enabled": {
+      "default": false,
+      "description": "Enable GraphQL Federation gateway mode",
+      "type": "boolean"
+    },
+    "version": {
+      "default": "v2",
+      "description": "Federation specification version",
+      "type": "string",
+      "enum": [
+        "v1",
+        "v2"
+      ]
+    },
+    "subgraphs": {
+      "type": "array",
+      "items": {
+        "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
+      },
+      "description": "Subgraph configurations"
+    },
+    "serviceDiscovery": {
+      "description": "Service discovery configuration",
+      "type": "object",
+      "properties": {
+        "type": {
+          "default": "static",
+          "description": "Service discovery method",
+          "type": "string",
+          "enum": [
+            "static",
+            "dns",
+            "consul",
+            "kubernetes"
+          ]
+        },
+        "pollIntervalMs": {
+          "description": "Discovery poll interval in milliseconds",
+          "type": "integer",
+          "minimum": 1000,
+          "maximum": 9007199254740991
+        },
+        "namespace": {
+          "description": "Kubernetes namespace for subgraph discovery",
+          "type": "string"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "additionalProperties": false
+    },
+    "queryPlanning": {
+      "description": "Query planning configuration",
+      "type": "object",
+      "properties": {
+        "strategy": {
+          "default": "parallel",
+          "description": "Query execution strategy across subgraphs",
+          "type": "string",
+          "enum": [
+            "parallel",
+            "sequential",
+            "adaptive"
+          ]
+        },
+        "maxDepth": {
+          "description": "Max query depth in federated execution",
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991
+        },
+        "dryRun": {
+          "default": false,
+          "description": "Log query plans without executing",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "strategy",
+        "dryRun"
+      ],
+      "additionalProperties": false
+    },
+    "composition": {
+      "description": "Schema composition configuration",
+      "type": "object",
+      "properties": {
+        "conflictResolution": {
+          "default": "error",
+          "description": "Strategy for resolving schema conflicts",
+          "type": "string",
+          "enum": [
+            "error",
+            "first_wins",
+            "last_wins"
+          ]
+        },
+        "validate": {
+          "default": true,
+          "description": "Validate composed supergraph schema",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "conflictResolution",
+        "validate"
+      ],
+      "additionalProperties": false
+    },
+    "errorHandling": {
+      "description": "Error handling configuration",
+      "type": "object",
+      "properties": {
+        "includeSubgraphName": {
+          "default": false,
+          "description": "Include subgraph name in error responses",
+          "type": "boolean"
+        },
+        "partialErrors": {
+          "default": "propagate",
+          "description": "Behavior when a subgraph returns partial errors",
+          "type": "string",
+          "enum": [
+            "propagate",
+            "nullify",
+            "reject"
+          ]
+        }
+      },
+      "required": [
+        "includeSubgraphName",
+        "partialErrors"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "enabled",
+    "version",
+    "subgraphs"
+  ],
+  "additionalProperties": false
+}

package/json-schema/api/FederationProvides.json

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

package/json-schema/api/FederationRequires.json

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

package/json-schema/api/GetDiscoveryResponse.json

@@ -10,66 +10,7 @@
       "type": "string",
       "description": "API name"
     },
-    "capabilities": {
-      "description": "Supported features/capabilities",
-      "type": "object",
-      "properties": {
-        "graphql": {
-          "default": false,
-          "type": "boolean"
-        },
-        "search": {
-          "default": false,
-          "type": "boolean"
-        },
-        "websockets": {
-          "default": false,
-          "type": "boolean"
-        },
-        "files": {
-          "default": true,
-          "type": "boolean"
-        },
-        "analytics": {
-          "default": false,
-          "description": "Is the Analytics/BI engine enabled?",
-          "type": "boolean"
-        },
-        "ai": {
-          "default": false,
-          "description": "Is the AI engine enabled?",
-          "type": "boolean"
-        },
-        "workflow": {
-          "default": false,
-          "description": "Is the Workflow engine enabled?",
-          "type": "boolean"
-        },
-        "notifications": {
-          "default": false,
-          "description": "Is the Notification service enabled?",
-          "type": "boolean"
-        },
-        "i18n": {
-          "default": false,
-          "description": "Is the i18n service enabled?",
-          "type": "boolean"
-        }
-      },
-      "required": [
-        "graphql",
-        "search",
-        "websockets",
-        "files",
-        "analytics",
-        "ai",
-        "workflow",
-        "notifications",
-        "i18n"
-      ],
-      "additionalProperties": false
-    },
-    "endpoints": {
+    "routes": {
       "description": "Available endpoint paths",
       "type": "object",
       "properties": {

package/json-schema/api/GetPackageResponse.json

@@ -391,6 +391,32 @@
                     ],
                     "additionalProperties": false
                   }
+                },
+                "commands": {
+                  "description": "CLI command contributions",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "name": {
+                        "type": "string",
+                        "pattern": "^[a-z][a-z0-9-]*$",
+                        "description": "CLI command name"
+                      },
+                      "description": {
+                        "description": "Command description for help text",
+                        "type": "string"
+                      },
+                      "module": {
+                        "description": "Module path exporting Commander.js commands",
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "name"
+                    ],
+                    "additionalProperties": false
+                  }
                 }
               },
               "additionalProperties": false