@objectstack/spec 0.3.2 → 0.4.1

package/json-schema/{system → api}/HttpMethod.json

@@ -8,7 +8,9 @@
         "POST",
         "PUT",
         "DELETE",
-        "PATCH"
+        "PATCH",
+        "HEAD",
+        "OPTIONS"
       ]
     }
   },

package/json-schema/api/ODataError.json

@@ -0,0 +1,65 @@
+{
+  "$ref": "#/definitions/ODataError",
+  "definitions": {
+    "ODataError": {
+      "type": "object",
+      "properties": {
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code"
+            },
+            "message": {
+              "type": "string",
+              "description": "Error message"
+            },
+            "target": {
+              "type": "string",
+              "description": "Error target"
+            },
+            "details": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "code": {
+                    "type": "string"
+                  },
+                  "message": {
+                    "type": "string"
+                  },
+                  "target": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "code",
+                  "message"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Error details"
+            },
+            "innererror": {
+              "type": "object",
+              "additionalProperties": {},
+              "description": "Inner error details"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "error"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/ODataFilterFunction.json

@@ -0,0 +1,39 @@
+{
+  "$ref": "#/definitions/ODataFilterFunction",
+  "definitions": {
+    "ODataFilterFunction": {
+      "type": "string",
+      "enum": [
+        "contains",
+        "startswith",
+        "endswith",
+        "length",
+        "indexof",
+        "substring",
+        "tolower",
+        "toupper",
+        "trim",
+        "concat",
+        "year",
+        "month",
+        "day",
+        "hour",
+        "minute",
+        "second",
+        "date",
+        "time",
+        "now",
+        "maxdatetime",
+        "mindatetime",
+        "round",
+        "floor",
+        "ceiling",
+        "cast",
+        "isof",
+        "any",
+        "all"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/ODataFilterOperator.json

@@ -0,0 +1,24 @@
+{
+  "$ref": "#/definitions/ODataFilterOperator",
+  "definitions": {
+    "ODataFilterOperator": {
+      "type": "string",
+      "enum": [
+        "eq",
+        "ne",
+        "lt",
+        "le",
+        "gt",
+        "ge",
+        "and",
+        "or",
+        "not",
+        "(",
+        ")",
+        "in",
+        "has"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/ODataMetadata.json

@@ -0,0 +1,115 @@
+{
+  "$ref": "#/definitions/ODataMetadata",
+  "definitions": {
+    "ODataMetadata": {
+      "type": "object",
+      "properties": {
+        "namespace": {
+          "type": "string",
+          "description": "Service namespace"
+        },
+        "entityTypes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Entity type name"
+              },
+              "key": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Key fields"
+              },
+              "properties": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "OData type (Edm.String, Edm.Int32, etc.)"
+                    },
+                    "nullable": {
+                      "type": "boolean",
+                      "default": true
+                    }
+                  },
+                  "required": [
+                    "name",
+                    "type"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "navigationProperties": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "type": {
+                      "type": "string"
+                    },
+                    "partner": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "name",
+                    "type"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "required": [
+              "name",
+              "key",
+              "properties"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Entity types"
+        },
+        "entitySets": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Entity set name"
+              },
+              "entityType": {
+                "type": "string",
+                "description": "Entity type"
+              }
+            },
+            "required": [
+              "name",
+              "entityType"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Entity sets"
+        }
+      },
+      "required": [
+        "namespace",
+        "entityTypes",
+        "entitySets"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/ODataQuery.json

@@ -0,0 +1,89 @@
+{
+  "$ref": "#/definitions/ODataQuery",
+  "definitions": {
+    "ODataQuery": {
+      "type": "object",
+      "properties": {
+        "$select": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ],
+          "description": "Fields to select"
+        },
+        "$filter": {
+          "type": "string",
+          "description": "Filter expression (OData filter syntax)"
+        },
+        "$orderby": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ],
+          "description": "Sort order"
+        },
+        "$top": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Max results to return"
+        },
+        "$skip": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Results to skip"
+        },
+        "$expand": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ],
+          "description": "Navigation properties to expand"
+        },
+        "$count": {
+          "type": "boolean",
+          "description": "Include total count"
+        },
+        "$search": {
+          "type": "string",
+          "description": "Search expression"
+        },
+        "$format": {
+          "type": "string",
+          "enum": [
+            "json",
+            "xml",
+            "atom"
+          ],
+          "description": "Response format"
+        },
+        "$apply": {
+          "type": "string",
+          "description": "Aggregation expression"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/ODataResponse.json

@@ -0,0 +1,37 @@
+{
+  "$ref": "#/definitions/ODataResponse",
+  "definitions": {
+    "ODataResponse": {
+      "type": "object",
+      "properties": {
+        "@odata.context": {
+          "type": "string",
+          "format": "uri",
+          "description": "Metadata context URL"
+        },
+        "@odata.count": {
+          "type": "integer",
+          "description": "Total results count"
+        },
+        "@odata.nextLink": {
+          "type": "string",
+          "format": "uri",
+          "description": "Next page URL"
+        },
+        "value": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": {}
+          },
+          "description": "Results array"
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/RouteCategory.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/RouteCategory",
+  "definitions": {
+    "RouteCategory": {
+      "type": "string",
+      "enum": [
+        "system",
+        "api",
+        "auth",
+        "static",
+        "webhook",
+        "plugin"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/RouteDefinition.json

@@ -0,0 +1,77 @@
+{
+  "$ref": "#/definitions/RouteDefinition",
+  "definitions": {
+    "RouteDefinition": {
+      "type": "object",
+      "properties": {
+        "method": {
+          "type": "string",
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "DELETE",
+            "PATCH",
+            "HEAD",
+            "OPTIONS"
+          ]
+        },
+        "path": {
+          "type": "string",
+          "description": "URL Path pattern"
+        },
+        "category": {
+          "type": "string",
+          "enum": [
+            "system",
+            "api",
+            "auth",
+            "static",
+            "webhook",
+            "plugin"
+          ],
+          "default": "api"
+        },
+        "handler": {
+          "type": "string",
+          "description": "Unique handler identifier"
+        },
+        "summary": {
+          "type": "string",
+          "description": "OpenAPI summary"
+        },
+        "description": {
+          "type": "string",
+          "description": "OpenAPI description"
+        },
+        "public": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is publicly accessible"
+        },
+        "permissions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Required permissions"
+        },
+        "timeout": {
+          "type": "integer",
+          "description": "Execution timeout in ms"
+        },
+        "rateLimit": {
+          "type": "string",
+          "description": "Rate limit policy name"
+        }
+      },
+      "required": [
+        "method",
+        "path",
+        "handler"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/api/RouterConfig.json

@@ -0,0 +1,117 @@
+{
+  "$ref": "#/definitions/RouterConfig",
+  "definitions": {
+    "RouterConfig": {
+      "type": "object",
+      "properties": {
+        "basePath": {
+          "type": "string",
+          "default": "/api",
+          "description": "Global API prefix"
+        },
+        "mounts": {
+          "type": "object",
+          "properties": {
+            "data": {
+              "type": "string",
+              "default": "/data",
+              "description": "Data Protocol (CRUD)"
+            },
+            "metadata": {
+              "type": "string",
+              "default": "/meta",
+              "description": "Metadata Protocol (Schemas)"
+            },
+            "auth": {
+              "type": "string",
+              "default": "/auth",
+              "description": "Auth Protocol"
+            },
+            "automation": {
+              "type": "string",
+              "default": "/automation",
+              "description": "Automation Protocol"
+            },
+            "storage": {
+              "type": "string",
+              "default": "/storage",
+              "description": "Storage Protocol"
+            },
+            "graphql": {
+              "type": "string",
+              "default": "/graphql",
+              "description": "GraphQL Endpoint"
+            }
+          },
+          "additionalProperties": false,
+          "default": {}
+        },
+        "cors": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true
+            },
+            "origin": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ],
+              "default": "*"
+            },
+            "methods": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "GET",
+                  "POST",
+                  "PUT",
+                  "DELETE",
+                  "PATCH",
+                  "HEAD",
+                  "OPTIONS"
+                ]
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "staticMounts": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": {
+                "type": "string",
+                "description": "URL mount path"
+              },
+              "dir": {
+                "type": "string",
+                "description": "Physical directory path"
+              },
+              "cacheControl": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "path",
+              "dir"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/{system → auth}/Role.json

@@ -6,8 +6,9 @@
       "properties": {
         "name": {
           "type": "string",
-          "pattern": "^[a-z_][a-z0-9_]*$",
-          "description": "Unique role name"
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "Unique role name (lowercase snake_case)"
         },
         "label": {
           "type": "string",

package/json-schema/auth/SCIMAddress.json

@@ -0,0 +1,50 @@
+{
+  "$ref": "#/definitions/SCIMAddress",
+  "definitions": {
+    "SCIMAddress": {
+      "type": "object",
+      "properties": {
+        "formatted": {
+          "type": "string",
+          "description": "Formatted address"
+        },
+        "streetAddress": {
+          "type": "string",
+          "description": "Street address"
+        },
+        "locality": {
+          "type": "string",
+          "description": "City/Locality"
+        },
+        "region": {
+          "type": "string",
+          "description": "State/Region"
+        },
+        "postalCode": {
+          "type": "string",
+          "description": "Postal code"
+        },
+        "country": {
+          "type": "string",
+          "description": "Country"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "work",
+            "home",
+            "other"
+          ],
+          "description": "Address type"
+        },
+        "primary": {
+          "type": "boolean",
+          "default": false,
+          "description": "Primary address indicator"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}