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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
use super::RepoHandler;
/// A client to GitHub's repository dependabot API.
///
/// Created with [`Octocrab::repos`](crate::Octocrab::repos).
pub struct RepoDependabotAlertsHandler<'octo> {
handler: &'octo RepoHandler<'octo>,
params: Params,
}
#[derive(serde::Serialize)]
struct Params {
#[serde(skip_serializing_if = "Option::is_none")]
per_page: Option<u8>,
#[serde(skip_serializing_if = "Option::is_none")]
page: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
state: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
severity: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
ecosystem: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
package: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
manifest: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
scope: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
sort: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
direction: Option<String>,
}
impl<'octo> RepoDependabotAlertsHandler<'octo> {
pub(crate) fn new(repo: &'octo RepoHandler<'octo>) -> Self {
Self {
handler: repo,
params: Params {
per_page: None,
page: None,
state: None,
severity: None,
ecosystem: None,
package: None,
manifest: None,
scope: None,
sort: None,
direction: None,
},
}
}
/// Lists all Dependabot Alerts available in a repository.
/// You must authenticate using an access token with the `repo` or `security_events` scope to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// let all_secrets = octocrab.repos("owner", "repo")
/// .dependabot()
/// .direction("asc")
/// .get_alerts()
/// .await?;
/// # Ok(())
/// # }
pub async fn get_alerts(
&self,
) -> crate::Result<crate::Page<crate::models::repos::dependabot::DependabotAlert>> {
let route = format!("/{}/dependabot/alerts", self.handler.repo);
self.handler.crab.get(route, Some(&self.params)).await
}
/// Results per page (max 100).
pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
self.params.per_page = Some(per_page.into());
self
}
/// Page number of the results to fetch.
pub fn page(mut self, page: impl Into<u32>) -> Self {
self.params.page = Some(page.into());
self
}
/// Filter Dependabot Alerts by state.
pub fn state(mut self, state: impl Into<Vec<String>>) -> Self {
self.params.state = Some(state.into());
self
}
/// Filter Dependabot Alerts by severity.
pub fn severity(mut self, severity: impl Into<Vec<String>>) -> Self {
self.params.severity = Some(severity.into());
self
}
/// Filter Dependabot Alerts by ecosystem.
pub fn ecosystem(mut self, ecosystem: impl Into<Vec<String>>) -> Self {
self.params.ecosystem = Some(ecosystem.into());
self
}
/// Filter Dependabot Alerts by package.
pub fn package(mut self, package: impl Into<Vec<String>>) -> Self {
self.params.package = Some(package.into());
self
}
/// Filter Dependabot Alerts by manifest.
pub fn manifest(mut self, manifest: impl Into<Vec<String>>) -> Self {
self.params.manifest = Some(manifest.into());
self
}
/// Filter Dependabot Alerts by scope.
pub fn scope(mut self, scope: impl Into<String>) -> Self {
self.params.scope = Some(scope.into());
self
}
/// Sort Dependabot Alerts.
pub fn sort(mut self, sort: impl Into<String>) -> Self {
self.params.sort = Some(sort.into());
self
}
/// Sort direction of Dependabot Alerts.
pub fn direction(mut self, direction: impl Into<String>) -> Self {
self.params.direction = Some(direction.into());
self
}
/// Lists single Dependabot Alert for a repository.
/// You must authenticate using an access token with the `repo` or `security_events` scope to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// let all_secrets = octocrab.repos("owner", "repo")
/// .dependabot()
/// .get_alert(5)
/// .await?;
/// # Ok(())
/// # }
pub async fn get_alert(
&self,
alert_number: u32,
) -> crate::Result<crate::models::repos::dependabot::DependabotAlert> {
let route = format!("/{}/dependabot/alerts/{}", self.handler.repo, alert_number);
self.handler.crab.get(route, None::<&()>).await
}
/// Updates a dependabot alert.
/// You must authenticate using an access token with the `security_events ` scope to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// use octocrab::models::repos::dependabot::UpdateDependabotAlert;
///
/// let result = octocrab.repos("owner", "repo")
/// .dependabot()
/// .update_alert(
/// 5,
/// Some(&UpdateDependabotAlert {
/// state: "dismissed",
/// dismissed_reason: Some("no_bandwidth"),
/// dismissed_comment: Some("I don't have time to fix this right now"),
/// })
/// )
/// .await?;
/// # Ok(())
/// # }
pub async fn update_alert(
&self,
alert_number: u32,
alert_update: Option<&crate::models::repos::dependabot::UpdateDependabotAlert<'_>>,
) -> crate::Result<crate::models::repos::dependabot::DependabotAlert> {
let route = format!("/{}/dependabot/alerts/{}", self.handler.repo, alert_number);
self.handler.crab.patch(route, alert_update).await
}
}