octocrab 0.54.2

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

use serde::{Deserialize, Serialize};
use url::Url;

use crate::models::{apps::App, repos::RepoCommit, teams::Team, Author};

/// Detailed information about a branch returned by get and rename endpoints.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct DetailedBranch {
    pub name: String,
    pub commit: RepoCommit,
    pub protected: bool,
    #[serde(rename = "_links", skip_serializing_if = "Option::is_none")]
    pub links: Option<BranchLinks>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub protection: Option<BranchProtectionSummary>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub protection_url: Option<Url>,
}

/// Links associated with a branch.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct BranchLinks {
    pub html: Url,
    #[serde(rename = "self")]
    pub self_link: Url,
}

/// Summary of protection settings returned inside [`DetailedBranch`].
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct BranchProtectionSummary {
    pub enabled: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_status_checks: Option<BranchProtectionSummaryStatusChecks>,
}

/// Summary of required status checks returned inside [`BranchProtectionSummary`].
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct BranchProtectionSummaryStatusChecks {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enforcement_level: Option<String>,
    #[serde(default)]
    pub contexts: Vec<String>,
    #[serde(default)]
    pub checks: Vec<StatusCheck>,
}

/// A required status check entry.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct StatusCheck {
    pub context: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub app_id: Option<u64>,
}

impl StatusCheck {
    pub fn new(context: impl Into<String>) -> Self {
        Self {
            context: context.into(),
            app_id: None,
        }
    }

    pub fn with_app_id(context: impl Into<String>, app_id: u64) -> Self {
        Self {
            context: context.into(),
            app_id: Some(app_id),
        }
    }
}

/// Complete branch protection settings for a protected branch.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct BranchProtection {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_status_checks: Option<RequiredStatusChecks>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enforce_admins: Option<AdminEnforcement>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_pull_request_reviews: Option<RequiredPullRequestReviews>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub restrictions: Option<BranchProtectionRestrictions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_linear_history: Option<ProtectionFlag>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allow_force_pushes: Option<ProtectionFlag>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allow_deletions: Option<ProtectionFlag>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub block_creations: Option<ProtectionFlag>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_conversation_resolution: Option<ProtectionFlag>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lock_branch: Option<ProtectionFlag>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allow_fork_syncing: Option<ProtectionFlag>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_signatures: Option<ProtectionFlag>,
}

/// A boolean protection flag with an optional URL (e.g. required_signatures, linear_history).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ProtectionFlag {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
    pub enabled: bool,
}

/// Admin enforcement setting.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct AdminEnforcement {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
    pub enabled: bool,
}

/// Required status checks configuration.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct RequiredStatusChecks {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
    pub strict: bool,
    #[serde(default)]
    pub contexts: Vec<String>,
    #[serde(default)]
    pub checks: Vec<StatusCheck>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contexts_url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enforcement_level: Option<String>,
}

/// Required pull request review settings.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct RequiredPullRequestReviews {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dismiss_stale_reviews: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_code_owner_reviews: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_approving_review_count: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_last_push_approval: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dismissal_restrictions: Option<DismissalRestrictions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bypass_pull_request_allowances: Option<BypassPullRequestAllowances>,
}

/// Dismissal restrictions configuration.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct DismissalRestrictions {
    #[serde(default)]
    pub users: Vec<Author>,
    #[serde(default)]
    pub teams: Vec<Team>,
    #[serde(default)]
    pub apps: Vec<App>,
}

/// Bypass pull request allowances configuration.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct BypassPullRequestAllowances {
    #[serde(default)]
    pub users: Vec<Author>,
    #[serde(default)]
    pub teams: Vec<Team>,
    #[serde(default)]
    pub apps: Vec<App>,
}

/// Access restrictions for a protected branch.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct BranchProtectionRestrictions {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub users_url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub teams_url: Option<Url>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apps_url: Option<Url>,
    #[serde(default)]
    pub users: Vec<Author>,
    #[serde(default)]
    pub teams: Vec<Team>,
    #[serde(default)]
    pub apps: Vec<App>,
}

/// Request body for setting or updating status check contexts.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ContextsRequest {
    pub contexts: Vec<String>,
}

/// Request body for setting or updating user restrictions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct UsersRestrictionsRequest {
    pub users: Vec<String>,
}

/// Request body for setting or updating team restrictions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct TeamsRestrictionsRequest {
    pub teams: Vec<String>,
}

/// Request body for setting or updating app restrictions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct AppsRestrictionsRequest {
    pub apps: Vec<String>,
}

/// Request body for updating required status checks.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct UpdateStatusChecks {
    pub strict: bool,
    pub contexts: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub checks: Option<Vec<StatusCheck>>,
}

/// Request body for updating pull request reviews.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct UpdatePullRequestReviews {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dismiss_stale_reviews: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_code_owner_reviews: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_approving_review_count: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_last_push_approval: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dismissal_restrictions: Option<DismissalRestrictionsRequest>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bypass_pull_request_allowances: Option<BypassPullRequestAllowancesRequest>,
}

/// Request body for dismissal restrictions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct DismissalRestrictionsRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub users: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub teams: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apps: Option<Vec<String>>,
}

/// Request body for bypass pull request allowances.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct BypassPullRequestAllowancesRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub users: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub teams: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apps: Option<Vec<String>>,
}

/// Request body for updating push access restrictions.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
pub struct UpdateRestrictions {
    pub users: Vec<String>,
    pub teams: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apps: Option<Vec<String>>,
}