CheckDetailsRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/harness/main/json-schema/harness-check-details-request-schema.json",
  "title": "CheckDetailsRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/harness-checks-api-openapi.yml#/components/schemas/CheckDetailsRequest",
  "x-stoplight": {
    "id": "386kfxi3e1k1m"
  },
  "type": "object",
  "properties": {
    "check_details": {
      "$ref": "#/$defs/CheckDetails"
    }
  },
  "x-internal": false,
  "$defs": {
    "Check": {
      "title": "Check",
      "x-stoplight": {
        "id": "d3s3zmsa21jqu"
      },
      "type": "object",
      "description": "Check",
      "properties": {
        "identifier": {
          "type": "string",
          "x-stoplight": {
            "id": "u2xn1u2797lk3"
          }
        },
        "name": {
          "type": "string",
          "x-stoplight": {
            "id": "0livvjhoy8g3l"
          }
        },
        "description": {
          "type": "string",
          "x-stoplight": {
            "id": "f7xb30y8u47he"
          }
        },
        "expression": {
          "type": "string",
          "x-stoplight": {
            "id": "5g5fqsfh15x7r"
          }
        },
        "tags": {
          "type": "array",
          "x-stoplight": {
            "id": "mnwbadmsdi09d"
          },
          "items": {
            "x-stoplight": {
              "id": "fitl6f8ktom9c"
            },
            "type": "string"
          }
        },
        "custom": {
          "type": "boolean",
          "x-stoplight": {
            "id": "04nibhaa1qklq"
          }
        }
      },
      "required": [
        "identifier",
        "name",
        "custom"
      ],
      "x-internal": false
    },
    "CheckDetails": {
      "title": "CheckDetails",
      "x-stoplight": {
        "id": "lv03ixht7mprr"
      },
      "allOf": [
        {
          "$ref": "#/$defs/Check"
        },
        {
          "type": "object",
          "properties": {
            "rule_strategy": {
              "x-stoplight": {
                "id": "vozvk20qb8f54"
              },
              "type": "string",
              "enum": [
                "ALL_OF",
                "ANY_OF"
              ]
            },
            "rules": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/Rule"
              }
            },
            "harness_managed": {
              "type": "boolean",
              "x-stoplight": {
                "id": "98xzkzfnubveg"
              }
            },
            "default_behaviour": {
              "x-stoplight": {
                "id": "cdrzuq88hk9lo"
              },
              "type": "string",
              "enum": [
                "PASS",
                "FAIL"
              ]
            },
            "fail_message": {
              "type": "string",
              "x-stoplight": {
                "id": "mqml3k84x10ot"
              }
            },
            "percentage": {
              "type": "number",
              "x-stoplight": {
                "id": "kp6ptdhmpvqn7"
              },
              "format": "double",
              "minimum": 0,
              "maximum": 100
            }
          },
          "required": [
            "rule_strategy",
            "rules",
            "default_behaviour"
          ]
        }
      ],
      "x-internal": false
    },
    "InputValue": {
      "title": "InputValue",
      "x-stoplight": {
        "id": "optt6zoyoj558"
      },
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "x-stoplight": {
            "id": "g1gwgcsubi0n0"
          }
        },
        "value": {
          "type": "string",
          "x-stoplight": {
            "id": "uf1wutejszt8j"
          }
        }
      },
      "required": [
        "key",
        "value"
      ]
    },
    "Rule": {
      "title": "Rule",
      "x-stoplight": {
        "id": "3heyk9rwc10qi"
      },
      "type": "object",
      "x-internal": false,
      "properties": {
        "identifier": {
          "type": "string",
          "x-stoplight": {
            "id": "e3xw4o7mbekr2"
          }
        },
        "data_source_identifier": {
          "type": "string",
          "x-stoplight": {
            "id": "1vt7g30hh6uh3"
          }
        },
        "data_point_identifier": {
          "type": "string",
          "x-stoplight": {
            "id": "g7l2155ej66ti"
          }
        },
        "operator": {
          "type": "string",
          "x-stoplight": {
            "id": "w06lgfpzf7czd"
          }
        },
        "value": {
          "type": "string",
          "x-stoplight": {
            "id": "ektxg0uwq30y7"
          }
        },
        "input_values": {
          "type": "array",
          "x-stoplight": {
            "id": "cllifz4ua1knq"
          },
          "items": {
            "$ref": "#/$defs/InputValue"
          }
        }
      },
      "required": [
        "data_source_identifier",
        "data_point_identifier",
        "operator",
        "value"
      ]
    }
  }
}