GitHub: Code quality schemas

← Code quality operations · All 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.

Get a code quality setup configuration — response body

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for code quality setup.
ai_findings_option	JSON	Optional
ai_findings_option (anyOf 1)	string	Alternative	The AI findings configuration for the repository. Known values: disabled, on_push
ai_findings_option (anyOf 2)	null	Alternative
languages	array	Optional	Languages to be analyzed.
languages[]	string	Each item	Known values: csharp, go, java-kotlin, javascript-typescript, python, ruby, rust
runner_label	JSON	Optional
runner_label (anyOf 1)	string	Alternative	Runner label to be used if the runner type is labeled.
runner_label (anyOf 2)	null	Alternative
runner_type	JSON	Optional
runner_type (anyOf 1)	string	Alternative	Runner type to be used. Known values: standard, labeled
runner_type (anyOf 2)	null	Alternative
schedule	JSON	Optional
schedule (anyOf 1)	string	Alternative	The frequency of the periodic analysis. Known values: weekly
schedule (anyOf 2)	null	Alternative
state	string	Optional	Code quality setup has been configured or not. Known values: configured, not-configured
updated_at	JSON	Optional
updated_at (anyOf 1)	string	Alternative	Timestamp of latest configuration update. Format: date-time
updated_at (anyOf 2)	null	Alternative

Update a code quality setup configuration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for code quality setup. Additional keys: not allowed
ai_findings_option	string	Optional	Whether AI findings run for Code Quality on this repository. One of: disabled, on_push
languages	array	Optional	Languages to be analyzed.
languages[]	string	Each item	One of: csharp, go, java-kotlin, javascript-typescript, python, ruby
runner_label	JSON	Optional
runner_label (anyOf 1)	string	Alternative	Runner label to be used if the runner type is labeled.
runner_label (anyOf 2)	null	Alternative
runner_type	string	Optional	Runner type to be used. One of: standard, labeled
state	string	Optional	The desired state of code quality setup. One of: configured, not-configured
$ (anyOf 1)	JSON	Alternative
$ (anyOf 2)	JSON	Alternative
$ (anyOf 3)	JSON	Alternative
$ (anyOf 4)	JSON	Alternative
$ (anyOf 5)	JSON	Alternative

Update a code quality setup configuration — response body — run id, run url

Field	Type	Presence	Description and constraints
$	object	Root	You can use `run_url` to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow run object.
run_id	JSON	Optional
run_id (anyOf 1)	integer	Alternative	ID of the corresponding run.
run_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
run_url	string	Optional	URL of the corresponding run.