v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-01-0382859610.0 MB
repos

List CODEOWNERS errors

List any syntax errors that are detected in the CODEOWNERS file.

For more information about the correct CODEOWNERS syntax, see "About code owners."

get/repos/{owner}/{repo}/codeowners/errors

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

Query parameters

refstring

A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. main)

Response

Response

Example response

{
  "errors": [
    {
      "line": 7,
      "column": 3,
      "source": "* user",
      "kind": "Invalid owner",
      "suggestion": "The pattern `/` will never match anything, did you mean `*` instead?",
      "message": "Invalid owner on line 7:\n\n  * user\n    ^",
      "path": ".github/CODEOWNERS"
    }
  ]
}