View Source GitHub.DependencyGraph (GitHub REST API Client v0.3.0)

Provides API endpoints related to dependency graph

Link to this section Summary

Functions

Create a snapshot of dependencies for a repository

Get a diff of the dependencies between commits

Export a software bill of materials (SBOM) for a repository.

Link to this section Types

Link to this type

create_repository_snapshot_201_json_resp()

View Source
@type create_repository_snapshot_201_json_resp() :: %{
  __info__: map(),
  created_at: String.t(),
  id: integer(),
  message: String.t(),
  result: String.t()
}

Link to this section Functions

Link to this function

create_repository_snapshot(owner, repo, body, opts \\ [])

View Source
@spec create_repository_snapshot(
  String.t(),
  String.t(),
  GitHub.Snapshot.t(),
  keyword()
) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

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.

resources

Resources

Link to this function

diff_range(owner, repo, basehead, opts \\ [])

View Source
@spec diff_range(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.DependencyGraph.Diff.t()]} | {:error, GitHub.Error.t()}

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.

options

Options

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

resources

Resources

Link to this function

export_sbom(owner, repo, opts \\ [])

View Source
@spec export_sbom(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.DependencyGraph.SpdxSbom.t()} | {:error, GitHub.Error.t()}

Export a software bill of materials (SBOM) for a repository.

Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.

resources

Resources