Check

The definition for a single check contained in a Scorecard.

Example

{
  "id": "has-dockerfile",
  "name": "Has Dockerfile",
  "description": "Service has a valid Dockerfile for containerization",
  "external_url": "https://docs.company.com/docker-guide"
}

Properties

Key Type Description
id string The check’s unique ID.
description string The check’s plain text description.
external_url string | null The check’s external URL, used for documentation or other instructions for passing the check.
name string The check’s name.