FileComparison

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/codecov/main/json-schema/codecov-file-comparison-schema.json",
  "title": "FileComparison",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/codecov-comparison-api-openapi.yml#/components/schemas/FileComparison",
  "type": "object",
  "properties": {
    "name": {},
    "totals": {
      "$ref": "#/$defs/TotalsComparison"
    },
    "has_diff": {
      "type": "boolean"
    },
    "stats": {},
    "change_summary": {},
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/LineComparison"
      }
    }
  },
  "required": [
    "change_summary",
    "has_diff",
    "lines",
    "name",
    "stats",
    "totals"
  ],
  "$defs": {
    "LineComparison": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string"
        },
        "number": {},
        "coverage": {},
        "is_diff": {
          "type": "boolean"
        },
        "added": {
          "type": "boolean"
        },
        "removed": {
          "type": "boolean"
        },
        "sessions": {
          "type": "integer"
        }
      },
      "required": [
        "added",
        "coverage",
        "is_diff",
        "number",
        "removed",
        "sessions",
        "value"
      ]
    },
    "ReportTotals": {
      "type": "object",
      "properties": {
        "files": {
          "type": "integer"
        },
        "lines": {
          "type": "integer"
        },
        "hits": {
          "type": "integer"
        },
        "misses": {
          "type": "integer"
        },
        "partials": {
          "type": "integer"
        },
        "coverage": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "branches": {
          "type": "integer"
        },
        "methods": {
          "type": "integer"
        },
        "messages": {
          "type": "integer"
        },
        "sessions": {
          "type": "integer"
        },
        "complexity": {
          "type": "number",
          "format": "double"
        },
        "complexity_total": {
          "type": "number",
          "format": "double"
        },
        "complexity_ratio": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "diff": {}
      },
      "required": [
        "branches",
        "complexity",
        "complexity_ratio",
        "complexity_total",
        "coverage",
        "diff",
        "files",
        "hits",
        "lines",
        "messages",
        "methods",
        "misses",
        "partials",
        "sessions"
      ]
    },
    "TotalsComparison": {
      "type": "object",
      "properties": {
        "base": {
          "$ref": "#/$defs/ReportTotals"
        },
        "head": {
          "$ref": "#/$defs/ReportTotals"
        },
        "patch": {
          "$ref": "#/$defs/ReportTotals"
        }
      },
      "required": [
        "base",
        "head",
        "patch"
      ]
    }
  }
}