Practice review trace

Explain what every practice did about one piece of work

Changed on

Every practice the workspace runs against this kind of work appears, including the ones that did nothing, each with the recorded reason. Name a review and every answer is that review's own. A workspace admin may read any work, with or without a review; anyone else must name a review that observed them on this work, and reads only the observations about them and the feedback addressed to them. 404 means nothing about this artifact was ever recorded here, the named review never ran on it, or the caller may not read it.

get/workspaces/{workspaceSlug}/practices/trace/{artifactKind}/{artifactId}

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

artifactKindstring required

Kind of work, e.g. scm.pull_request

artifactIdinteger required

The artifact's identifier as the ledger stores it

Query parameters

reviewIdstring uuid

Answer for this review alone: every state, explanation and count is what this review made of the work. Omit it for every review of the work at once, which only a workspace admin may.

Response

Trace returned

artifactIdinteger required
artifactKindstring required

Example response

{
  "practices": [
    {
      "occasionedBy": {
        "signal": "scm.pull_request.ready"
      },
      "watches": [
        {
          "signal": "scm.pull_request.ready"
        }
      ]
    }
  ]
}

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$

  • fc28962fd0a6Revision changes
    • warning

      added the new PUBLIC_SUBJECT_INELIGIBLE enum value to the /// response property for the response status