RegressionRangeResponse

Shape

• failing_criteriaarray of CriterionViewThe required criteria currently Failing — what regressed.

  • The CriterionView schema
  • created_atstring
  • criterion_idCriterionId (string · uuid)The criterion's identifier. It never changes, so rewording or re-binding a criterion keeps its identity and its evidence.
  • issue_uidIssueUid (string · uuid)
  • satisfiedboolean
  • stateCriterionStateunverifiedpassingfailingstalemanualA criterion's verdict.
  • textstringThe human statement — the criterion's title. The label, not the identity.
  • updated_atstring
  • bindingCriterionBinding or nulloptional
  • binding_exprstring or nulloptionalThe binding's @-expression, as written. Absent for a manual criterion.
  • binding_keystring or nulloptionalThe normalised form of binding_expr, which two equivalent spellings share. Absent for a manual criterion.
  • checkedbooleanoptionalWhether the box is ticked. Meaningful only for a manual criterion — a bound one is ticked by its state, and ticking it by hand is refused with a 409.
  • descriptionstring or nulloptionalAn optional longer description (markdown) — the per-criterion detail a flat checkbox could never hold.
  • evidenceEvidence or nulloptional

    • The Evidence schema
    • commit_shaCommitHash (string)
    • observed_atstringWhen the run that produced the evidence finished, RFC 3339.
    • pipeline_idPipelineId (string · uuid)
    • pipeline_run_idPipelineRunId (string · uuid)
    • node_run_idNodeRunId (string · uuid) or nulloptional
    • valuenumber · double or nulloptional
  • facet_categoryFacetCategory (string) or nulloptional
  • facet_keyFacetKey (string) or nulloptionalThe blueprint facet this criterion belongs to, when a blueprint added it. Absent for a criterion written directly. A facet's state is rolled up from the criteria carrying its key.
  • last_evidence_atstring or nulloptional
  • last_evidence_commit_shaCommitHash (string) or nulloptional
  • last_evidence_node_run_idNodeRunId (string · uuid) or nulloptional
  • last_evidence_pipeline_idPipelineId (string · uuid) or nulloptionalThe pipeline whose run last provided evidence for this criterion. Only a later run of the same pipeline can make the criterion stale.
  • last_evidence_run_idPipelineRunId (string · uuid) or nulloptional
  • last_evidence_valuenumber · double or nulloptionalThe observed value, for a Metric or Coverage binding.
  • ordinalinteger · int32optional0–∞Position in the description, so the list round-trips in authoring order.
  • required_for_closebooleanoptional@optional opts out. Everything else in a Definition of Done is required by definition.
• suspectsarray of SuspectCommitThe commits in (from_sha, to_sha], newest first — one of them broke it.

  • The SuspectCommit schema
  • shaCommitHash (string)
  • commitCommit or nulloptionalThe commit's author, message and date. Absent when the commit can no longer be read — a force-push removed it, or the work item has moved to another repository since it regressed.

    • The Commit schema
    • author_emailEmail (string)
    • author_namestring
    • authored_atstring
    • commit_shaCommitHash (string)
    • committed_atstring
    • committer_emailEmail (string)
    • committer_namestring
    • repository_idRepositoryId (string · uuid)
    • short_shaShortCommitHash (string)
    • titlestring
    • author_avatar_urlstring or nulloptional
    • committer_avatar_urlstring or nulloptional
    • messagestring or nulloptional
    • parent_shasarray of CommitHash (string)optional
    • tagsarray of TagName (string)optional
• totalinteger0–∞How many commits the range holds, including any not listed in suspects.
• truncatedbooleantrue when the range holds more than 100 commits and suspects lists only the newest 100.
• uidIssueUid (string · uuid)
• from_shaCommitHash (string) or nulloptionalThe last commit the item was Verified at — the range's exclusive lower bound.
• to_shaCommitHash (string) or nulloptionalThe commit whose evidence proved the regression — the range's inclusive upper bound. Absent for an older regression that did not record it.

Graph

Used by