Skip to main content
Skip to content

Points de terminaison d’API REST pour la qualité du code

Utilisez l’API REST pour gérer une configuration de qualité du code.

List code quality findings for a repository

Lists code quality findings for a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

Jetons d'accès granulaires pour «List code quality findings for a repository»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

  • "Code quality" repository permissions (read)

Paramètres pour «List code quality findings for a repository »

En-têtes
Nom, Type, Description
accept string

Setting to application/vnd.github+json is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
owner string Requis

The account owner of the repository. The name is not case sensitive.

repo string Requis

The name of the repository without the .git extension. The name is not case sensitive.

Paramètres de requête
Nom, Type, Description
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Par défaut: 30

direction string

The direction to sort the results by.

Par défaut: desc

Peut être l'un des: asc, desc

before string

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 string

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 string

If specified, only code quality findings with this state will be returned.

Peut être l'un des: open, dismissed

Codes d’état de réponse HTTP pour «List code quality findings for a repository »

Code de statutDescription
200

OK

403

Response if the user is not authorized to access Code quality for this repository.

404

Resource not found

503

Service unavailable

Exemples de code pour «List code quality findings for a repository »

Exemple de requête

get/repos/{owner}/{repo}/code-quality/findings