v1

latestOpenAPI 3.0.02026-07-249055687.1 KB
deprecated

SCM Comment for Scan Diff

This endpoint is deprecated.

Get the dependency overview and dependency alert comments in GitHub flavored markdown between the diff between two existing full scans.

This endpoint consumes 1 unit of your quota.

This endpoint requires the following org token scopes:

  • full-scans:list
get/orgs/{org_slug}/full-scans/diff/gfm

Path parameters

org_slugstring required

The slug of the organization

Query parameters

afterstring required

The head full scan ID (newer)

beforestring required

The base full scan ID (older)

github_installation_idstring

The ID of the GitHub installation. This will be used to get the GitHub installation settings. If not provided, the default GitHub installation settings will be used.

Response

Metadata about the full scans and the dependency overview and dependency alert comment. Can be used in a pull request context.

incompleteboolean required

True when either side of the diff was truncated at the plan's dependency limit. When set, the comments contain a limit-exceeded notice instead of a report rendered from the imbalanced diff.

directDependenciesChangedboolean required
diff_report_urlstring nullable required