Practice Catalog

Reorder the practices within a group

Changed on

Sets each practice's display order to its index in the provided slug list (one atomic write)

patch/workspaces/{workspaceSlug}/practices/reorder

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

Request body

groupSlugstring nullable

Slug of the group whose practices are being reordered; null reorders the unassigned bucket

orderedSlugsstring[] required

Practice slugs in the desired display order — the complete set for the group

Example request

{
  "groupSlug": "review-ready-work",
  "orderedSlugs": [
    "describe-what-and-why",
    "ready-and-traceable-handoff"
  ]
}

Response

Practices reordered; the full ordered practice list is returned

artifactKindstring required

Kind of work this practice reviews, read off its signals

createdAtstring date-time required

Timestamp when the practice was created

criteriastring required

Practice review criteria

displayOrderinteger required

Position within its group (lowest first); ties broken by name

groupSlugstring

Slug of the practice group this practice is bound to, if any

idinteger required

Practice ID

namestring required

Human-readable name

precomputeScriptstring

TypeScript/Node precompute script for static analysis before AI review

reviewWhenobject required

Automatic review state selections. An empty object imposes no state restrictions. Each selected dimension requires a nonempty set of non-null values offered by the work type descriptor. Values within a dimension are alternatives; all selected dimensions must match.

signalsstring[] required

Signals that start a practice review

slugstring required

URL-safe identifier unique within workspace

subject'AUTHOR' | 'ASSIGNEE' | 'REVIEWER' | 'MERGER' required
updatedAtstring date-time required

Timestamp when the practice was last updated

whatGoodLooksLikestring

Developer-facing exemplar (developer layer)

whyItMattersstring

Developer-facing rationale (developer layer)

Example response

[
  {
    "artifactKind": "scm.pull_request",
    "automatedReviewPolicy": {
      "insufficiencyReason": {
        "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
      },
      "knownLimitations": [
        {
          "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
        }
      ]
    },
    "automatedReviewWithdrawal": {
      "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
    }
  }
]

Changes

  • c6a02919f6bfRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 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]$