List CODEOWNERS errors

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

Copy endpoint

https://api.github.com

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

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

Parameters

path Path Parameters

Name	Type
`owner` required The account owner of the repository. The name is not case sensitive.	string
`repo` required The name of the repository without the `.git` extension. The name is not case sensitive.	string

query Query Parameters

Name	Type
`ref` 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`)	string

Responses

200 application/json

Response

interface CodeownersErrors {
errors: {
line: number;
column: number;
source?: string;
kind: string;
suggestion?: string | null;
message: string;
path: string;
}[];
}

Client Errors

404

Resource not found

unknown