Skip to main content

Revisão de dependência

A API de revisão de dependência permite que você entenda as alterações de dependência, e o impacto de segurança dessas alterações, antes de adicioná-las ao seu ambiente.

Sobre a API de revisão da dependência

Note: The Dependency Review API is currently in public beta and subject to change.

A API de revisão de dependência permite que você entenda as alterações de dependência, e o impacto de segurança dessas alterações, antes de adicioná-las ao seu ambiente. É possível ver o diff de dependências entre dois commits de um repositório, incluindo dados de vulnerabilidade para atualizações de versões com vulnerabilidades conhecidas. Para obter mais informações sobre a análise de dependências, consulte "Sobre a revisão de dependências".

Get a diff of the dependencies between commits

Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.

Parâmetros

Headers
Nome, Tipo, Descrição
acceptstring

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

Path parameters
Nome, Tipo, Descrição
ownerstringObrigatório

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

repostringObrigatório

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

baseheadstringObrigatório

The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format {base}...{head}.

Parâmetros de consulta
Nome, Tipo, Descrição
namestring

The full path, relative to the repository root, of the dependency manifest file.

HTTP response status codes

Status codeDescrição
200

OK

403

Forbidden

404

Resource not found

Amostras de código

get/repos/{owner}/{repo}/dependency-graph/compare/{basehead}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/repos/OWNER/REPO/dependency-graph/compare/BASEHEAD

Response

Status: 200
[ { "change_type": "removed", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "4.6.0", "package_url": "pkg:npm/helmet@4.6.0", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "package.json", "ecosystem": "npm", "name": "helmet", "version": "5.0.0", "package_url": "pkg:npm/helmet@5.0.0", "license": "MIT", "source_repository_url": "https://github.com/helmetjs/helmet", "vulnerabilities": [] }, { "change_type": "added", "manifest": "Gemfile", "ecosystem": "rubygems", "name": "ruby-openid", "version": "2.7.0", "package_url": "pkg:gem/ruby-openid@2.7.0", "license": null, "source_repository_url": "https://github.com/openid/ruby-openid", "vulnerabilities": [ { "severity": "critical", "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49", "advisory_summary": "Ruby OpenID", "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49" } ] } ]