Skip to content
GitmoapAPIBeta
Schema

CheckKindCatalog

The platform's built-in checks, for a client offering a choice of checks.

Shape

  • kindsarray of CheckKindDescriptor
    • The CheckKindDescriptor schema
    • config_schemaobjectA JSON Schema over the fields — render a form from this.
    • descriptionstringWhat the check means, and the one thing to do about a failure.
    • fieldsarray of FieldDescriptor
    • invalidated_byarray of stringThe kinds of activity that can change this check's answer, causing it to be re-evaluated.
    • keystring
    • labelstring
    • requiresarray of FactSource: one of binding | repository | deployment | release | api_specThe facts this check needs. A service with none of them is not_applicable.
    • sweepsbooleanWhether this check is re-evaluated periodically as well as on activity — true for checks whose answer can change with time alone.

Example

Synthesized example
{
"kinds": [
{
"config_schema": {},
"description": "Renders each region as density contours of its operations.",
"fields": [],
"invalidated_by": [],
"key": "key-feb8",
"label": "label-e0a8",
"requires": [],
"sweeps": false
}
]
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 1 operation