Points de terminaison d’API REST pour la soumission de dépendances
Utilisez l’API REST pour soumettre des dépendances.
À propos des soumissions de dépendances
Vous pouvez utiliser l’API REST pour envoyer des dépendances pour un projet. Cela vous permet d’ajouter des dépendances, comme celles résolues quand le logiciel est compilé ou généré, au graphique de dépendance GitHub, pour une vue d’ensemble plus complète de l’ensemble des dépendances de votre projet.
Le graphique de dépendances affiche les dépendances que vous envoyez à l’aide de l’API, en plus des dépendances identifiées à partir de fichiers manifeste ou de verrouillage dans le référentiel (par exemple un fichier package-lock.json
dans un projet JavaScript). Pour plus d’informations sur l’affichage du graphe des dépendances, consultez « Exploration des dépendances d’un dépôt ».
Les dépendances envoyées reçoivent des Dependabot alerts et Dependabot security updates pour toutes les vulnérabilités connues. Vous ne recevrez des Dependabot alerts que pour les dépendances provenant de l’un des écosystèmes pris en charge pour la GitHub Advisory Database. Pour plus d'informations sur ces écosystèmes, voir « À propos de la base de données GitHub Advisory ». Pour les dépendances transitives soumises via l’API API de soumission de dépendances, Dependabot ouvre automatiquement les demandes de tirage (pull requests) pour mettre à jour la dépendance parente, si une mise à jour est disponible.
Les dépendances envoyées sont affichées dans dependency review, mais ne sont pas disponibles dans les dependency insights de votre organisation.
Remarque : l’API de révision de dépendance et l’API API de soumission de dépendances fonctionnent ensemble. Cela signifie que l’API de révision de dépendance inclut les dépendances soumises via l’API API de soumission de dépendances.
Vous pouvez soumettre des dépendances sous la forme d’un instantané. Une capture instantanée est un ensemble de dépendances associées à un SHA de commit et à d’autres métadonnées, qui reflète l’état actuel de votre dépôt pour un commit. Vous pouvez choisir d’utiliser des actions prédéfinies ou de créer vos propres actions pour soumettre vos dépendances au format requis chaque fois que votre projet est généré. Pour plus d’informations, consultez « Utilisation de l’API de soumission de dépendances ».
Vous pouvez soumettre plusieurs ensembles de dépendances afin de les inclure dans votre graphe des dépendances. L’API REST utilise la propriété job.correlator
et la catégorie detector.name
de l’instantané pour garantir l’affichage des dernières soumissions pour chaque workflow. La propriété correlator
elle-même est le champ principal que vous utiliserez pour veiller à ce que les soumissions indépendantes soient distinctes. Un exemple de correlator
pourrait être une combinaison simple de deux variables disponibles dans des exécutions d’actions : <GITHUB_WORKFLOW> <GITHUB_JOB>
.
Create a snapshot of dependencies for a repository
Create a new snapshot of a repository's dependencies.
The authenticated user must have access to the repository.
OAuth app tokens and personal access tokens (classic) need the repo
scope to use this endpoint.
Jetons d’accès affinés pour « Create a snapshot of dependencies for a repository »
Ce point de terminaison fonctionne avec les types de jetons précis suivants:
- Jetons d’accès utilisateur d’application GitHub
- Jetons d’accès d’installation d’application GitHub
- Jetons d’accès personnel affiné
Le jeton précis doit avoir l’ensemble d’autorisations suivant:
- "Contents" repository permissions (write)
Paramètres pour « Create a snapshot of dependencies for a repository »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
owner string ObligatoireThe account owner of the repository. The name is not case sensitive. |
repo string ObligatoireThe name of the repository without the |
Nom, Type, Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
version integer ObligatoireThe version of the repository snapshot submission. | |||||||||||||||||||||
job object Obligatoire | |||||||||||||||||||||
Properties of |
Nom, Type, Description |
---|
id string ObligatoireThe external ID of the job. |
correlator string ObligatoireCorrelator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of |
html_url string The url for the job. |
sha
string ObligatoireThe commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
ref
string ObligatoireThe repository branch that triggered this snapshot.
detector
object ObligatoireA description of the detector used.
Properties of detector
Nom, Type, Description |
---|
name string ObligatoireThe name of the detector used. |
version string ObligatoireThe version of the detector used. |
url string ObligatoireThe url of the detector used. |
metadata
object User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
manifests
object A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
Properties of manifests
Nom, Type, Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key object A user-defined key to represent an item in | ||||||||||||||||||
Properties of |
Nom, Type, Description | |||||||||
---|---|---|---|---|---|---|---|---|---|
name string ObligatoireThe name of the manifest. | |||||||||
file object | |||||||||
Properties of |
Nom, Type, Description |
---|
source_location string The path of the manifest file relative to the root of the Git repository. |
metadata
object User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
resolved
object A collection of resolved package dependencies.
Properties of resolved
Nom, Type, Description | ||||||
---|---|---|---|---|---|---|
key object A user-defined key to represent an item in | ||||||
Properties of |
Nom, Type, Description |
---|
package_url string Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. |
metadata object User-defined metadata to store domain-specific information limited to 8 keys with scalar values. |
relationship string A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. Peut être: |
scope string A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. Peut être: |
dependencies array of strings Array of package-url (PURLs) of direct child dependencies. |
scanned
string ObligatoireThe time at which the snapshot was scanned.
Codes d’état de la réponse HTTP pour « Create a snapshot of dependencies for a repository »
Code d’état | Description |
---|---|
201 | Created |
Exemples de code pour « Create a snapshot of dependencies for a repository »
Exemple de requête
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/dependency-graph/snapshots \
-d '{"version":0,"sha":"ce587453ced02b1526dfb4cb910479d431683101","ref":"refs/heads/main","job":{"correlator":"yourworkflowname_youractionname","id":"yourrunid"},"detector":{"name":"octo-detector","version":"0.0.1","url":"https://github.com/octo-org/octo-repo"},"scanned":"2022-06-14T20:25:00Z","manifests":{"package-lock.json":{"name":"package-lock.json","file":{"source_location":"src/package-lock.json"},"resolved":{"@actions/core":{"package_url":"pkg:/npm/%40actions/core@1.1.9","dependencies":["@actions/http-client"]},"@actions/http-client":{"package_url":"pkg:/npm/%40actions/http-client@1.0.7","dependencies":["tunnel"]},"tunnel":{"package_url":"pkg:/npm/tunnel@0.0.6"}}}}}'
Response
Status: 201
{
"id": 12345,
"created_at": "2018-05-04T01:14:52Z",
"message": "Dependency results for the repo have been successfully updated.",
"result": "SUCCESS"
}