Insights into reliability, maintainability, and efficiency of your codebase.
4 endpoints tagged code-quality, each listing its
parameters and possible responses. Search or scroll the index below to
jump to a specific endpoint.
No endpoints match your search.
GET /repos/{owner}/{repo}/code-quality/findings
Lists code quality findings for a repository.
| Name | In | Required | Description |
|---|---|---|---|
owner | path | yes | The account owner of the repository. The name is not case sensitive. |
repo | path | yes | The name of the repository without the .git extension. The name is not case sensitive. |
per_page | query | no | The number of results per page (max 100). For more information, see "Using pagination in the REST API." |
direction | query | no | The direction to sort the results by. |
before | query | no | A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API." |
after | query | no | A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API." |
state | query | no | If specified, only code quality findings with this state will be returned. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 403 | Response if the user is not authorized to access Code quality for this repository. | yes |
| 404 | Resource not found | yes |
| 503 | Service unavailable | yes |
GET /repos/{owner}/{repo}/code-quality/findings/{finding_number}
Gets a single code quality finding.
| Name | In | Required | Description |
|---|---|---|---|
owner | path | yes | The account owner of the repository. The name is not case sensitive. |
repo | path | yes | The name of the repository without the .git extension. The name is not case sensitive. |
finding_number | path | yes | The number that identifies a finding. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 403 | Response if the user is not authorized to access Code quality for this repository. | yes |
| 404 | Resource not found | yes |
| 503 | Service unavailable | yes |
GET /repos/{owner}/{repo}/code-quality/setup
Gets a code quality setup configuration.
| Name | In | Required | Description |
|---|---|---|---|
owner | path | yes | The account owner of the repository. The name is not case sensitive. |
repo | path | yes | The name of the repository without the .git extension. The name is not case sensitive. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 403 | Response if the user is not authorized to access Code quality for this repository. | yes |
| 404 | Resource not found | yes |
| 503 | Service unavailable | yes |
PATCH /repos/{owner}/{repo}/code-quality/setup
Updates a code quality setup configuration.
| Name | In | Required | Description |
|---|---|---|---|
owner | path | yes | The account owner of the repository. The name is not case sensitive. |
repo | path | yes | The name of the repository without the .git extension. The name is not case sensitive. |
| Status | Description | Has JSON body |
|---|---|---|
| 200 | Response | yes |
| 202 | Response | yes |
| 403 | Response if the repository is archived or if Code quality is not enabled for this repository | yes |
| 404 | Resource not found | yes |
| 409 | Response if there is already a code quality setup configuration update in progress | yes |
| 422 | Response if the configuration change cannot be made | yes |
| 503 | Service unavailable | yes |