1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
//! Repository Dependency Graph API.
//!
//! See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependency-graph?apiVersion=2022-11-28)
use crate::api::repos::sbom::RepoSbomHandler;
use crate::api::repos::RepoRef;
#[allow(deprecated)]
use crate::models::dependency_graph::Sbom;
use crate::models::dependency_graph::{CreateSnapshotResponse, DependencyDiff, Snapshot};
use crate::{Octocrab, Result};
/// Client for GitHub's repository Dependency Graph API.
///
/// Created with [`crate::api::repos::RepoHandler::dependency_graph`].
pub struct RepoDependencyGraphHandler<'octo> {
crab: &'octo Octocrab,
repo: RepoRef,
}
impl<'octo> RepoDependencyGraphHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab, repo: RepoRef) -> Self {
Self { crab, repo }
}
/// Gets the diff of the dependency changes between two commits of a repository.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependency-graph/dependency-review?apiVersion=2022-11-28#get-a-diff-of-the-dependencies-between-commits)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let diff = octocrab
/// .repos("owner", "repo")
/// .dependency_graph()
/// .compare("base...head")
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn compare(&self, basehead: impl Into<String>) -> CompareDependenciesBuilder<'octo, '_> {
CompareDependenciesBuilder::new(self, basehead.into())
}
/// Create a snapshot of dependencies for a repository.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependency-graph/dependency-submission?apiVersion=2022-11-28#create-a-snapshot-of-dependencies-for-a-repository)
///
/// # Examples
///
/// ```no_run
/// # use octocrab::models::dependency_graph::Snapshot;
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// # let snapshot: Snapshot = todo!();
/// let response = octocrab
/// .repos("owner", "repo")
/// .dependency_graph()
/// .create_snapshot(&snapshot)
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn create_snapshot(&self, snapshot: &Snapshot) -> Result<CreateSnapshotResponse> {
let route = format!("/{}/dependency-graph/snapshots", self.repo);
self.crab.post(route, Some(snapshot)).await
}
/// Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependency-graph/sboms?apiVersion=2022-11-28#export-a-software-bill-of-materials-sbom-for-a-repository)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// #[allow(deprecated)]
/// let sbom = octocrab
/// .repos("owner", "repo")
/// .dependency_graph()
/// .export_sbom()
/// .await?;
/// # Ok(())
/// # }
/// ```
#[deprecated(
note = "This operation is closing down and will not be accessible after November 13, 2026. Please migrate to the asynchronous flow using generate_report and fetch_report."
)]
#[allow(deprecated)]
pub async fn export_sbom(&self) -> Result<Sbom> {
let route = format!("/{}/dependency-graph/sbom", self.repo);
self.crab.get(route, None::<&()>).await
}
/// Access SBOM report generation and fetching APIs.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependency-graph/sboms?apiVersion=2022-11-28)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let sbom = octocrab
/// .repos("owner", "repo")
/// .dependency_graph()
/// .sbom();
/// # Ok(())
/// # }
/// ```
pub fn sbom(&self) -> RepoSbomHandler<'octo> {
RepoSbomHandler::new(self.crab, self.repo.clone())
}
}
/// A builder pattern struct for comparing dependencies between two commits.
#[derive(serde::Serialize)]
pub struct CompareDependenciesBuilder<'octo, 'r> {
#[serde(skip)]
handler: &'r RepoDependencyGraphHandler<'octo>,
#[serde(skip)]
basehead: String,
#[serde(skip_serializing_if = "Option::is_none")]
name: Option<String>,
}
impl<'octo, 'r> CompareDependenciesBuilder<'octo, 'r> {
pub(crate) fn new(handler: &'r RepoDependencyGraphHandler<'octo>, basehead: String) -> Self {
Self {
handler,
basehead,
name: None,
}
}
/// The full path, relative to the repository root, of the dependency manifest file.
pub fn name(mut self, name: impl Into<String>) -> Self {
self.name = Some(name.into());
self
}
/// Sends the actual request.
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let diff = octocrab
/// .repos("owner", "repo")
/// .dependency_graph()
/// .compare("base...head")
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn send(self) -> Result<Vec<DependencyDiff>> {
let route = format!(
"/{}/dependency-graph/compare/{}",
self.handler.repo, self.basehead
);
self.handler.crab.get(route, Some(&self)).await
}
}