kaloko 0.3.0

package/schemas/run.v1.json

@@ -0,0 +1,549 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://qawalk.com/schemas/run.v1.json",
+  "title": "Kaloko run manifest (run.json)",
+  "type": "object",
+  "required": [
+    "schema",
+    "id",
+    "scenario",
+    "environment",
+    "started_at",
+    "scope",
+    "nodes",
+    "edges",
+    "summary"
+  ],
+  "properties": {
+    "schema": {
+      "const": "qawalk.run.v1"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}-[a-z0-9-]+$"
+    },
+    "org": {
+      "type": "string"
+    },
+    "scenario": {
+      "type": "object",
+      "required": [
+        "id",
+        "title"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "kind": {
+          "type": "string"
+        },
+        "version": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        },
+        "file": {
+          "type": "string"
+        },
+        "source": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "archived": {
+          "type": "boolean"
+        }
+      }
+    },
+    "git": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "properties": {
+        "branch": {
+          "type": "string"
+        },
+        "commit": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        },
+        "author": {
+          "type": "string"
+        },
+        "pr": {
+          "type": [
+            "object",
+            "null"
+          ],
+          "properties": {
+            "number": {
+              "type": "integer"
+            },
+            "url": {
+              "type": "string"
+            },
+            "state": {
+              "type": "string"
+            }
+          }
+        },
+        "sha": {
+          "type": "string",
+          "description": "Full commit hash (GitHub check runs need it)."
+        }
+      }
+    },
+    "environment": {
+      "type": "object",
+      "required": [
+        "name",
+        "readonly"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "base_url": {},
+        "readonly": {
+          "type": "boolean"
+        }
+      }
+    },
+    "executor": {
+      "type": [
+        "object",
+        "null"
+      ]
+    },
+    "started_at": {
+      "type": "string"
+    },
+    "finished_at": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "scope": {
+      "type": "object",
+      "required": [
+        "locales",
+        "viewports"
+      ],
+      "properties": {
+        "locales": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "viewports": {
+          "type": "object"
+        },
+        "note": {
+          "type": "string"
+        }
+      }
+    },
+    "lanes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "nodes": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/node"
+      }
+    },
+    "edges": {
+      "type": "array"
+    },
+    "summary": {
+      "type": "object",
+      "required": [
+        "pass",
+        "partial",
+        "fail",
+        "skip"
+      ],
+      "properties": {
+        "pass": {
+          "type": "integer"
+        },
+        "partial": {
+          "type": "integer"
+        },
+        "fail": {
+          "type": "integer"
+        },
+        "skip": {
+          "type": "integer"
+        },
+        "criteria": {
+          "type": "object"
+        }
+      }
+    },
+    "history": {
+      "type": "array",
+      "description": "Other runs of the same scenario known at build time."
+    },
+    "version": {
+      "type": [
+        "integer",
+        "string",
+        "null"
+      ],
+      "description": "Number of a design version (#42, integer). Manifests from before #42 used it for the application version (a string); read those as app_version."
+    },
+    "project": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "properties": {
+        "slug": {
+          "type": "string"
+        },
+        "repo": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "source": {
+          "type": "string"
+        }
+      }
+    },
+    "issue": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "properties": {
+        "repo": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "number": {
+          "type": "integer"
+        },
+        "url": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "title": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    },
+    "sessions": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "description": "Sessions declared by the scenario (key → { title, mailbox, account, blocked_on })."
+    },
+    "source": {
+      "enum": [
+        "capture",
+        "design"
+      ],
+      "description": "design: a version of a design draft (#42)."
+    },
+    "version_name": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "parent_version": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Run id of the version this one follows."
+    },
+    "design_branch": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "changed_steps": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Steps whose revision differs from the parent version."
+    },
+    "draft": {
+      "type": "object",
+      "description": "Present when the manifest is a live draft, not a run."
+    },
+    "revisions": {
+      "type": "object",
+      "description": "node|locale → revision, entry, status and author of a draft head."
+    },
+    "app_version": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "description": "Version of the application under test (git tag on HEAD or --app-version); documentation captures carry it."
+    }
+  },
+  "$defs": {
+    "status": {
+      "enum": [
+        "pass",
+        "partial",
+        "fail",
+        "skip"
+      ]
+    },
+    "verdict": {
+      "enum": [
+        "pass",
+        "fail",
+        "needs_review",
+        "not_evaluated",
+        "not_reached"
+      ]
+    },
+    "node": {
+      "type": "object",
+      "required": [
+        "id",
+        "kind",
+        "title",
+        "status"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "kind": {
+          "enum": [
+            "screen",
+            "email",
+            "external",
+            "decision",
+            "stack"
+          ]
+        },
+        "title": {},
+        "path": {},
+        "purpose": {
+          "type": "string"
+        },
+        "col": {
+          "type": "integer"
+        },
+        "lane": {
+          "type": "integer"
+        },
+        "status": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/status"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "by_locale": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/$defs/status"
+          }
+        },
+        "captures": {
+          "type": "object",
+          "description": "locale -> viewport -> files",
+          "additionalProperties": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "properties": {
+                "png": {
+                  "type": "string"
+                },
+                "html": {
+                  "type": ["string", "null"],
+                  "description": "Null for app captures (they carry a UI tree instead)."
+                },
+                "state": {
+                  "type": "string"
+                },
+                "eval": {
+                  "type": [
+                    "string",
+                    "null"
+                  ]
+                },
+                "url": {
+                  "type": ["string", "null"]
+                },
+                "platform": { "type": "string", "description": "App captures: android, ios, electron or desktop." },
+                "device": { "type": ["string", "null"] },
+                "tree": { "type": ["string", "null"], "description": "UI tree of an app capture (qawalk.tree.v1)." },
+                "http_status": {
+                  "type": "integer",
+                  "description": "HTTP status of the captured document (error pages show it on the canvas)."
+                },
+                "size": {
+                  "type": "array"
+                },
+                "boxes": {
+                  "type": "object"
+                },
+                "captured_at": {
+                  "type": "string"
+                },
+                "image": {
+                  "type": "string",
+                  "description": "Full-page screenshot (webp or png)."
+                },
+                "thumb": {
+                  "type": [
+                    "string",
+                    "null"
+                  ],
+                  "description": "Small WebP preview for canvas cards."
+                },
+                "quality": {
+                  "type": "object",
+                  "description": "Capture quality when not the canvas default: format, scale, masked (count), annotations [{n, criterion, x, y}]"
+                }
+              }
+            }
+          }
+        },
+        "criteria": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "id",
+              "text",
+              "verdict"
+            ],
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "text": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string"
+              },
+              "verdict": {
+                "$ref": "#/$defs/verdict"
+              },
+              "by_locale": {
+                "type": "object"
+              },
+              "evidence": {
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "score": {
+                "type": [
+                  "number",
+                  "null"
+                ],
+                "description": "Semantic evaluator probability (0–1) when the criterion is semantic."
+              },
+              "target": {
+                "type": [
+                  "object",
+                  "null"
+                ]
+              },
+              "check": {
+                "type": "object"
+              }
+            }
+          }
+        },
+        "attachments": {
+          "type": "array"
+        },
+        "semantic": {
+          "type": [
+            "object",
+            "null"
+          ],
+          "description": "Semantic evaluator output per 'locale|viewport' (provider, model, answers). The provider is replaceable; JEV is the default."
+        },
+        "metadata": {
+          "type": "object",
+          "description": "Page metadata per locale (meta, links, JSON-LD, microdata, headings)."
+        },
+        "session": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "stack": {
+          "type": "object",
+          "description": "Stack steps: many pages of one template. The pages are in the items file (qawalk.stack.v1); the node carries the counts.",
+          "properties": {
+            "count": {
+              "type": "integer"
+            },
+            "items": {
+              "type": "string"
+            },
+            "summary": {
+              "type": "object"
+            },
+            "fields": {
+              "type": "array"
+            },
+            "sample": {
+              "type": "array"
+            },
+            "semantic_sample": {
+              "type": [
+                "integer",
+                "null"
+              ]
+            },
+            "source": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          }
+        }
+      }
+    }
+  }
+}