Sign in
Practice Catalog

Read practice definition options

Changed on

Returns available review events, recommended requirements, and allowed evidence sources by work type

get/workspaces/{workspaceSlug}/practices/definition-options

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

Response

OK

sourceContractVersionstring required

Source contract these options describe

Example response

{
  "sourceContractVersion": "1.3.0",
  "workTypes": [
    {
      "manualReviewSignal": {
        "signal": "scm.pull_request.ready"
      },
      "recommendedPolicy": {
        "insufficiencyReason": {
          "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
        },
        "knownLimitations": [
          {
            "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
          }
        ]
      },
      "signals": [
        {
          "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]$

  • 91e1986ff53bRevision changes
    • breaking

      removed the required property // from the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status