Skip to content
GitmoapAPIBeta
Shipcatalog
GET/catalog/check-kinds

Describe every derived check the platform implements

list_check_kinds
  • catalog:read
    A token needs the catalog:read scope: Read the service catalog: services, their bindings, their owners and their overviewsGranted by read_api, write_api.Every operation this scope unlocks
  • Single-resource

    x-gitmoap-isolation: {"kind":"single_or_self_scoped"}

The catalogue a scorecard editor offers: each check the platform computes for itself, with its key, label, description, what it depends on, and the form fields and schema for configuring it. The same for every caller.

Responses

200The check registry, with a form schema per checkapplication/json
  • 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.
200 exampleSynthesized example
{
"kinds": [
{
"config_schema": {},
"description": "Renders each region as density contours of its operations.",
"fields": [],
"invalidated_by": [],
"key": "key-eaf3",
"label": "label-e7c1",
"requires": [],
"sweeps": false
},
{
"config_schema": {},
"description": "Renders each region as density contours of its operations.",
"fields": [],
"invalidated_by": [],
"key": "key-a605",
"label": "label-b913",
"requires": [],
"sweeps": false
}
]
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-5084",
"message": "Inline scalar newtypes but keep their brand"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-0221",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap catalog list-check-kinds

Used in these guides