GitHub: List CODEOWNERS errors

← Repos operations · Get started

Operation github.repos_codeowners_errors

Provider route: GET /repos/{owner}/{repo}/codeowners/errors. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["repos"]["reposCodeownersErrors"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.repos.reposCodeownersErrors(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.repos.repos_codeowners_errors(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.ref	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List CODEOWNERS errors — response body

Referenced models: List CODEOWNERS errors — response body

Schemas

List CODEOWNERS errors — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of errors found in a repo's CODEOWNERS file
errors	array	Required within parent
errors[]	object	Each item
errors[].column	JSON	Required within parent
errors[].column (anyOf 1)	integer	Alternative	The column number where this errors occurs.
errors[].column (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errors[].kind	string	Required within parent	The type of error.
errors[].line	JSON	Required within parent
errors[].line (anyOf 1)	integer	Alternative	The line number where this errors occurs.
errors[].line (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errors[].message	string	Required within parent	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).
errors[].path	string	Required within parent	The path of the file where the error occured.
errors[].source	string	Optional	The contents of the line where the error occurs.
errors[].suggestion	JSON	Optional
errors[].suggestion (anyOf 1)	string	Alternative	Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.
errors[].suggestion (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.repos_codeowners_errors. Catalog operation: repos/codeowners-errors. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source