@haystackeditor/cli 0.25.1 → 0.26.0

package/schemas/verify.v2.json

@@ -0,0 +1,655 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://docs.haystackeditor.com/cli/schemas/verify.v2.json",
+  "title": "Haystack verify: the report on the current change",
+  "description": "Machine-readable output of `haystack verify --json`: what the text report says, as data. `crawl` is null when there was nothing to verify or no crawl could be started; `onboarding` is set when onboarding stood in the way. The service's whole crawl record is `haystack verify --raw` (`haystack schema verify-raw`).",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema_version",
+    "crawl"
+  ],
+  "properties": {
+    "schema_version": {
+      "const": "2.0.0"
+    },
+    "change": {
+      "description": "Schema 1.0.2: what this verify checked: the capture's base commit (where HEAD meets origin's default branch), its work commit (committed and uncommitted changes), and the files that differ between them.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "baseCommit",
+        "workCommit",
+        "files"
+      ],
+      "properties": {
+        "baseCommit": {
+          "$ref": "#/$defs/commit"
+        },
+        "workCommit": {
+          "$ref": "#/$defs/commit"
+        },
+        "files": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "onboarding": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "$ref": "#/$defs/onboardingStatus"
+        }
+      ]
+    },
+    "crawl": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "runId",
+            "repository",
+            "title",
+            "baseCommit",
+            "workCommit",
+            "status",
+            "headline",
+            "bugs",
+            "findings",
+            "spots",
+            "ideas",
+            "neverRan",
+            "notFinishedInTime",
+            "outsideServiceGaps",
+            "error",
+            "machinesNotProvenShutDown"
+          ],
+          "properties": {
+            "runId": {
+              "$ref": "#/$defs/runId"
+            },
+            "repository": {
+              "type": "string"
+            },
+            "title": {
+              "type": "string",
+              "description": "The change title the crawl's judge read."
+            },
+            "baseCommit": {
+              "$ref": "#/$defs/commit"
+            },
+            "workCommit": {
+              "$ref": "#/$defs/commit"
+            },
+            "status": {
+              "$ref": "#/$defs/status",
+              "description": "As reported: a running crawl that has answered reads as completed."
+            },
+            "headline": {
+              "type": "string",
+              "description": "One sentence: how many bugs it found, none, or why it could not finish."
+            },
+            "bugs": {
+              "$ref": "#/$defs/count"
+            },
+            "findings": {
+              "description": "Bugs first, then the undecided, then what the judge called intended.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "id",
+                  "verdict",
+                  "why",
+                  "start",
+                  "steps",
+                  "outsideServices"
+                ],
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "verdict": {
+                    "enum": [
+                      "bug",
+                      "cant-tell",
+                      "being-judged",
+                      "not-a-bug"
+                    ]
+                  },
+                  "why": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "start": {
+                    "type": "string",
+                    "description": "Where the steps start."
+                  },
+                  "steps": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "The steps to see it."
+                  },
+                  "outsideServices": {
+                    "description": "Outside-service calls on its path, answered by Haystack stand-ins; null when none.",
+                    "oneOf": [
+                      {
+                        "type": "null"
+                      },
+                      {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": [
+                          "withoutChange",
+                          "withChange"
+                        ],
+                        "properties": {
+                          "withoutChange": {
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "withChange": {
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                          }
+                        }
+                      }
+                    ]
+                  }
+                }
+              }
+            },
+            "spots": {
+              "description": "Every changed spot and how far the crawl got with it, in words.",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "file",
+                  "line",
+                  "reached",
+                  "reachedBy",
+                  "findingIds"
+                ],
+                "properties": {
+                  "file": {
+                    "type": "string"
+                  },
+                  "line": {
+                    "type": "integer",
+                    "minimum": 1
+                  },
+                  "reached": {
+                    "type": "string"
+                  },
+                  "reachedBy": {
+                    "oneOf": [
+                      {
+                        "type": "null"
+                      },
+                      {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": [
+                          "start",
+                          "steps",
+                          "page"
+                        ],
+                        "properties": {
+                          "start": {
+                            "type": "string"
+                          },
+                          "steps": {
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "page": {
+                            "type": [
+                              "string",
+                              "null"
+                            ]
+                          }
+                        }
+                      }
+                    ]
+                  },
+                  "findingIds": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            },
+            "ideas": {
+              "description": "What became of each idea the agent gave; null when it gave none.",
+              "oneOf": [
+                {
+                  "type": "null"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                      "text",
+                      "result",
+                      "reason",
+                      "findingIds"
+                    ],
+                    "properties": {
+                      "text": {
+                        "type": "string"
+                      },
+                      "result": {
+                        "enum": [
+                          "tried",
+                          "could not try",
+                          "not finished"
+                        ]
+                      },
+                      "reason": {
+                        "type": "string"
+                      },
+                      "findingIds": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  }
+                }
+              ]
+            },
+            "neverRan": {
+              "description": "Changed code no path ran; null until the crawl has explored.",
+              "oneOf": [
+                {
+                  "type": "null"
+                },
+                {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": [
+                    "files",
+                    "functions"
+                  ],
+                  "properties": {
+                    "files": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "functions": {
+                      "oneOf": [
+                        {
+                          "type": "null"
+                        },
+                        {
+                          "type": "object",
+                          "additionalProperties": false,
+                          "required": [
+                            "ran",
+                            "total"
+                          ],
+                          "properties": {
+                            "ran": {
+                              "$ref": "#/$defs/count"
+                            },
+                            "total": {
+                              "$ref": "#/$defs/count"
+                            }
+                          }
+                        }
+                      ]
+                    }
+                  }
+                }
+              ]
+            },
+            "notFinishedInTime": {
+              "$ref": "#/$defs/count"
+            },
+            "outsideServiceGaps": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Calls the copy's stand-ins could not serve: missing coverage, never bugs."
+            },
+            "error": {
+              "oneOf": [
+                {
+                  "type": "null"
+                },
+                {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": [
+                    "code",
+                    "message"
+                  ],
+                  "properties": {
+                    "code": {
+                      "type": "string"
+                    },
+                    "message": {
+                      "type": "string"
+                    }
+                  }
+                }
+              ]
+            },
+            "machinesNotProvenShutDown": {
+              "$ref": "#/$defs/count"
+            }
+          }
+        }
+      ]
+    }
+  },
+  "$defs": {
+    "runId": {
+      "type": "string",
+      "pattern": "^cv_[0-9a-f]{48}$"
+    },
+    "commit": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{40}$"
+    },
+    "count": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "status": {
+      "enum": [
+        "queued",
+        "preparing",
+        "crawling",
+        "draining",
+        "completed",
+        "prepared",
+        "incomplete",
+        "cancelled"
+      ]
+    },
+    "onboardingStatus": {
+      "type": "object",
+      "required": [
+        "version",
+        "repository",
+        "baseCommit",
+        "state",
+        "onboardRunId",
+        "recordDigest",
+        "checkpoint",
+        "block",
+        "dataAbsences",
+        "versionChoices"
+      ],
+      "properties": {
+        "version": {
+          "const": "app-onboarding-v1"
+        },
+        "repository": {
+          "type": "string"
+        },
+        "baseCommit": {
+          "$ref": "#/$defs/commit"
+        },
+        "state": {
+          "enum": [
+            "ready",
+            "onboarding",
+            "blocked",
+            "incomplete",
+            "cancelled",
+            "not-started"
+          ]
+        },
+        "onboardRunId": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "string",
+              "pattern": "^ob_[0-9a-f]{48}$"
+            }
+          ]
+        },
+        "recordDigest": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "string",
+              "pattern": "^[0-9a-f]{64}$"
+            }
+          ]
+        },
+        "checkpoint": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "object",
+              "required": [
+                "status",
+                "stage",
+                "execution",
+                "owned"
+              ],
+              "properties": {
+                "status": {
+                  "enum": [
+                    "queued",
+                    "running",
+                    "cleanup-pending",
+                    "published",
+                    "reused",
+                    "blocked",
+                    "incomplete",
+                    "cancelled"
+                  ]
+                },
+                "stage": {
+                  "enum": [
+                    "inventory",
+                    "plan",
+                    "runtime",
+                    "boot",
+                    "data",
+                    "accounts",
+                    "workflow",
+                    "publish",
+                    "cleanup"
+                  ]
+                },
+                "owned": {
+                  "$ref": "#/$defs/strings"
+                },
+                "execution": {
+                  "type": "object",
+                  "required": [
+                    "stages"
+                  ],
+                  "properties": {
+                    "stages": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "stage",
+                          "status"
+                        ],
+                        "properties": {
+                          "stage": {
+                            "enum": [
+                              "inventory",
+                              "plan",
+                              "runtime",
+                              "boot",
+                              "data",
+                              "accounts",
+                              "workflow",
+                              "publish",
+                              "cleanup"
+                            ]
+                          },
+                          "status": {
+                            "enum": [
+                              "pending",
+                              "running",
+                              "ok",
+                              "reused",
+                              "failed",
+                              "blocked"
+                            ]
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "block": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "$ref": "#/$defs/onboardingBlock"
+            }
+          ]
+        },
+        "dataAbsences": {
+          "$ref": "#/$defs/strings"
+        },
+        "versionChoices": {
+          "$ref": "#/$defs/strings"
+        }
+      }
+    },
+    "onboardingBlock": {
+      "type": "object",
+      "required": [
+        "kind",
+        "stage",
+        "reason",
+        "evidence",
+        "ask"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "not-enabled",
+            "no-web-app",
+            "unsupported",
+            "question",
+            "outside-credential",
+            "outside-dependency",
+            "evidence-too-large",
+            "budget",
+            "proof-failed"
+          ]
+        },
+        "stage": {
+          "enum": [
+            "admission",
+            "inventory",
+            "plan",
+            "runtime",
+            "boot",
+            "data",
+            "accounts",
+            "workflow",
+            "publish",
+            "cleanup"
+          ]
+        },
+        "reason": {
+          "type": "string"
+        },
+        "evidence": {
+          "$ref": "#/$defs/strings"
+        },
+        "names": {
+          "$ref": "#/$defs/strings"
+        },
+        "ask": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "object",
+              "required": [
+                "message"
+              ],
+              "properties": {
+                "message": {
+                  "type": "string"
+                },
+                "command": {
+                  "type": "string"
+                },
+                "question": {
+                  "type": "object",
+                  "required": [
+                    "id",
+                    "choices"
+                  ],
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "choices": {
+                      "$ref": "#/$defs/strings"
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "strings": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  }
+}