v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB

dependency-graph

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.

get/repos/{owner}/{repo}/dependency-graph/compare/{basehead}

Path parameters

ownerstring required

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

repostring required

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

baseheadstring required

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}.

Query parameters

namestring

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

Response

change_type'added' | 'removed' required

manifeststring required

ecosystemstring required

namestring required

versionstring required

package_urlstring nullable required

licensestring nullable required

source_repository_urlstring nullable required

Example response

[
  {
    "manifest": "path/to/package-lock.json",
    "ecosystem": "npm",
    "name": "@actions/core",
    "version": "1.0.0",
    "package_url": "pkg:/npm/%40actions/core@1.1.0",
    "license": "MIT",
    "source_repository_url": "https://github.com/github/actions",
    "vulnerabilities": [
      {
        "severity": "critical",
        "advisory_ghsa_id": "GHSA-rf4j-j272-fj86",
        "advisory_summary": "A summary of the advisory.",
        "advisory_url": "https://github.com/advisories/GHSA-rf4j-j272-fj86"
      }
    ]
  }
]