GitHub: Get a code quality finding

← Code quality operations · Get started

Operation github.code_quality_get_finding

Provider route: GET /repos/{owner}/{repo}/code-quality/findings/{finding_number}. 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["codeQuality"]["codeQualityGetFinding"]>[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.codeQuality.codeQualityGetFinding(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.code_quality.code_quality_get_finding(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
path.finding_number	integer	Required within parent

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 Get a code quality finding — response body

Referenced models: Get a code quality finding — response body

Schemas

Get a code quality finding — response body

Field	Type	Presence	Description and constraints
$	object	Root	Code quality finding
created_at	string	Optional	The time the code quality finding was created. Format: date-time
location	Model	Required within parent	Expand Get a code quality finding — response body — location
message	Model	Required within parent	Expand Get a code quality finding — response body — message
number	JSON	Required within parent
number (anyOf 1)	integer	Alternative	The finding number.
number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rule	Model	Required within parent	Expand Get a code quality finding — response body — rule
state	string	Required within parent	State of the code quality finding. Known values: open, dismissed
url	string	Required within parent	The REST API URL of the code quality finding resource. Format: uri

Referenced models: Get a code quality finding — response body — location, Get a code quality finding — response body — message, Get a code quality finding — response body — rule

Get a code quality finding — response body — location

Field	Type	Presence	Description and constraints
$	object	Root	Code quality file location
end_column	JSON	Optional
end_column (anyOf 1)	integer	Alternative	The column number where the finding ends.
end_column (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_line	JSON	Optional
end_line (anyOf 1)	integer	Alternative	The line number where the finding ends.
end_line (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
path	string	Required within parent	The file path where the finding was detected.
start_column	JSON	Optional
start_column (anyOf 1)	integer	Alternative	The column number where the finding starts.
start_column (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start_line	JSON	Optional
start_line (anyOf 1)	integer	Alternative	The line number where the finding starts.
start_line (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a code quality finding — response body — message

Field	Type	Presence	Description and constraints
$	object	Root	Code quality finding message
markdown	string	Required within parent	The message text of the code quality finding in markdown format.
text	string	Required within parent	The message text of the code quality finding.

Get a code quality finding — response body — rule

Field	Type	Presence	Description and constraints
$	object	Root	Code quality rule
category	string	Required within parent	The category of the rule used to detect the finding. Known values: none, maintainability, reliability
description	string	Required within parent	A short description of the rule used to detect the finding.
help	string	Optional	A detailed description of the rule used to detect the finding.
id	string	Required within parent	A unique identifier for the rule used to detect the finding.
severity	string	Required within parent	The severity of the rule used to detect the finding. Known values: error, warning, note, none
title	string	Required within parent	The name of the rule used to detect the finding.

Policy, approvals and errors

SDK function policy ID: github.code_quality_get_finding. Catalog operation: code-quality/get-finding. 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