@crvouga/atlas 0.3.0 → 0.5.0

package/packages/schema/schemas/check-detail.schema.json

@@ -0,0 +1,1032 @@
+{
+  "$id": "https://github.com/crvouga/atlas/schemas/check-detail.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "layer": {
+      "type": "string"
+    },
+    "kind": {
+      "type": "string"
+    },
+    "check": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The check's stable identity within its producer. The same check must keep the same id in every layer, or layers cannot replace one another",
+          "type": "string",
+          "minLength": 1
+        },
+        "title": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "passed",
+            "failed",
+            "running",
+            "not-run"
+          ]
+        },
+        "detail": {
+          "description": "Why it failed, or what was measured",
+          "default": "",
+          "type": "string"
+        },
+        "specPath": {
+          "description": "The spec this check belongs to, relative to the repository, such as specs/join.feature",
+          "type": "string"
+        },
+        "measurements": {
+          "default": [],
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "minLength": 1
+              },
+              "value": {
+                "description": "A finite number",
+                "type": "number"
+              },
+              "unit": {
+                "type": "string"
+              },
+              "limit": {
+                "description": "The allowance. A measurement over it is reported, and never fails the check by itself",
+                "type": "number"
+              }
+            },
+            "required": [
+              "name",
+              "value",
+              "unit"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "durationMs": {
+          "description": "How long the check took, when the producer measured it",
+          "type": "number",
+          "minimum": 0
+        },
+        "tags": {
+          "description": "Free labels to filter and group by: smoke, slow, flaky…",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "labels": {
+          "description": "Facts about the result, not part of its identity: owner, severity, browser, os, build. Unlike `parameters` they never split a result into another slot",
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "links": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "url": {
+                "type": "string",
+                "minLength": 1
+              },
+              "name": {
+                "type": "string"
+              },
+              "rel": {
+                "description": "Why it is linked, in an open vocabulary: issue, run, trace, docs, source…",
+                "type": "string"
+              }
+            },
+            "required": [
+              "url"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "attachments": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "description": "Lets another attachment, step or annotation refer to this one",
+                "type": "string"
+              },
+              "name": {
+                "type": "string",
+                "minLength": 1
+              },
+              "role": {
+                "type": "string"
+              },
+              "contentType": {
+                "description": "An IANA media type. Absent means application/octet-stream",
+                "type": "string"
+              },
+              "bundleKey": {
+                "description": "The key of its bytes in the layer",
+                "type": "string"
+              },
+              "uri": {
+                "description": "Where else to read it: an https URL, or a path a host understands",
+                "type": "string"
+              },
+              "text": {
+                "description": "A small UTF-8 value, inline",
+                "type": "string"
+              },
+              "bytes": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "sha256": {
+                "type": "string"
+              },
+              "width": {
+                "type": "number",
+                "minimum": 0
+              },
+              "height": {
+                "type": "number",
+                "minimum": 0
+              },
+              "durationMs": {
+                "description": "For video and audio",
+                "type": "number",
+                "minimum": 0
+              },
+              "description": {
+                "type": "string"
+              },
+              "at": {
+                "type": "object",
+                "properties": {
+                  "step": {
+                    "description": "The `id` of a step",
+                    "type": "string"
+                  },
+                  "offsetMs": {
+                    "type": "number",
+                    "minimum": 0
+                  }
+                },
+                "additionalProperties": {}
+              },
+              "poster": {
+                "description": "The `id` of an attachment that stands for this one before it is opened",
+                "type": "string"
+              },
+              "captions": {
+                "description": "The `id`s of attachments (WebVTT, SRT) that caption this one",
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "extensions": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "additionalProperties": {}
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "annotations": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "description": "An open vocabulary: note, warning, deprecation, issue, accessibility, coverage…",
+                "type": "string",
+                "minLength": 1
+              },
+              "message": {
+                "type": "string"
+              },
+              "level": {
+                "description": "Conventionally info, warning or error. Anything else is shown as a note",
+                "type": "string"
+              },
+              "at": {
+                "type": "object",
+                "properties": {
+                  "step": {
+                    "description": "The `id` of a step",
+                    "type": "string"
+                  },
+                  "offsetMs": {
+                    "type": "number",
+                    "minimum": 0
+                  }
+                },
+                "additionalProperties": {}
+              },
+              "source": {
+                "type": "object",
+                "properties": {
+                  "file": {
+                    "type": "string"
+                  },
+                  "line": {
+                    "type": "integer",
+                    "minimum": -9007199254740991,
+                    "maximum": 9007199254740991
+                  },
+                  "column": {
+                    "type": "integer",
+                    "minimum": -9007199254740991,
+                    "maximum": 9007199254740991
+                  }
+                },
+                "additionalProperties": {}
+              },
+              "links": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "url": {
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "rel": {
+                      "description": "Why it is linked, in an open vocabulary: issue, run, trace, docs, source…",
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "url"
+                  ],
+                  "additionalProperties": {}
+                }
+              },
+              "extensions": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "additionalProperties": {}
+              }
+            },
+            "required": [
+              "type",
+              "message"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "extensions": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "minLength": 1
+          },
+          "additionalProperties": {}
+        },
+        "steps": {
+          "description": "The check's timeline",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "parentId": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "kind": {
+                "description": "An open vocabulary: action, assertion, hook, request, span, given, when, then…",
+                "type": "string"
+              },
+              "status": {
+                "description": "Conventionally passed, failed, skipped. Anything else is shown as it is",
+                "type": "string"
+              },
+              "offsetMs": {
+                "description": "When it started, after the check did",
+                "type": "number",
+                "minimum": 0
+              },
+              "durationMs": {
+                "type": "number",
+                "minimum": 0
+              },
+              "detail": {
+                "type": "string"
+              },
+              "attachments": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "description": "Lets another attachment, step or annotation refer to this one",
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "role": {
+                      "type": "string"
+                    },
+                    "contentType": {
+                      "description": "An IANA media type. Absent means application/octet-stream",
+                      "type": "string"
+                    },
+                    "bundleKey": {
+                      "description": "The key of its bytes in the layer",
+                      "type": "string"
+                    },
+                    "uri": {
+                      "description": "Where else to read it: an https URL, or a path a host understands",
+                      "type": "string"
+                    },
+                    "text": {
+                      "description": "A small UTF-8 value, inline",
+                      "type": "string"
+                    },
+                    "bytes": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "maximum": 9007199254740991
+                    },
+                    "sha256": {
+                      "type": "string"
+                    },
+                    "width": {
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "height": {
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "durationMs": {
+                      "description": "For video and audio",
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "description": {
+                      "type": "string"
+                    },
+                    "at": {
+                      "type": "object",
+                      "properties": {
+                        "step": {
+                          "description": "The `id` of a step",
+                          "type": "string"
+                        },
+                        "offsetMs": {
+                          "type": "number",
+                          "minimum": 0
+                        }
+                      },
+                      "additionalProperties": {}
+                    },
+                    "poster": {
+                      "description": "The `id` of an attachment that stands for this one before it is opened",
+                      "type": "string"
+                    },
+                    "captions": {
+                      "description": "The `id`s of attachments (WebVTT, SRT) that caption this one",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "extensions": {
+                      "type": "object",
+                      "propertyNames": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "additionalProperties": {}
+                    }
+                  },
+                  "required": [
+                    "name"
+                  ],
+                  "additionalProperties": {}
+                }
+              },
+              "annotations": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "description": "An open vocabulary: note, warning, deprecation, issue, accessibility, coverage…",
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "message": {
+                      "type": "string"
+                    },
+                    "level": {
+                      "description": "Conventionally info, warning or error. Anything else is shown as a note",
+                      "type": "string"
+                    },
+                    "at": {
+                      "type": "object",
+                      "properties": {
+                        "step": {
+                          "description": "The `id` of a step",
+                          "type": "string"
+                        },
+                        "offsetMs": {
+                          "type": "number",
+                          "minimum": 0
+                        }
+                      },
+                      "additionalProperties": {}
+                    },
+                    "source": {
+                      "type": "object",
+                      "properties": {
+                        "file": {
+                          "type": "string"
+                        },
+                        "line": {
+                          "type": "integer",
+                          "minimum": -9007199254740991,
+                          "maximum": 9007199254740991
+                        },
+                        "column": {
+                          "type": "integer",
+                          "minimum": -9007199254740991,
+                          "maximum": 9007199254740991
+                        }
+                      },
+                      "additionalProperties": {}
+                    },
+                    "links": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "url": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "name": {
+                            "type": "string"
+                          },
+                          "rel": {
+                            "description": "Why it is linked, in an open vocabulary: issue, run, trace, docs, source…",
+                            "type": "string"
+                          }
+                        },
+                        "required": [
+                          "url"
+                        ],
+                        "additionalProperties": {}
+                      }
+                    },
+                    "extensions": {
+                      "type": "object",
+                      "propertyNames": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "additionalProperties": {}
+                    }
+                  },
+                  "required": [
+                    "type",
+                    "message"
+                  ],
+                  "additionalProperties": {}
+                }
+              },
+              "extensions": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "additionalProperties": {}
+              }
+            },
+            "required": [
+              "name"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "attempts": {
+          "description": "Every try, when the check was retried",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "index": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "status": {
+                "type": "string",
+                "enum": [
+                  "passed",
+                  "failed",
+                  "running",
+                  "not-run"
+                ]
+              },
+              "durationMs": {
+                "type": "number",
+                "minimum": 0
+              },
+              "startedAtMs": {
+                "type": "number",
+                "minimum": 0
+              },
+              "detail": {
+                "type": "string"
+              },
+              "steps": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "parentId": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "kind": {
+                      "description": "An open vocabulary: action, assertion, hook, request, span, given, when, then…",
+                      "type": "string"
+                    },
+                    "status": {
+                      "description": "Conventionally passed, failed, skipped. Anything else is shown as it is",
+                      "type": "string"
+                    },
+                    "offsetMs": {
+                      "description": "When it started, after the check did",
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "durationMs": {
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "detail": {
+                      "type": "string"
+                    },
+                    "attachments": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "description": "Lets another attachment, step or annotation refer to this one",
+                            "type": "string"
+                          },
+                          "name": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "role": {
+                            "type": "string"
+                          },
+                          "contentType": {
+                            "description": "An IANA media type. Absent means application/octet-stream",
+                            "type": "string"
+                          },
+                          "bundleKey": {
+                            "description": "The key of its bytes in the layer",
+                            "type": "string"
+                          },
+                          "uri": {
+                            "description": "Where else to read it: an https URL, or a path a host understands",
+                            "type": "string"
+                          },
+                          "text": {
+                            "description": "A small UTF-8 value, inline",
+                            "type": "string"
+                          },
+                          "bytes": {
+                            "type": "integer",
+                            "minimum": 0,
+                            "maximum": 9007199254740991
+                          },
+                          "sha256": {
+                            "type": "string"
+                          },
+                          "width": {
+                            "type": "number",
+                            "minimum": 0
+                          },
+                          "height": {
+                            "type": "number",
+                            "minimum": 0
+                          },
+                          "durationMs": {
+                            "description": "For video and audio",
+                            "type": "number",
+                            "minimum": 0
+                          },
+                          "description": {
+                            "type": "string"
+                          },
+                          "at": {
+                            "type": "object",
+                            "properties": {
+                              "step": {
+                                "description": "The `id` of a step",
+                                "type": "string"
+                              },
+                              "offsetMs": {
+                                "type": "number",
+                                "minimum": 0
+                              }
+                            },
+                            "additionalProperties": {}
+                          },
+                          "poster": {
+                            "description": "The `id` of an attachment that stands for this one before it is opened",
+                            "type": "string"
+                          },
+                          "captions": {
+                            "description": "The `id`s of attachments (WebVTT, SRT) that caption this one",
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "extensions": {
+                            "type": "object",
+                            "propertyNames": {
+                              "type": "string",
+                              "minLength": 1
+                            },
+                            "additionalProperties": {}
+                          }
+                        },
+                        "required": [
+                          "name"
+                        ],
+                        "additionalProperties": {}
+                      }
+                    },
+                    "annotations": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "type": {
+                            "description": "An open vocabulary: note, warning, deprecation, issue, accessibility, coverage…",
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "message": {
+                            "type": "string"
+                          },
+                          "level": {
+                            "description": "Conventionally info, warning or error. Anything else is shown as a note",
+                            "type": "string"
+                          },
+                          "at": {
+                            "type": "object",
+                            "properties": {
+                              "step": {
+                                "description": "The `id` of a step",
+                                "type": "string"
+                              },
+                              "offsetMs": {
+                                "type": "number",
+                                "minimum": 0
+                              }
+                            },
+                            "additionalProperties": {}
+                          },
+                          "source": {
+                            "type": "object",
+                            "properties": {
+                              "file": {
+                                "type": "string"
+                              },
+                              "line": {
+                                "type": "integer",
+                                "minimum": -9007199254740991,
+                                "maximum": 9007199254740991
+                              },
+                              "column": {
+                                "type": "integer",
+                                "minimum": -9007199254740991,
+                                "maximum": 9007199254740991
+                              }
+                            },
+                            "additionalProperties": {}
+                          },
+                          "links": {
+                            "type": "array",
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "url": {
+                                  "type": "string",
+                                  "minLength": 1
+                                },
+                                "name": {
+                                  "type": "string"
+                                },
+                                "rel": {
+                                  "description": "Why it is linked, in an open vocabulary: issue, run, trace, docs, source…",
+                                  "type": "string"
+                                }
+                              },
+                              "required": [
+                                "url"
+                              ],
+                              "additionalProperties": {}
+                            }
+                          },
+                          "extensions": {
+                            "type": "object",
+                            "propertyNames": {
+                              "type": "string",
+                              "minLength": 1
+                            },
+                            "additionalProperties": {}
+                          }
+                        },
+                        "required": [
+                          "type",
+                          "message"
+                        ],
+                        "additionalProperties": {}
+                      }
+                    },
+                    "extensions": {
+                      "type": "object",
+                      "propertyNames": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "additionalProperties": {}
+                    }
+                  },
+                  "required": [
+                    "name"
+                  ],
+                  "additionalProperties": {}
+                }
+              },
+              "attachments": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "description": "Lets another attachment, step or annotation refer to this one",
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "role": {
+                      "type": "string"
+                    },
+                    "contentType": {
+                      "description": "An IANA media type. Absent means application/octet-stream",
+                      "type": "string"
+                    },
+                    "bundleKey": {
+                      "description": "The key of its bytes in the layer",
+                      "type": "string"
+                    },
+                    "uri": {
+                      "description": "Where else to read it: an https URL, or a path a host understands",
+                      "type": "string"
+                    },
+                    "text": {
+                      "description": "A small UTF-8 value, inline",
+                      "type": "string"
+                    },
+                    "bytes": {
+                      "type": "integer",
+                      "minimum": 0,
+                      "maximum": 9007199254740991
+                    },
+                    "sha256": {
+                      "type": "string"
+                    },
+                    "width": {
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "height": {
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "durationMs": {
+                      "description": "For video and audio",
+                      "type": "number",
+                      "minimum": 0
+                    },
+                    "description": {
+                      "type": "string"
+                    },
+                    "at": {
+                      "type": "object",
+                      "properties": {
+                        "step": {
+                          "description": "The `id` of a step",
+                          "type": "string"
+                        },
+                        "offsetMs": {
+                          "type": "number",
+                          "minimum": 0
+                        }
+                      },
+                      "additionalProperties": {}
+                    },
+                    "poster": {
+                      "description": "The `id` of an attachment that stands for this one before it is opened",
+                      "type": "string"
+                    },
+                    "captions": {
+                      "description": "The `id`s of attachments (WebVTT, SRT) that caption this one",
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "extensions": {
+                      "type": "object",
+                      "propertyNames": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "additionalProperties": {}
+                    }
+                  },
+                  "required": [
+                    "name"
+                  ],
+                  "additionalProperties": {}
+                }
+              },
+              "annotations": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "description": "An open vocabulary: note, warning, deprecation, issue, accessibility, coverage…",
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "message": {
+                      "type": "string"
+                    },
+                    "level": {
+                      "description": "Conventionally info, warning or error. Anything else is shown as a note",
+                      "type": "string"
+                    },
+                    "at": {
+                      "type": "object",
+                      "properties": {
+                        "step": {
+                          "description": "The `id` of a step",
+                          "type": "string"
+                        },
+                        "offsetMs": {
+                          "type": "number",
+                          "minimum": 0
+                        }
+                      },
+                      "additionalProperties": {}
+                    },
+                    "source": {
+                      "type": "object",
+                      "properties": {
+                        "file": {
+                          "type": "string"
+                        },
+                        "line": {
+                          "type": "integer",
+                          "minimum": -9007199254740991,
+                          "maximum": 9007199254740991
+                        },
+                        "column": {
+                          "type": "integer",
+                          "minimum": -9007199254740991,
+                          "maximum": 9007199254740991
+                        }
+                      },
+                      "additionalProperties": {}
+                    },
+                    "links": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "url": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "name": {
+                            "type": "string"
+                          },
+                          "rel": {
+                            "description": "Why it is linked, in an open vocabulary: issue, run, trace, docs, source…",
+                            "type": "string"
+                          }
+                        },
+                        "required": [
+                          "url"
+                        ],
+                        "additionalProperties": {}
+                      }
+                    },
+                    "extensions": {
+                      "type": "object",
+                      "propertyNames": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "additionalProperties": {}
+                    }
+                  },
+                  "required": [
+                    "type",
+                    "message"
+                  ],
+                  "additionalProperties": {}
+                }
+              },
+              "extensions": {
+                "type": "object",
+                "propertyNames": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "additionalProperties": {}
+              }
+            },
+            "required": [
+              "index",
+              "status"
+            ],
+            "additionalProperties": {}
+          }
+        }
+      },
+      "required": [
+        "id",
+        "title",
+        "status"
+      ],
+      "additionalProperties": {}
+    },
+    "run": {
+      "description": "What the run as a whole carries: its logs, links, labels, annotations and extensions",
+      "type": "object",
+      "properties": {},
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "layer",
+    "kind",
+    "check",
+    "run"
+  ],
+  "additionalProperties": {}
+}