CODEOWNERS errors

A list of errors found in a repo's CODEOWNERS file

APIs.ioEngineeringPlatform

Properties

Name Type Description
errors array
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-codeowners-errors-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/codeowners-errors",
  "title": "CODEOWNERS errors",
  "description": "A list of errors found in a repo's CODEOWNERS file",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "line": {
            "description": "The line number where this errors occurs.",
            "type": "integer",
            "example": 7
          },
          "column": {
            "description": "The column number where this errors occurs.",
            "type": "integer",
            "example": 3
          },
          "source": {
            "description": "The contents of the line where the error occurs.",
            "type": "string",
            "example": "* user"
          },
          "kind": {
            "description": "The type of error.",
            "type": "string",
            "example": "Invalid owner"
          },
          "suggestion": {
            "description": "Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.",
            "type": "string",
            "nullable": true,
            "example": "The pattern `/` will never match anything, did you mean `*` instead?"
          },
          "message": {
            "description": "A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).",
            "type": "string",
            "example": "Invalid owner on line 7:\n\n  * user\n    ^"
          },
          "path": {
            "description": "The path of the file where the error occured.",
            "type": "string",
            "example": ".github/CODEOWNERS"
          }
        },
        "required": [
          "line",
          "column",
          "kind",
          "message",
          "path"
        ]
      }
    }
  },
  "required": [
    "errors"
  ]
}