@crvouga/atlas 1.14.0 → 1.16.0

package/packages/server/openapi.json

@@ -3699,7 +3699,7 @@
           "Report"
         ],
         "summary": "Why specs, domains and counts disagree",
-        "description": "Diagnoses the report's metadata, so a domain filter or a coverage percentage can be trusted or fixed at its source. It reads; it never changes a status, a slot or a winner.\n\n`counts` keeps the denominators apart: spec files, defined specs, specs with an executed test (and those without: the defined coverage gaps), tests, outlines, examples and per-environment observations. `reconciliation` walks from the Specs count to the Tests count. `findings` name ambiguous and unmatched spec paths, identical or same-titled specs, a domain shared by nearly every spec, tests with no spec, checks that fall back to their title as identity and root mappings that matched nothing.\n\nTwo paths are one logical spec only when a `root` mapping relates them (`from>to`: paths under `from` are the same specs as paths under `to`; an empty `from` matches every path). Without one, similar paths are reported as ambiguous and never merged. A check's label `outline` names the outline its example belongs to. Send `format=markdown` for Markdown.\n\nRole needed: `read`.",
+        "description": "Diagnoses the report's metadata, so a domain filter or a coverage percentage can be trusted or fixed at its source. It reads; it never changes a status, a slot or a winner.\n\n`counts` keeps the denominators apart: spec files, defined specs, specs with an executed test (and those without: the defined coverage gaps), tests, outlines, examples and per-environment observations. `reconciliation` walks from the Specs count to the Tests count. `findings` name ambiguous and unmatched spec paths, identical or same-titled specs, a domain shared by nearly every spec, tests with no spec, checks that fall back to their title as identity and root mappings that matched nothing.\n\nTwo paths are one logical spec only when a `root` mapping relates them (`from>to`: paths under `from` are the same specs as paths under `to`; an empty `from` matches every path). Without one, similar paths are reported as ambiguous and never merged. A check's label `outline` names the outline its example belongs to; the labels `behavior-id` and `example-id` declare stable ids, which are counted and checked for ids shared by several checks. Send `format=markdown` for Markdown.\n\nRole needed: `read`.",
         "x-atlas-role": "read",
         "security": [
           {
@@ -3714,7 +3714,7 @@
             "required": false,
             "name": "root",
             "in": "query",
-            "description": "A root mapping `from>to`, URL-encoded. Repeatable or comma-separated.",
+            "description": "A root mapping `from>to`, URL-encoded. Repeatable or comma-separated. It is added to the mappings the server is configured with (`catalog.roots`, `ATLAS_CATALOG_ROOTS`); `roots[].source` says which is which.",
             "example": ">specs/",
             "schema": {
               "type": "string"
@@ -3798,7 +3798,7 @@
           "Report"
         ],
         "summary": "Why specs, domains and counts disagree",
-        "description": "Diagnoses the report's metadata, so a domain filter or a coverage percentage can be trusted or fixed at its source. It reads; it never changes a status, a slot or a winner.\n\n`counts` keeps the denominators apart: spec files, defined specs, specs with an executed test (and those without: the defined coverage gaps), tests, outlines, examples and per-environment observations. `reconciliation` walks from the Specs count to the Tests count. `findings` name ambiguous and unmatched spec paths, identical or same-titled specs, a domain shared by nearly every spec, tests with no spec, checks that fall back to their title as identity and root mappings that matched nothing.\n\nTwo paths are one logical spec only when a `root` mapping relates them (`from>to`: paths under `from` are the same specs as paths under `to`; an empty `from` matches every path). Without one, similar paths are reported as ambiguous and never merged. A check's label `outline` names the outline its example belongs to. Send `format=markdown` for Markdown.\n\nScoped to one project. The same project may be selected on the unprefixed API using ?project= or X-Atlas-Project. Unknown projects return 404 on reads and are created by an authenticated upload.\n\nRole needed: `read`.",
+        "description": "Diagnoses the report's metadata, so a domain filter or a coverage percentage can be trusted or fixed at its source. It reads; it never changes a status, a slot or a winner.\n\n`counts` keeps the denominators apart: spec files, defined specs, specs with an executed test (and those without: the defined coverage gaps), tests, outlines, examples and per-environment observations. `reconciliation` walks from the Specs count to the Tests count. `findings` name ambiguous and unmatched spec paths, identical or same-titled specs, a domain shared by nearly every spec, tests with no spec, checks that fall back to their title as identity and root mappings that matched nothing.\n\nTwo paths are one logical spec only when a `root` mapping relates them (`from>to`: paths under `from` are the same specs as paths under `to`; an empty `from` matches every path). Without one, similar paths are reported as ambiguous and never merged. A check's label `outline` names the outline its example belongs to; the labels `behavior-id` and `example-id` declare stable ids, which are counted and checked for ids shared by several checks. Send `format=markdown` for Markdown.\n\nScoped to one project. The same project may be selected on the unprefixed API using ?project= or X-Atlas-Project. Unknown projects return 404 on reads and are created by an authenticated upload.\n\nRole needed: `read`.",
         "x-atlas-role": "read",
         "security": [
           {
@@ -3825,7 +3825,7 @@
             "required": false,
             "name": "root",
             "in": "query",
-            "description": "A root mapping `from>to`, URL-encoded. Repeatable or comma-separated.",
+            "description": "A root mapping `from>to`, URL-encoded. Repeatable or comma-separated. It is added to the mappings the server is configured with (`catalog.roots`, `ATLAS_CATALOG_ROOTS`); `roots[].source` says which is which.",
             "example": ">specs/",
             "schema": {
               "type": "string"
@@ -10728,7 +10728,7 @@
                                 },
                                 "available": {
                                   "type": "boolean",
-                                  "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                                  "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                                 },
                                 "scope": {
                                   "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -11207,7 +11207,7 @@
                               },
                               "available": {
                                 "type": "boolean",
-                                "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                                "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                               },
                               "scope": {
                                 "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -11721,7 +11721,7 @@
                                 },
                                 "available": {
                                   "type": "boolean",
-                                  "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                                  "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                                 },
                                 "scope": {
                                   "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -12200,7 +12200,7 @@
                               },
                               "available": {
                                 "type": "boolean",
-                                "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                                "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                               },
                               "scope": {
                                 "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -15608,7 +15608,7 @@
                           },
                           "available": {
                             "type": "boolean",
-                            "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                            "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                           },
                           "scope": {
                             "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -16102,7 +16102,7 @@
                           },
                           "available": {
                             "type": "boolean",
-                            "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                            "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                           },
                           "scope": {
                             "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -18712,7 +18712,7 @@
                           },
                           "available": {
                             "type": "boolean",
-                            "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                            "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                           },
                           "scope": {
                             "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -19194,7 +19194,7 @@
                               },
                               "available": {
                                 "type": "boolean",
-                                "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                                "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                               },
                               "scope": {
                                 "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -19836,7 +19836,7 @@
                           },
                           "available": {
                             "type": "boolean",
-                            "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                            "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                           },
                           "scope": {
                             "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -21065,7 +21065,7 @@
                                 },
                                 "available": {
                                   "type": "boolean",
-                                  "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                                  "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                                 },
                                 "scope": {
                                   "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -21772,6 +21772,18 @@
                 "maximum": 9007199254740991,
                 "description": "Checks whose id equals their title"
               },
+              "declaredBehaviorIds": {
+                "description": "Checks that declare a `behavior-id` label",
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
+              "declaredExampleIds": {
+                "description": "Checks that declare an `example-id` label",
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991
+              },
               "basis": {
                 "type": "string"
               }
@@ -21821,6 +21833,14 @@
                   "minimum": 0,
                   "maximum": 9007199254740991,
                   "description": "Distinct paths the mapping changed"
+                },
+                "source": {
+                  "description": "Where it was declared: the server's `catalog.roots` setting or this request's `root` parameter",
+                  "type": "string",
+                  "enum": [
+                    "configuration",
+                    "request"
+                  ]
                 }
               },
               "required": [
@@ -22214,7 +22234,7 @@
                               },
                               "available": {
                                 "type": "boolean",
-                                "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                                "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                               },
                               "scope": {
                                 "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -22867,7 +22887,7 @@
                           },
                           "available": {
                             "type": "boolean",
-                            "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                            "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                           },
                           "scope": {
                             "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -23897,7 +23917,7 @@
                       "type": "integer",
                       "minimum": 0,
                       "maximum": 9007199254740991,
-                      "description": "References that name no bytes"
+                      "description": "References that name no bytes, or bytes the layer does not hold"
                     }
                   },
                   "required": [
@@ -24356,7 +24376,7 @@
                       },
                       "available": {
                         "type": "boolean",
-                        "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                        "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                       },
                       "scope": {
                         "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -25649,7 +25669,7 @@
                     "type": "integer",
                     "minimum": 0,
                     "maximum": 9007199254740991,
-                    "description": "References that name no bytes"
+                    "description": "References that name no bytes, or bytes the layer does not hold"
                   }
                 },
                 "required": [
@@ -25802,7 +25822,7 @@
                       },
                       "available": {
                         "type": "boolean",
-                        "description": "False when the reference names no bytes (no bundle key, address or inline text)"
+                        "description": "False when the reference names no bytes: no bundle key, address or inline text, or a bundle key that the layer's own bundle does not hold"
                       },
                       "scope": {
                         "description": "What this recording shows as its producer declared it: its own `scope`, else its attempt's, check's, part's or layer's. Absent: the scope is unknown, never live, physical or audible",
@@ -25908,6 +25928,28 @@
                     ],
                     "additionalProperties": {}
                   }
+                },
+                "kind": {
+                  "description": "The kind of the part that held it. With the producer, environment and parameters it is the condition the result was recorded under. Absent from an older server",
+                  "type": "string"
+                },
+                "parameters": {
+                  "description": "The other choices that made it its own result (a device size, a locale…). Absent when there are none, and from an older server",
+                  "type": "object",
+                  "propertyNames": {
+                    "type": "string"
+                  },
+                  "additionalProperties": {
+                    "type": "string"
+                  }
+                },
+                "specRevision": {
+                  "description": "The fingerprint of its spec file the layer recorded. Absent means not recorded, never \"the same\"",
+                  "type": "string"
+                },
+                "recordedTitle": {
+                  "description": "The title this run's layer gave the check. `title` is the check's newest title in the whole history; this is the wording as recorded. Absent from an older server",
+                  "type": "string"
                 }
               },
               "required": [
@@ -25982,7 +26024,7 @@
                       "type": "integer",
                       "minimum": 0,
                       "maximum": 9007199254740991,
-                      "description": "References that name no bytes"
+                      "description": "References that name no bytes, or bytes the layer does not hold"
                     }
                   },
                   "required": [