Vacuum Report

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://quobix.com/vacuum/schemas/report",
  "title": "Vacuum Report",
  "description": "A vacuum linting report result from analyzing an OpenAPI specification",
  "type": "object",
  "properties": {
    "resultSet": {
      "type": "object",
      "description": "The complete set of linting results",
      "properties": {
        "results": {
          "type": "array",
          "items": { "$ref": "#/definitions/RuleResult" }
        },
        "statistics": {
          "$ref": "#/definitions/Statistics"
        }
      }
    },
    "specInfo": {
      "type": "object",
      "description": "Information about the analyzed specification",
      "properties": {
        "version": { "type": "string" },
        "format": { "type": "string" }
      }
    },
    "generated": {
      "type": "string",
      "format": "date-time",
      "description": "When the report was generated"
    }
  },
  "definitions": {
    "RuleResult": {
      "type": "object",
      "properties": {
        "rule": {
          "type": "object",
          "properties": {
            "id": { "type": "string" },
            "description": { "type": "string" },
            "severity": {
              "type": "string",
              "enum": ["error", "warn", "info", "hint"]
            }
          }
        },
        "errors": {
          "type": "array",
          "items": { "$ref": "#/definitions/RuleError" }
        }
      }
    },
    "RuleError": {
      "type": "object",
      "properties": {
        "message": { "type": "string" },
        "path": {
          "type": "array",
          "items": { "type": "string" }
        },
        "startLine": { "type": "integer" },
        "startColumn": { "type": "integer" },
        "endLine": { "type": "integer" },
        "endColumn": { "type": "integer" }
      }
    },
    "Statistics": {
      "type": "object",
      "properties": {
        "totalErrors": { "type": "integer" },
        "totalWarnings": { "type": "integer" },
        "totalInfo": { "type": "integer" },
        "totalHints": { "type": "integer" },
        "filesAnalyzed": { "type": "integer" }
      }
    }
  }
}