Sign in
Practice Catalog

Compare the adopted, current, and offered practice

Changed on
get/workspaces/{workspaceSlug}/practices/releases/{slug}

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

slugstring required

Response

OK

baseSource'EXACT_ADOPTION' | 'BUNDLED_DIGEST_MATCH' | 'BUNDLED_FINGERPRINT_MATCH' | 'REVISION_FINGERPRINT_MATCH' | 'CURRENT_DEFINITION' required
currentRevisioninteger
etagstring required
offeredDigeststring required
slugstring required

Example response

{
  "base": {
    "automatedReviewPolicy": {
      "insufficiencyReason": {
        "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
      },
      "knownLimitations": [
        {
          "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
        }
      ]
    }
  },
  "current": {
    "automatedReviewPolicy": {
      "insufficiencyReason": {
        "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
      },
      "knownLimitations": [
        {
          "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
        }
      ]
    }
  },
  "offered": {
    "automatedReviewPolicy": {
      "insufficiencyReason": {
        "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
      },
      "knownLimitations": [
        {
          "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
        }
      ]
    }
  }
}

Changes

  • c6a02919f6bfRevision changes
    • warning

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

    • warning

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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

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