Skip to content
GitmoapAPIBeta
Schema

CheckKindDescriptor

One of the platform's built-in checks, described for a client offering a choice of checks: its key, what it means, which facts it needs and the parameters it takes.

Shape

  • 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
{
"config_schema": {},
"description": "Renders each region as density contours of its operations.",
"fields": [
{
"description": "Renders each region as density contours of its operations.",
"field_type": {
"type": "text"
},
"label": "label-1f64",
"name": "payments-api",
"required": false
},
{
"description": "Renders each region as density contours of its operations.",
"field_type": {
"type": "text"
},
"label": "label-3673",
"name": "payments-api",
"required": false
}
],
"invalidated_by": [
"c9d8e7f6-a5b4-4c3d-9e2f-1a0b9c8d7e6f",
"c9d8e7f6-a5b4-4c3d-9e2f-1a0b9c8d7e6f"
],
"key": "key-b61f",
"label": "label-7d27",
"requires": [
"binding",
"binding"
],
"sweeps": false
}

Graph

Used inside
Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.