@pienter/ui 0.5.0 → 0.8.0

package/utils/cms/schema.json

@@ -0,0 +1,126 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "urn:pienter:cms:backend:v1",
+  "title": "Pienter CMS backend contract v1",
+  "description": "Common response envelopes and normalized list query. Validate domain records and endpoint-specific sort/filter rules separately.",
+  "oneOf": [
+    { "$ref": "#/$defs/ListResponse" },
+    { "$ref": "#/$defs/ItemResponse" },
+    { "$ref": "#/$defs/ErrorResponse" },
+    { "$ref": "#/$defs/ListQuery" }
+  ],
+  "$defs": {
+    "Record": {
+      "type": "object",
+      "description": "A domain record whose properties are defined by the endpoint.",
+      "additionalProperties": true
+    },
+    "ListResponse": {
+      "type": "object",
+      "required": ["data", "meta"],
+      "additionalProperties": false,
+      "properties": {
+        "data": { "type": "array", "items": { "$ref": "#/$defs/Record" } },
+        "meta": {
+          "type": "object",
+          "required": ["page", "page_size", "total"],
+          "additionalProperties": false,
+          "properties": {
+            "page": { "$ref": "#/$defs/Page" },
+            "page_size": { "$ref": "#/$defs/PageSize" },
+            "total": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            }
+          }
+        }
+      }
+    },
+    "ItemResponse": {
+      "type": "object",
+      "required": ["data"],
+      "additionalProperties": false,
+      "properties": { "data": { "$ref": "#/$defs/Record" } }
+    },
+    "ErrorResponse": {
+      "type": "object",
+      "required": ["error"],
+      "additionalProperties": false,
+      "properties": {
+        "error": {
+          "type": "object",
+          "required": ["code", "message"],
+          "additionalProperties": false,
+          "properties": {
+            "code": { "type": "string", "minLength": 1 },
+            "message": { "type": "string", "minLength": 1 },
+            "issues": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/ValidationIssue" }
+            }
+          }
+        }
+      }
+    },
+    "ValidationIssue": {
+      "type": "object",
+      "required": ["path", "messages"],
+      "additionalProperties": false,
+      "properties": {
+        "path": {
+          "type": "array",
+          "description": "Object keys and zero-based array positions in the submitted value; an empty array addresses the whole value.",
+          "items": {
+            "oneOf": [
+              { "type": "string", "minLength": 1 },
+              { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }
+            ]
+          }
+        },
+        "messages": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "type": "string", "minLength": 1 }
+        }
+      }
+    },
+    "ListQuery": {
+      "type": "object",
+      "description": "Normalized output from decoding URL query parameters, after defaults are applied. This is not a JSON request body.",
+      "required": ["page", "page_size", "search", "sort", "filters"],
+      "additionalProperties": false,
+      "properties": {
+        "page": { "$ref": "#/$defs/Page", "default": 1 },
+        "page_size": { "$ref": "#/$defs/PageSize", "default": 20 },
+        "search": { "type": "string", "default": "" },
+        "sort": {
+          "default": null,
+          "oneOf": [
+            { "type": "null" },
+            {
+              "type": "object",
+              "required": ["key", "direction"],
+              "additionalProperties": false,
+              "properties": {
+                "key": { "type": "string", "minLength": 1 },
+                "direction": { "enum": ["asc", "desc"] }
+              }
+            }
+          ]
+        },
+        "filters": {
+          "type": "object",
+          "default": {},
+          "propertyNames": {
+            "pattern": "^[a-zA-Z0-9_]+$",
+            "not": { "enum": ["__proto__", "prototype", "constructor"] }
+          },
+          "additionalProperties": { "type": "string" }
+        }
+      }
+    },
+    "Page": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 },
+    "PageSize": { "type": "integer", "minimum": 1, "maximum": 100 }
+  }
+}