compliance.schema.json

{
  "$id": "https://grafana.github.io/k6lint/compliance.schema.json",
  "$ref": "#/$defs/compliance",
  "$defs": {
    "compliance": {
      "description": "The result of the extension's k6 compliance checks.\n",
      "type": "object",
      "required": [
        "grade",
        "level",
        "timestamp"
      ],
      "properties": {
        "grade": {
          "$ref": "#/$defs/grade",
          "description": "The results of the checks are in the form of a grade.\n"
        },
        "level": {
          "description": "Compliance expressed as a percentage.\n",
          "type": "integer"
        },
        "timestamp": {
          "description": "Compliance check timestamp.\n\nThe timestamp property contains the start timestamp of the check in Unix time format (the number of non-leap seconds that have elapsed since 00:00:00 UTC on 1st January 1970).\n",
          "type": "number",
          "default": 0
        },
        "checks": {
          "description": "Results of individual checks.\n",
          "type": "array",
          "items": {
            "$ref": "#/$defs/check"
          }
        }
      },
      "additionalProperties": false
    },
    "grade": {
      "description": "The results of the checks are in the form of a grade.\n",
      "type": "string",
      "enum": [
        "A",
        "B",
        "C",
        "D",
        "E",
        "F",
        "G"
      ]
    },
    "check": {
      "description": "The result of a particular inspection.\n",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "passed"
      ],
      "properties": {
        "id": {
          "description": "The ID of the checker.\n\nIt identifies the method of check, not the execution of the check.\n",
          "$ref": "#/$defs/checker"
        },
        "passed": {
          "description": "The result of the check.\n\nA true value of the passed property indicates a successful check, while a false value indicates a failure.\n",
          "type": "boolean"
        },
        "details": {
          "description": "Textual explanation of the check result.\n",
          "type": "string",
          "default": ""
        }
      }
    },
    "checker": {
      "description": "The ID of the check.\n\nIt identifies the method of check, not the execution of the check.\n",
      "type": "string",
      "enum": [
        "module",
        "replace",
        "readme",
        "examples",
        "license",
        "git",
        "versions",
        "build",
        "smoke",
        "codeowners",
        "types"
      ]
    }
  }
}