Sign in
Practice reviews

Trace how an observation, piece of feedback, review or piece of work came about

Changed on

Returns the chain from the reviewed work through the review and its observations to the feedback written from them, where it went, whether the developer answered or disputes it (never their rating or private notes) and whether their work resolved it. OBSERVATION, FEEDBACK and REVIEW take id; WORK takes artifactKind and artifactId and traces the newest review of that work. Each list is capped and carries a count of what it leaves out.

get/workspaces/{workspaceSlug}/practices/reviews/lineage

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practices/reviews/lineage
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Query parameters

kind'OBSERVATION' | 'FEEDBACK' | 'REVIEW' | 'WORK' required
idstring uuid

The observation, feedback or review id; required unless kind is WORK

artifactKindstring

Kind of reviewed work, e.g. scm.pull_request; required when kind is WORK

artifactIdinteger

Artifact ID; required when kind is WORK

wholeboolean

true lists the whole review around the record: every observation and piece of feedback of the review, up to 100 each, and the work's moments; false keeps the short chain

Response

Lineage returned

moreFeedbackinteger required

Feedback in the chain that the list leaves out

moreObservationsinteger required

Observations of the review, or behind the listed feedback, that the list leaves out

reviewTrigger'OPENED' | 'READY' | 'PUSHED' | 'EDITED' | 'REVIEWED' | 'MERGED' | 'CLOSED' | 'PUBLISHED' | 'SETTLED' | 'REQUESTED' | 'BACKFILL' | 'SWEEP'

What started the review, from the first moment on the work that names it; null when no recorded moment names the review

workMergedAtstring date-time

When the reviewed pull request or merge request was merged; null for other work and for work that is not merged

Changes