api.zfinia.com

{
  "additionalProperties": false,
  "properties": {
    "ambiguous_key_count": {
      "description": "Repeated keys that could not be compared order-independently, because a non-zero tolerance was in force or a value fell outside the exact envelope. These are unexamined, never reconciled.",
      "type": "integer"
    },
    "assumptions": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "cardinality": {
      "description": "The join as it actually is, not as it was assumed. A caller expecting 1:1 and getting N:M is the finding that matters most here.",
      "enum": [
        "1:1",
        "1:N",
        "N:1",
        "N:M",
        "unknown"
      ],
      "type": "string"
    },
    "compared_columns": {
      "description": "The resolved comparison columns, which is what the default inferred if compare was omitted.",
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "comparison": {
      "description": "How equality was decided: exact decimal comparison, the tolerance actually applied, multiset handling for repeated keys, and the declared exact envelope.",
      "type": "object"
    },
    "complete": {
      "description": "Whether everything supplied was examined. False means some of the data was not compared, which is a different problem from data that disagrees.",
      "type": "boolean"
    },
    "difference_count": {
      "description": "The true total number of field differences.",
      "type": "integer"
    },
    "differences": {
      "items": {
        "properties": {
          "column": {
            "description": "The column name, or the literal (group) when a repeated key was compared as a multiset.",
            "type": "string"
          },
          "group_comparison": {
            "description": "Set to multiset when a repeated key was compared as unordered groups.",
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "left_row": {
            "description": "1-based and counting the header row, so it matches a text editor.",
            "type": "integer"
          },
          "left_value": {
            "type": "string"
          },
          "numeric_delta": {
            "description": "The same difference as a number, offered only when one identifies that exact decimal, so sorting by it never disagrees with the text beside it.",
            "type": [
              "number",
              "null"
            ]
          },
          "numeric_delta_text": {
            "description": "left minus right as exact decimal text, always present when both sides read as numbers.",
            "type": [
              "string",
              "null"
            ]
          },
          "only_in_left_rows": {
            "description": "For a multiset difference, the value tuples surplus on the left, with row numbers.",
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "only_in_right_rows": {
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "right_column": {
            "type": [
              "string",
              "null"
            ]
          },
          "right_row": {
            "type": "integer"
          },
          "right_value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "column",
          "left_value",
          "right_value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "differences_by_column": {
      "description": "Counts per column, for triage without reading the list.",
      "type": "object"
    },
    "key_columns": {
      "description": "The resolved join columns for each side.",
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "left": {
      "description": "Row counts supplied and read, joinable keys, duplicated keys and rows with an empty key.",
      "type": "object"
    },
    "limitations": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "limits": {
      "type": "object"
    },
    "matched_key_count": {
      "type": "integer"
    },
    "matched_row_pair_count": {
      "description": "Row pairs actually compared, which differs from matched_key_count when a key repeats.",
      "type": "integer"
    },
    "multiset_matched_key_count": {
      "description": "Repeated keys whose groups agreed as unordered multisets. No row-to-row pairing is implied for these.",
      "type": "integer"
    },
    "not_comparable_count": {
      "description": "Values that could not be compared because they fall outside the declared exact envelope. Never counted as agreement.",
      "type": "integer"
    },
    "not_examined": {
      "description": "Named reasons anything was left uncompared: rows beyond the bound, empty key columns, uneven duplicate counts for a key, values beyond numeric range, or truncated listings.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "observed_at": {
      "type": "string"
    },
    "only_in_left": {
      "description": "Keys present only on the left, with their row numbers. Bounded; the count above is the true total.",
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "only_in_left_count": {
      "description": "The true total, even when the listing below is bounded.",
      "type": "integer"
    },
    "only_in_right": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "only_in_right_count": {
      "type": "integer"
    },
    "reconciled": {
      "description": "The single field to branch on. True only when the comparison was complete, no key was on one side alone, and no matched row disagreed.",
      "type": "boolean"
    },
    "request_id": {
      "description": "Delivery request identifier; also returned in x-foundry-request-id.",
      "type": "string"
    },
    "right": {
      "description": "The same counts for the right side.",
      "type": "object"
    },
    "service_id": {
      "description": "Canonical service identifier.",
      "type": "string"
    },
    "service_version": {
      "description": "Version of the invoked service.",
      "type": "string"
    },
    "warnings": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "request_id",
    "service_id",
    "service_version",
    "observed_at",
    "reconciled",
    "complete",
    "not_examined",
    "key_columns",
    "compared_columns",
    "cardinality",
    "comparison",
    "left",
    "right",
    "matched_key_count",
    "matched_row_pair_count",
    "multiset_matched_key_count",
    "ambiguous_key_count",
    "only_in_left_count",
    "only_in_right_count",
    "only_in_left",
    "only_in_right",
    "difference_count",
    "differences_by_column",
    "differences",
    "not_comparable_count",
    "warnings",
    "limits",
    "assumptions",
    "limitations"
  ],
  "type": "object"
}