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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
use crate::Client;
use crate::ClientResult;
pub struct SecretScanning {
pub client: Client,
}
impl SecretScanning {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
SecretScanning { client }
}
/**
* List secret scanning alerts for a repository.
*
* This function performs a `GET` to the `/repos/{owner}/{repo}/secret-scanning/alerts` endpoint.
*
* Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
*
* GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
*
* FROM: <https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository>
*
* **Parameters:**
*
* * `owner: &str`
* * `repo: &str`
* * `state: crate::types::SecretScanningAlertState` -- Sets the state of the secret scanning alert. Can be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`.
* * `secret_type: &str` -- A comma separated list of secret types to return. By default all secret types are returned. See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)" for a complete list of secret types (API slug).
* * `page: i64` -- Page number of the results to fetch.
* * `per_page: i64` -- Results per page (max 100).
*/
pub async fn list_alerts_for_repo(
&self,
owner: &str,
repo: &str,
state: crate::types::SecretScanningAlertState,
secret_type: &str,
page: i64,
per_page: i64,
) -> ClientResult<crate::Response<Vec<crate::types::SecretScanningAlert>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if page > 0 {
query_args.push(("page".to_string(), page.to_string()));
}
if per_page > 0 {
query_args.push(("per_page".to_string(), per_page.to_string()));
}
if !secret_type.is_empty() {
query_args.push(("secret_type".to_string(), secret_type.to_string()));
}
if !state.to_string().is_empty() {
query_args.push(("state".to_string(), state.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/repos/{}/{}/secret-scanning/alerts?{}",
crate::progenitor_support::encode_path(owner),
crate::progenitor_support::encode_path(repo),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List secret scanning alerts for a repository.
*
* This function performs a `GET` to the `/repos/{owner}/{repo}/secret-scanning/alerts` endpoint.
*
* As opposed to `list_alerts_for_repo`, this function returns all the pages of the request at once.
*
* Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
*
* GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
*
* FROM: <https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository>
*/
pub async fn list_all_alerts_for_repo(
&self,
owner: &str,
repo: &str,
state: crate::types::SecretScanningAlertState,
secret_type: &str,
) -> ClientResult<crate::Response<Vec<crate::types::SecretScanningAlert>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !secret_type.is_empty() {
query_args.push(("secret_type".to_string(), secret_type.to_string()));
}
if !state.to_string().is_empty() {
query_args.push(("state".to_string(), state.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/repos/{}/{}/secret-scanning/alerts?{}",
crate::progenitor_support::encode_path(owner),
crate::progenitor_support::encode_path(repo),
query_
),
None,
);
self.client
.get_all_pages(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get a secret scanning alert.
*
* This function performs a `GET` to the `/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}` endpoint.
*
* Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
*
* GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
*
* FROM: <https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert>
*
* **Parameters:**
*
* * `owner: &str`
* * `repo: &str`
* * `alert_number: i64` -- The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
*/
pub async fn get_alert(
&self,
owner: &str,
repo: &str,
alert_number: i64,
) -> ClientResult<crate::Response<crate::types::SecretScanningAlert>> {
let url = self.client.url(
&format!(
"/repos/{}/{}/secret-scanning/alerts/{}",
crate::progenitor_support::encode_path(owner),
crate::progenitor_support::encode_path(repo),
crate::progenitor_support::encode_path(&alert_number.to_string()),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a secret scanning alert.
*
* This function performs a `PATCH` to the `/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}` endpoint.
*
* Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
*
* GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.
*
* FROM: <https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert>
*
* **Parameters:**
*
* * `owner: &str`
* * `repo: &str`
* * `alert_number: i64` -- The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
*/
pub async fn update_alert(
&self,
owner: &str,
repo: &str,
alert_number: i64,
body: &crate::types::SecretScanningUpdateAlertRequest,
) -> ClientResult<crate::Response<crate::types::SecretScanningAlert>> {
let url = self.client.url(
&format!(
"/repos/{}/{}/secret-scanning/alerts/{}",
crate::progenitor_support::encode_path(owner),
crate::progenitor_support::encode_path(repo),
crate::progenitor_support::encode_path(&alert_number.to_string()),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
}