Sign in
Practice Review Settings

Preview the effective counts for proposed practice-review coverage

Changed on
post/workspaces/{workspaceSlug}/practices/review-settings/coverage-preview

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

Request body

personMode'ALL_ELIGIBLE' | 'SELECTED' required
personUserIdsinteger[] required
repositoryMode'ALL_MONITORED' | 'SELECTED' required

Response

OK

widensboolean required

Whether the proposal admits any repository, branch, or person excluded now

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