Admin Practice Catalog

Replace a practice definition

Changed on
put/admin/practice-catalog/practices/{slug}

Request

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

Path parameters

slugstring required

Headers

If-Matchstring required

Request body

criteriastring required
definitionChangesstring[]

Explicit intent to change the gate or the person judged

groupSlugstring
namestring required
precomputeScriptstring
reviewWhenobject

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
subject'AUTHOR' | 'ASSIGNEE' | 'REVIEWER' | 'MERGER'
whatGoodLooksLikestring
whyItMattersstring

Example request

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

Response

The practice

positioninteger required
slugstring required

Example response

{
  "definition": {
    "automatedReviewPolicy": {
      "insufficiencyReason": {
        "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
      },
      "knownLimitations": [
        {
          "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
        }
      ]
    }
  },
  "shipped": {
    "automatedReviewPolicy": {
      "insufficiencyReason": {
        "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
      },
      "knownLimitations": [
        {
          "code": "RUNTIME_BEHAVIOR_NOT_OBSERVED"
        }
      ]
    }
  }
}

Changes

  • c6a02919f6bfRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • 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

  • c90ade77d2faRevision changes
    • warning

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

    • info

      removed the DETECTION enum value from the / response property for the response status