List CODEOWNERS errors - GitHub v3 REST API

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

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

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

Request

Path Params

owner

string

required

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

repo

string

required

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

Query Params

ref

string

optional

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)

Responses

🟢200Response

application/json

Body

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

errors

array [object {7}]

required

column

integer

required

The column number where this errors occurs.

Example:

kind

string

required

The type of error.

Example:

Invalid owner

line

integer

required

The line number where this errors occurs.

Example:

message

string

required

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).

Example:

Invalid owner on line 7: * user ^

path

string

required

The path of the file where the error occured.

Example:

.github/CODEOWNERS

source

string

optional

The contents of the line where the error occurs.

Example:

* user

suggestion

string | null

optional

Suggested action to fix the error. This will usually be null, but is provided for some common errors.

Example:

The pattern `/` will never match anything, did you mean `*` instead?

🟠404Resource not found