octocrab 0.54.7

A modern, extensible GitHub API client.
Documentation
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
use super::super::*;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SecretScanningAlert {
    pub number: i64,
    pub created_at: DateTime<Utc>,
    pub updated_at: Option<DateTime<Utc>>,
    pub url: Url,
    pub html_url: Url,
    pub locations_url: Url,
    pub state: State,
    pub resolution: Option<Resolution>,
    pub resolved_at: Option<DateTime<Utc>>,
    pub resolved_by: Option<SimpleUser>,
    pub secret_type: String,
    pub secret_type_display_name: String,
    pub secret: String,
    #[serde(default)]
    pub repository: Option<Repository>,
    pub push_protection_bypassed_by: Option<SimpleUser>,
    pub push_protection_bypassed: Option<bool>,
    pub push_protection_bypassed_at: Option<DateTime<Utc>>,
    pub resolution_comment: Option<String>,
    pub validity: Validity,
    pub publicly_leaked: Option<bool>,
    pub multi_repo: Option<bool>,
    #[serde(default)]
    pub provider: Option<String>,
    #[serde(default)]
    pub provider_slug: Option<String>,
    #[serde(default)]
    pub is_base64_encoded: Option<bool>,
    #[serde(default)]
    pub has_more_locations: Option<bool>,
    #[serde(default)]
    pub assigned_to: Option<SimpleUser>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum State {
    Resolved,
    Open,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum Resolution {
    FalsePositive,
    WontFix,
    Revoked,
    UsedInTests,
    PatternEdited,
    PatternDeleted,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum Validity {
    Active,
    Inactive,
    Unknown,
}

#[derive(Debug, Clone, PartialEq, Serialize, Default)]
pub struct UpdateSecretScanningAlert<'a> {
    pub state: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub resolution: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub resolution_comment: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub assignee: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validity: Option<&'a str>,
}

impl<'a> UpdateSecretScanningAlert<'a> {
    pub fn new(state: &'a str) -> Self {
        Self {
            state,
            ..Default::default()
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(tag = "type", content = "details")]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum SecretsScanningAlertLocation {
    Commit {
        path: String,
        start_line: u32,
        end_line: u32,
        start_column: u32,
        end_column: u32,
        blob_sha: String,
        blob_url: String,
        commit_sha: String,
        commit_url: String,
        #[serde(default, skip_serializing_if = "Option::is_none")]
        html_url: Option<Url>,
    },
    WikiCommit {
        path: String,
        start_line: u32,
        end_line: u32,
        start_column: u32,
        end_column: u32,
        blob_sha: String,
        page_url: String,
        commit_sha: String,
        commit_url: String,
    },
    IssueTitle {
        issue_title_url: String,
    },
    IssueBody {
        issue_body_url: String,
    },
    IssueComment {
        issue_comment_url: String,
    },
    DiscussionTitle {
        discussion_title_url: String,
    },
    DiscussionBody {
        discussion_body_url: String,
    },
    DiscussionComment {
        discussion_comment_url: String,
    },
    PullRequestTitle {
        pull_request_title_url: String,
    },
    PullRequestBody {
        pull_request_body_url: String,
    },
    PullRequestComment {
        pull_request_comment_url: String,
    },
    PullRequestReview {
        pull_request_review_url: String,
    },
    PullRequestReviewComment {
        pull_request_review_comment_url: String,
    },
}

/// A secret scanning custom pattern for an organization or repository.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SecretScanningCustomPattern {
    pub id: u64,
    pub name: String,
    pub pattern: String,
    pub slug: String,
    pub state: String,
    pub push_protection_enabled: bool,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub start_delimiter: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub end_delimiter: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub must_match: Option<Vec<String>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub must_not_match: Option<Vec<String>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub custom_pattern_version: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub created_at: Option<DateTime<Utc>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<DateTime<Utc>>,
}

/// Request entry for bulk creating secret scanning custom patterns.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct CreateSecretScanningCustomPattern {
    pub name: String,
    pub pattern: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub push_protection_enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_delimiter: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_delimiter: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub must_match: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub must_not_match: Option<Vec<String>>,
}

impl CreateSecretScanningCustomPattern {
    pub fn new(name: impl Into<String>, pattern: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            pattern: pattern.into(),
            ..Default::default()
        }
    }
}

/// Response from bulk creating secret scanning custom patterns.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct BulkCreatedCustomPatterns {
    pub created_patterns: Vec<SecretScanningCustomPattern>,
}

/// Request entry for bulk deleting secret scanning custom patterns.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DeleteSecretScanningCustomPattern {
    pub id: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_pattern_version: Option<String>,
}

impl DeleteSecretScanningCustomPattern {
    pub fn new(id: u64) -> Self {
        Self {
            id,
            custom_pattern_version: None,
        }
    }
}

/// Request body for updating a secret scanning custom pattern.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct UpdateSecretScanningCustomPattern {
    pub custom_pattern_version: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub push_protection_enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pattern: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_delimiter: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_delimiter: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub must_match: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub must_not_match: Option<Vec<String>>,
}

impl UpdateSecretScanningCustomPattern {
    pub fn new(custom_pattern_version: Option<String>) -> Self {
        Self {
            custom_pattern_version,
            ..Default::default()
        }
    }
}

/// Organization secret scanning pattern configurations.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SecretScanningPatternConfigurations {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pattern_config_version: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider_pattern_overrides: Option<Vec<ProviderPatternOverride>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub custom_pattern_overrides: Option<Vec<CustomPatternOverride>>,
}

/// Provider pattern override configuration in an organization.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ProviderPatternOverride {
    pub token_type: String,
    pub slug: String,
    pub display_name: String,
    pub alert_total: u64,
    pub alert_total_percentage: u64,
    pub false_positives: u64,
    pub false_positive_rate: u64,
    pub bypass_rate: u64,
    pub default_setting: String,
    pub setting: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub enterprise_setting: Option<String>,
}

/// Custom pattern override configuration in an organization.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CustomPatternOverride {
    pub token_type: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub custom_pattern_version: Option<String>,
    pub slug: String,
    pub display_name: String,
    pub alert_total: u64,
    pub alert_total_percentage: u64,
    pub false_positives: u64,
    pub false_positive_rate: u64,
    pub bypass_rate: u64,
    pub default_setting: String,
    pub setting: String,
}

/// Request body for updating organization secret scanning pattern configurations.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct UpdateSecretScanningPatternConfigurations {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub pattern_config_version: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider_pattern_settings: Option<Vec<ProviderPatternSetting>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_pattern_settings: Option<Vec<CustomPatternSetting>>,
}

/// Provider pattern setting update entry.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ProviderPatternSetting {
    pub token_type: String,
    pub push_protection_setting: String,
}

/// Custom pattern setting update entry.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct CustomPatternSetting {
    pub token_type: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_pattern_version: Option<String>,
    pub push_protection_setting: String,
}

/// Response from updating organization secret scanning pattern configurations.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct UpdatedSecretScanningPatternConfigurations {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pattern_config_version: Option<String>,
}

/// Reason for bypassing secret scanning push protection.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum PushProtectionBypassReason {
    FalsePositive,
    UsedInTests,
    WillFixLater,
}

/// Push protection bypass response.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct PushProtectionBypass {
    pub reason: PushProtectionBypassReason,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub expire_at: Option<DateTime<Utc>>,
    pub token_type: String,
}

/// Secret scanning scan history for a repository.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SecretScanningScanHistory {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub incremental_scans: Option<Vec<SecretScanningScan>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub backfill_scans: Option<Vec<SecretScanningScan>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pattern_update_scans: Option<Vec<SecretScanningScan>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub custom_pattern_backfill_scans: Option<Vec<CustomPatternBackfillScan>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub generic_secrets_backfill_scans: Option<Vec<SecretScanningScan>>,
}

/// A secret scanning scan entry.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SecretScanningScan {
    #[serde(rename = "type")]
    pub scan_type: String,
    pub status: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub started_at: Option<DateTime<Utc>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub completed_at: Option<DateTime<Utc>>,
}

/// A custom pattern backfill scan entry.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CustomPatternBackfillScan {
    #[serde(rename = "type")]
    pub scan_type: String,
    pub status: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub started_at: Option<DateTime<Utc>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub completed_at: Option<DateTime<Utc>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pattern_slug: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pattern_scope: Option<String>,
}