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.

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

Request

Path Params

owner

string

required

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

repo

string

required

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

basehead

string

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 Params

name

string

optional

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

Responses

🟢200Response

application/json

Body

A diff of the dependencies between two commits.

array of:

change_type

enum<string>

required

Allowed values:

addedremoved

ecosystem

string

required

Example:

npm

license

string | null

required

Example:

MIT

manifest

string

required

Example:

path/to/package-lock.json

name

string

required

Example:

@actions/core

package_url

string | null

required

Example:

pkg:/npm/%40actions/core@1.1.0

scope

enum<string>

required

Where the dependency is utilized. development means that the dependency is only utilized in the development environment. runtime means that the dependency is utilized at runtime and in the development environment.

Allowed values:

unknownruntimedevelopment

source_repository_url

string | null

required

Example:

https://github.com/github/actions

version

string

required

Example:

1.0.0

vulnerabilities

array [object {4}]

required

advisory_ghsa_id

string

required

Example:

GHSA-rf4j-j272-fj86

advisory_summary

string

required

Example:

A summary of the advisory.

advisory_url

string

required

Example:

https://github.com/advisories/GHSA-rf4j-j272-fj86

severity

string

required

Example:

critical

🟠403403

🟠404404