Document command simulation contracts

2026-10-25 06:03:35 +01:00
parent ee7b4c5404
commit fece516828
5 changed files with 61 additions and 0 deletions
@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trixie.invalid/contracts/v1/bot-command-simulate-request.json",
+  "title": "Trixie bot command simulation request",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["template"],
+  "properties": {
+    "template": { "type": "string", "minLength": 1, "maxLength": 2000 },
+    "variables": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 2000 } },
+    "web_request": { "type": ["object", "null"] },
+    "sample_response": {},
+    "use_real_request": { "type": "boolean", "default": false },
+    "response_fields": {
+      "type": "array",
+      "maxItems": 128,
+      "items": {
+        "type": "array",
+        "prefixItems": [
+          { "type": "string", "minLength": 1, "maxLength": 64 },
+          { "type": "string", "minLength": 1, "maxLength": 256 }
+        ],
+        "items": false,
+        "minItems": 2,
+        "maxItems": 2
+      }
+    }
+  }
+}
@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trixie.invalid/contracts/v1/bot-command-simulate-response.json",
+  "title": "Trixie bot command simulation response",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["status", "extracted_variables"],
+  "properties": {
+    "status": { "const": "ok" },
+    "rendered": { "type": ["string", "null"], "maxLength": 2000 },
+    "extracted_variables": { "type": "object", "additionalProperties": { "type": "string" } },
+    "error": { "type": ["string", "null"], "maxLength": 500 }
+  }
+}