Rule With Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/axle/json-schema/axle-rule-template-with-input-schema.json",
  "title": "Rule With Input",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/axle-api-openapi.yml#/components/schemas/RuleTemplateWithInput",
  "type": "object",
  "properties": {
    "rule": {
      "type": "string",
      "enum": [
        "collision-coverage-meets-requirements",
        "comprehensive-coverage-meets-requirements",
        "bodily-injury-coverage-meets-requirements",
        "property-damage-coverage-meets-requirements",
        "dwelling-coverage-meets-requirements",
        "uninsured-underinsured-bi-coverage-meets-requirements",
        "uninsured-underinsured-pd-coverage-meets-requirements",
        "expiration-date-comparison",
        "insureds-match",
        "properties-match",
        "address-match",
        "required-policy-information-is-present",
        "vehicle-use-meets-requirements",
        "third-party-matches"
      ]
    },
    "input": {
      "type": "object",
      "description": "Input configuration to evaluate the rule. See [Supported Rules](/guides/policy-validation#supported-rules) for details on which Rules require additional input.",
      "properties": {
        "inputKey": {
          "type": "object",
          "description": "The inputKey is the key corresponding to the Rule input, e.g., \"vin\" or \"deductible\".",
          "properties": {
            "source": {
              "type": "string",
              "description": "The key used to look up this input's value at evaluation time. Axle resolves the value by checking (in order of priority):\n\n1. The `metadata` object passed in the [Validate Policy with Template](/api-reference/validation/templates/validate-policy-template) request body.\n2. The `metadata` object via [Start Ignition](/api-reference/ignition/start-ignition).\n3. The `default` value defined on this input (if set).\n\nFor example, if `source` is `\"maxDeductible\"`, Axle will look for a key named `maxDeductible` in the metadata objects above."
            },
            "default": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                },
                {
                  "type": "array"
                }
              ],
              "description": "Fallback value used when the `source` key is not found in either the request body metadata or the Ignition session metadata. If no `default` is provided and the key is not found, the rule will be evaluated without this input."
            }
          },
          "required": [
            "source"
          ]
        }
      }
    }
  },
  "required": [
    "rule",
    "input"
  ]
}