Skip to content
Sign up

flagon-io/g1t

public
00

Where people and agents ship software together. The open-source git platform for the whole job: issues, agents, checks and deploys to the edge.

g1t.sh
gitagentscloudflarerustforgemcp
1,536 linesCodeBlameRaw
1//! REST: each route maps an HTTP request onto one operation.
2
3use serde_json::{Map, Value};
4
5use crate::about::AboutOp;
6use crate::run_artifacts::ArtifactsOp;
7use crate::archives::ArchiveOp;
8use crate::deploy_keys::DeployKeysOp;
9use crate::mirrors::MirrorsOp;
10use crate::deployments::DeploymentsOp;
11use crate::telemetry::TelemetryOp;
12use crate::packages::PackagesOp;
13use crate::folios::FoliosOp;
14use crate::protection::ProtectionOp;
15use crate::token_policy::TokenOp;
16use crate::operations::Op;
17use crate::checks::ChecksOp;
18use crate::rules::RulesOp;
19use crate::security::SecurityOp;
20
21pub struct Route {
22 pub method: &'static str,
23 /// Segments starting with `:` are parameters.
24 pub path: &'static str,
25 pub op: Op,
26 /// Query parameters the route reads, as `(name in the URL, input name)`.
27 pub query: &'static [(&'static str, &'static str)],
28}
29
30const fn route(
31 method: &'static str,
32 path: &'static str,
33 op: Op,
34 query: &'static [(&'static str, &'static str)],
35) -> Route {
36 Route {
37 method,
38 path,
39 op,
40 query,
41 }
42}
43
44pub const ROUTES: &[Route] = &[
45 route("GET", "/user", Op::Whoami, &[]),
46 route("POST", "/workspaces", Op::CreateWorkspace, &[]),
47 route("GET", "/workspaces/:workspace", Op::GetWorkspace, &[]),
48 route("DELETE", "/workspaces/:workspace", Op::DeleteWorkspace, &[]),
49 route("GET", "/user/emails", Op::ListEmails, &[]),
50 route("POST", "/user/emails", Op::AddEmail, &[]),
51 route("POST", "/user/emails/confirm", Op::ConfirmEmail, &[]),
52 route("DELETE", "/user/emails/:email", Op::RemoveEmail, &[]),
53 route("PATCH", "/user/email-settings", Op::UpdateEmailSettings, &[]),
54 route("GET", "/user/invites", Op::ListInvites, &[]),
55 route("POST", "/user/invites", Op::CreateInvite, &[]),
56 route("DELETE", "/user/invites/:id", Op::RevokeInvite, &[]),
57 // Invitations to workspaces waiting for your answer.
58 route("GET", "/user/invitations", Op::ListInvitations, &[]),
59 route("POST", "/user/invitations/:id/accept", Op::AcceptInvitation, &[]),
60 route("POST", "/user/invitations/:id/decline", Op::DeclineInvitation, &[]),
61 route("GET", "/workspaces/:workspace/invitations", Op::ListWorkspaceInvites, &[]),
62 // A workspace's rules for personal access tokens, and its members' tokens.
63 route("GET", "/workspaces/:workspace/personal-access-token-policy", Op::Tokens(TokenOp::GetTokenPolicy), &[]),
64 route("PATCH", "/workspaces/:workspace/personal-access-token-policy", Op::Tokens(TokenOp::SetTokenPolicy), &[]),
65 route("GET", "/workspaces/:workspace/personal-access-tokens", Op::Tokens(TokenOp::ListMemberTokens), &[]),
66 route("POST", "/workspaces/:workspace/personal-access-tokens/:id", Op::Tokens(TokenOp::RevokeMemberToken), &[]),
67 route("GET", "/workspaces/:workspace/personal-access-token-requests", Op::Tokens(TokenOp::ListTokenRequests), &[]),
68 route("POST", "/workspaces/:workspace/personal-access-token-requests/:id", Op::Tokens(TokenOp::ReviewTokenRequest), &[]),
69 route("POST", "/workspaces/:workspace/invitations", Op::InviteMember, &[]),
70 route("DELETE", "/workspaces/:workspace/invitations/:id", Op::RevokeWorkspaceInvite, &[]),
71 // Who has access. GitHub's addresses, but for adding someone, which
72 // takes an email address as well as a username.
73 route("GET", "/repos/:owner/:name/collaborators", Op::ListCollaborators, &[]),
74 route("POST", "/repos/:owner/:name/collaborators", Op::AddCollaborator, &[]),
75 route("PATCH", "/repos/:owner/:name/collaborators/:username", Op::UpdateCollaborator, &[]),
76 route("DELETE", "/repos/:owner/:name/collaborators/:username", Op::RemoveCollaborator, &[]),
77 route(
78 "GET",
79 "/repos/:owner/:name/collaborators/:username/permission",
80 Op::GetCollaboratorPermission,
81 &[],
82 ),
83 route("GET", "/repos/:owner/:name/invitations", Op::ListRepoInvitations, &[]),
84 route("DELETE", "/repos/:owner/:name/invitations/:id", Op::RevokeRepoInvitation, &[]),
85 route("GET", "/user/repository_invitations", Op::ListMyRepoInvitations, &[]),
86 // Deploy keys, at GitHub's addresses.
87 route("GET", "/repos/:owner/:name/keys", Op::DeployKeys(DeployKeysOp::ListDeployKeys), &[]),
88 route("POST", "/repos/:owner/:name/keys", Op::DeployKeys(DeployKeysOp::CreateDeployKey), &[]),
89 route("GET", "/repos/:owner/:name/keys/:id", Op::DeployKeys(DeployKeysOp::GetDeployKey), &[]),
90 route("DELETE", "/repos/:owner/:name/keys/:id", Op::DeployKeys(DeployKeysOp::DeleteDeployKey), &[]),
91 // Mirroring: a repository's remotes, takeovers and hand-backs.
92 route("GET", "/repos/:owner/:name/mirror", Op::Mirrors(MirrorsOp::GetMirror), &[]),
93 route("GET", "/repos/:owner/:name/mirror/hand-back", Op::Mirrors(MirrorsOp::GetHandBackPlan), &[]),
94 route("POST", "/repos/:owner/:name/mirror/take-over", Op::Mirrors(MirrorsOp::TakeOver), &[]),
95 route("POST", "/repos/:owner/:name/mirror/ci", Op::Mirrors(MirrorsOp::SetCiFailover), &[]),
96 route("POST", "/repos/:owner/:name/mirror/hand-back", Op::Mirrors(MirrorsOp::HandBack), &[]),
97 route("POST", "/repos/:owner/:name/mirror/move-to-g1t", Op::Mirrors(MirrorsOp::MoveToG1t), &[]),
98 route("POST", "/repos/:owner/:name/mirror/sync", Op::Mirrors(MirrorsOp::SyncMirror), &[]),
99 route("POST", "/repos/:owner/:name/mirror/remotes", Op::Mirrors(MirrorsOp::AddRemote), &[]),
100 route("PATCH", "/repos/:owner/:name/mirror/remotes/:id", Op::Mirrors(MirrorsOp::UpdateRemote), &[]),
101 route("DELETE", "/repos/:owner/:name/mirror/remotes/:id", Op::Mirrors(MirrorsOp::RemoveRemote), &[]),
102 // Your notifications: threads, marking them, and what you subscribe
103 // to and watch. GitHub's addresses, with g1t's saved and snoozed.
104 route("GET", "/notifications", Op::ListNotifications, &[("all", "all"), ("participating", "participating"), ("view", "view"), ("reason", "reason"), ("severity", "severity"), ("since", "since"), ("before", "before"), ("cursor", "cursor"), ("per_page", "per_page")]),
105 route("PUT", "/notifications", Op::MarkNotificationsRead, &[]),
106 route("GET", "/notifications/threads/:id", Op::GetNotificationThread, &[]),
107 route("PATCH", "/notifications/threads/:id", Op::MarkThreadRead, &[]),
108 route("DELETE", "/notifications/threads/:id", Op::MarkThreadDone, &[]),
109 route("PUT", "/notifications/threads/:id/saved", Op::SaveThread, &[]),
110 route("DELETE", "/notifications/threads/:id/saved", Op::SaveThread, &[]),
111 route("PUT", "/notifications/threads/:id/snooze", Op::SnoozeThread, &[]),
112 route("DELETE", "/notifications/threads/:id/snooze", Op::SnoozeThread, &[]),
113 route("GET", "/notifications/threads/:id/subscription", Op::GetThreadSubscription, &[]),
114 route("PUT", "/notifications/threads/:id/subscription", Op::SetThreadSubscription, &[]),
115 route("DELETE", "/notifications/threads/:id/subscription", Op::DeleteThreadSubscription, &[]),
116 route("GET", "/repos/:owner/:name/notifications", Op::ListNotifications, &[("all", "all"), ("participating", "participating"), ("view", "view"), ("reason", "reason"), ("severity", "severity"), ("since", "since"), ("before", "before"), ("cursor", "cursor"), ("per_page", "per_page")]),
117 route("PUT", "/repos/:owner/:name/notifications", Op::MarkNotificationsRead, &[]),
118 route("GET", "/repos/:owner/:name/subscription", Op::GetRepoSubscription, &[]),
119 route("PUT", "/repos/:owner/:name/subscription", Op::SetRepoSubscription, &[]),
120 route("DELETE", "/repos/:owner/:name/subscription", Op::DeleteRepoSubscription, &[]),
121 route("GET", "/repos/:owner/:name/issues/:number/subscription", Op::GetThreadSubscription, &[]),
122 route("PUT", "/repos/:owner/:name/issues/:number/subscription", Op::SetThreadSubscription, &[]),
123 route("DELETE", "/repos/:owner/:name/issues/:number/subscription", Op::DeleteThreadSubscription, &[]),
124 route("GET", "/user/subscriptions", Op::ListWatchedRepos, &[]),
125 // Stars: yours, and who starred a repository.
126 route("GET", "/user/starred", Op::About(AboutOp::ListStarred), &[]),
127 route("GET", "/user/starred/:owner/:name", Op::About(AboutOp::CheckStarred), &[]),
128 route("PUT", "/user/starred/:owner/:name", Op::About(AboutOp::Star), &[]),
129 route("DELETE", "/user/starred/:owner/:name", Op::About(AboutOp::Unstar), &[]),
130 route("GET", "/repos/:owner/:name/stargazers", Op::About(AboutOp::ListStargazers), &[("page", "page")]),
131 // What the default branch says about a repository, kept by commit.
132 route("GET", "/repos/:owner/:name/languages", Op::About(AboutOp::GetLanguages), &[]),
133 route("GET", "/repos/:owner/:name/contributors", Op::About(AboutOp::ListContributors), &[]),
134 route("GET", "/repos/:owner/:name/license", Op::About(AboutOp::GetLicense), &[]),
135 // Releases: `latest` and `tags/…` before an id.
136 route("GET", "/repos/:owner/:name/releases", Op::About(AboutOp::ListReleases), &[]),
137 route("POST", "/repos/:owner/:name/releases", Op::About(AboutOp::CreateRelease), &[]),
138 route("GET", "/repos/:owner/:name/releases/latest", Op::About(AboutOp::GetLatestRelease), &[]),
139 route("GET", "/repos/:owner/:name/releases/tags/:tag", Op::About(AboutOp::GetReleaseByTag), &[]),
140 route("GET", "/repos/:owner/:name/releases/:id", Op::About(AboutOp::GetRelease), &[]),
141 route("PATCH", "/repos/:owner/:name/releases/:id", Op::About(AboutOp::UpdateRelease), &[]),
142 route("DELETE", "/repos/:owner/:name/releases/:id", Op::About(AboutOp::DeleteRelease), &[]),
143 // Your pinned projects in a workspace, in your order.
144 route("GET", "/user/pinned_projects/:workspace", Op::ListPinnedProjects, &[]),
145 route("PUT", "/user/pinned_projects/:workspace", Op::ReorderPinnedProjects, &[]),
146 route("PUT", "/user/pinned_projects/:workspace/:project", Op::PinProject, &[]),
147 route("DELETE", "/user/pinned_projects/:workspace/:project", Op::UnpinProject, &[]),
148 route("PATCH", "/user/repository_invitations/:id", Op::AcceptRepoInvitation, &[]),
149 route("DELETE", "/user/repository_invitations/:id", Op::DeclineRepoInvitation, &[]),
150 route("PATCH", "/workspaces/:workspace", Op::UpdateWorkspace, &[]),
151 // Members and owners: GitHub's organization members, by username.
152 route("GET", "/workspaces/:workspace/members", Op::ListMembers, &[]),
153 route("PATCH", "/workspaces/:workspace/members/:username", Op::UpdateMember, &[]),
154 route("DELETE", "/workspaces/:workspace/members/:username", Op::RemoveMember, &[]),
155 route("POST", "/workspaces/:workspace/transfer_ownership", Op::TransferOwnership, &[]),
156 route("DELETE", "/user/memberships/:workspace", Op::LeaveWorkspace, &[]),
157 // A workspace's projects: what each is, where it runs, its links.
158 route("GET", "/workspaces/:workspace/projects", Op::ListProjects, &[]),
159 route("GET", "/workspaces/:workspace/projects/:project", Op::GetProject, &[]),
160 route("PATCH", "/workspaces/:workspace/projects/:project", Op::UpdateProject, &[]),
161 // A project's observability: what its software did, and how it is collected.
162 route(
163 "GET",
164 "/workspaces/:workspace/projects/:project/observability/overview",
165 Op::Telemetry(TelemetryOp::GetOverview),
166 &[("from", "from"), ("to", "to"), ("environment", "environment"), ("service", "service"), ("deployment_id", "deployment_id"), ("step", "step")],
167 ),
168 route(
169 "GET",
170 "/workspaces/:workspace/projects/:project/observability/requests",
171 Op::Telemetry(TelemetryOp::ListRequests),
172 &[
173 ("from", "from"),
174 ("to", "to"),
175 ("q", "q"),
176 ("status", "status"),
177 ("errors_only", "errors_only"),
178 ("route", "route"),
179 ("min_duration_ms", "min_duration_ms"),
180 ("environment", "environment"),
181 ("service", "service"),
182 ("deployment_id", "deployment_id"),
183 ("cursor", "cursor"),
184 ("limit", "limit"),
185 ],
186 ),
187 route("GET", "/workspaces/:workspace/projects/:project/observability/requests/:id", Op::Telemetry(TelemetryOp::GetRequest), &[]),
188 route(
189 "GET",
190 "/workspaces/:workspace/projects/:project/observability/logs",
191 Op::Telemetry(TelemetryOp::ListLogs),
192 &[
193 ("from", "from"),
194 ("to", "to"),
195 ("q", "q"),
196 ("level", "level"),
197 ("trace_id", "trace_id"),
198 ("request_id", "request_id"),
199 ("environment", "environment"),
200 ("service", "service"),
201 ("deployment_id", "deployment_id"),
202 ("cursor", "cursor"),
203 ("limit", "limit"),
204 ],
205 ),
206 route(
207 "GET",
208 "/workspaces/:workspace/projects/:project/observability/traces",
209 Op::Telemetry(TelemetryOp::ListTraces),
210 &[
211 ("from", "from"),
212 ("to", "to"),
213 ("q", "q"),
214 ("errors_only", "errors_only"),
215 ("min_duration_ms", "min_duration_ms"),
216 ("environment", "environment"),
217 ("service", "service"),
218 ("cursor", "cursor"),
219 ("limit", "limit"),
220 ],
221 ),
222 route("GET", "/workspaces/:workspace/projects/:project/observability/traces/:trace_id", Op::Telemetry(TelemetryOp::GetTrace), &[]),
223 route(
224 "GET",
225 "/workspaces/:workspace/projects/:project/observability/errors",
226 Op::Telemetry(TelemetryOp::ListErrors),
227 &[("state", "state"), ("environment", "environment"), ("service", "service"), ("from", "from"), ("to", "to")],
228 ),
229 route("PATCH", "/workspaces/:workspace/projects/:project/observability/errors/:fingerprint", Op::Telemetry(TelemetryOp::UpdateError), &[]),
230 route("GET", "/workspaces/:workspace/projects/:project/observability/metrics", Op::Telemetry(TelemetryOp::ListMetrics), &[]),
231 route(
232 "GET",
233 "/workspaces/:workspace/projects/:project/observability/metrics/:metric",
234 Op::Telemetry(TelemetryOp::GetMetric),
235 &[("from", "from"), ("to", "to"), ("aggregate", "aggregate"), ("group_by", "group_by"), ("step", "step"), ("service", "service"), ("environment", "environment")],
236 ),
237 route("GET", "/workspaces/:workspace/projects/:project/observability/settings", Op::Telemetry(TelemetryOp::GetSettings), &[]),
238 route("PATCH", "/workspaces/:workspace/projects/:project/observability/settings", Op::Telemetry(TelemetryOp::UpdateSettings), &[]),
239 route("GET", "/workspaces/:workspace/projects/:project/observability/tokens", Op::Telemetry(TelemetryOp::ListTokens), &[]),
240 route("POST", "/workspaces/:workspace/projects/:project/observability/tokens", Op::Telemetry(TelemetryOp::CreateToken), &[]),
241 route("DELETE", "/workspaces/:workspace/projects/:project/observability/tokens/:id", Op::Telemetry(TelemetryOp::DeleteToken), &[]),
242 route("GET", "/workspaces/:workspace/projects/:project/observability/exports", Op::Telemetry(TelemetryOp::ListExports), &[]),
243 route("POST", "/workspaces/:workspace/projects/:project/observability/exports", Op::Telemetry(TelemetryOp::CreateExport), &[]),
244 route("PATCH", "/workspaces/:workspace/projects/:project/observability/exports/:id", Op::Telemetry(TelemetryOp::UpdateExport), &[]),
245 route("DELETE", "/workspaces/:workspace/projects/:project/observability/exports/:id", Op::Telemetry(TelemetryOp::DeleteExport), &[]),
246 route("GET", "/workspaces/:workspace/projects/:project/observability/usage", Op::Telemetry(TelemetryOp::GetUsage), &[]),
247 route("PUT", "/workspaces/:workspace/base_permission", Op::SetBasePermission, &[]),
248 route(
249 "GET",
250 "/workspaces/:workspace/outside_collaborators",
251 Op::ListOutsideCollaborators,
252 &[],
253 ),
254 // Teams: a workspace's groups of members, with roles on repositories.
255 route("GET", "/workspaces/:workspace/teams", Op::ListTeams, &[("q", "query")]),
256 route("POST", "/workspaces/:workspace/teams", Op::CreateTeam, &[]),
257 route("GET", "/workspaces/:workspace/teams/:team", Op::GetTeam, &[]),
258 route("PATCH", "/workspaces/:workspace/teams/:team", Op::UpdateTeam, &[]),
259 route("DELETE", "/workspaces/:workspace/teams/:team", Op::DeleteTeam, &[]),
260 route(
261 "GET",
262 "/workspaces/:workspace/teams/:team/members",
263 Op::ListTeamMembers,
264 &[("include_child_teams", "include_child_teams")],
265 ),
266 route("PUT", "/workspaces/:workspace/teams/:team/members/:username", Op::SetTeamMember, &[]),
267 route("DELETE", "/workspaces/:workspace/teams/:team/members/:username", Op::RemoveTeamMember, &[]),
268 route("GET", "/workspaces/:workspace/teams/:team/teams", Op::ListChildTeams, &[]),
269 route("GET", "/workspaces/:workspace/teams/:team/repos", Op::ListTeamRepos, &[]),
270 route("PUT", "/workspaces/:workspace/teams/:team/repos/:repo", Op::SetTeamRepo, &[]),
271 route("DELETE", "/workspaces/:workspace/teams/:team/repos/:repo", Op::RemoveTeamRepo, &[]),
272 route(
273 "PUT",
274 "/workspaces/:workspace/teams/:team/review_assignment",
275 Op::SetTeamReviewAssignment,
276 &[],
277 ),
278 route("GET", "/workspaces/:workspace/members/:username/teams", Op::ListUserTeams, &[]),
279 // A workspace's billing: usage, budget, AI credit and invoices.
280 route(
281 "GET",
282 "/workspaces/:workspace/usage",
283 Op::GetUsage,
284 &[("from", "from"), ("until", "until"), ("products", "products"), ("projects", "projects"), ("group_by", "group_by")],
285 ),
286 route("GET", "/workspaces/:workspace/budget", Op::GetBudget, &[]),
287 route("PUT", "/workspaces/:workspace/budget", Op::SetBudget, &[]),
288 route("GET", "/workspaces/:workspace/ai_credit", Op::GetAiCredit, &[]),
289 route("POST", "/workspaces/:workspace/ai_credit/checkout", Op::BuyAiCredit, &[]),
290 route("GET", "/workspaces/:workspace/invoices", Op::ListInvoices, &[]),
291 route("GET", "/workspaces/:workspace/billing_details", Op::GetBillingDetails, &[]),
292 // The AI Gateway's log of a workspace's requests.
293 // Code owners: the CODEOWNERS file, checked.
294 route("GET", "/repos/:owner/:name/codeowners/errors", Op::GetCodeownersErrors, &[("ref", "ref")]),
295 // Security alerts: secrets and vulnerable dependencies.
296 route(
297 "GET",
298 "/repos/:owner/:name/security/alerts",
299 Op::ListSecurityAlerts,
300 &[("state", "state"), ("kind", "kind")],
301 ),
302 route("POST", "/repos/:owner/:name/security/alerts/:id/dismiss", Op::DismissSecurityAlert, &[]),
303 route("POST", "/repos/:owner/:name/security/alerts/:id/reopen", Op::ReopenSecurityAlert, &[]),
304 // The security suite: secret scanning, code scanning, vulnerability
305 // alerts and the supply chain, at the common addresses.
306 route("GET", "/repos/:owner/:name/secret-scanning/alerts", Op::Security(SecurityOp::ListSecretAlerts), &[("state", "state"), ("secret_type", "secret_type"), ("validity", "validity"), ("bypassed", "bypassed")]),
307 route("GET", "/workspaces/:workspace/secret-scanning/alerts", Op::Security(SecurityOp::ListSecretAlerts), &[("state", "state"), ("secret_type", "secret_type"), ("validity", "validity"), ("bypassed", "bypassed")]),
308 route("GET", "/repos/:owner/:name/secret-scanning/alerts/:id", Op::Security(SecurityOp::GetSecretAlert), &[]),
309 route("PATCH", "/repos/:owner/:name/secret-scanning/alerts/:id", Op::Security(SecurityOp::UpdateSecretAlert), &[]),
310 route("GET", "/repos/:owner/:name/secret-scanning/alerts/:id/locations", Op::Security(SecurityOp::ListSecretLocations), &[]),
311 route("POST", "/repos/:owner/:name/secret-scanning/alerts/:id/bypass", Op::Security(SecurityOp::BypassPushProtection), &[]),
312 route("POST", "/repos/:owner/:name/secret-scanning/alerts/:id/validity", Op::Security(SecurityOp::CheckSecretValidity), &[]),
313 route("GET", "/workspaces/:workspace/secret-scanning/bypass-requests", Op::Security(SecurityOp::ListBypassRequests), &[("state", "state"), ("repo", "repo")]),
314 route("PATCH", "/workspaces/:workspace/secret-scanning/bypass-requests/:id", Op::Security(SecurityOp::ReviewBypassRequest), &[]),
315 route("POST", "/repos/:owner/:name/secret-scanning/custom-patterns/dry-run", Op::Security(SecurityOp::DryRunCustomPattern), &[]),
316 route("POST", "/workspaces/:workspace/secret-scanning/custom-patterns/dry-run", Op::Security(SecurityOp::DryRunCustomPattern), &[]),
317 route("GET", "/repos/:owner/:name/secret-scanning/custom-patterns", Op::Security(SecurityOp::ListCustomPatterns), &[]),
318 route("GET", "/workspaces/:workspace/secret-scanning/custom-patterns", Op::Security(SecurityOp::ListCustomPatterns), &[]),
319 route("POST", "/repos/:owner/:name/secret-scanning/custom-patterns", Op::Security(SecurityOp::CreateCustomPattern), &[]),
320 route("POST", "/workspaces/:workspace/secret-scanning/custom-patterns", Op::Security(SecurityOp::CreateCustomPattern), &[]),
321 route("PATCH", "/repos/:owner/:name/secret-scanning/custom-patterns/:id", Op::Security(SecurityOp::UpdateCustomPattern), &[]),
322 route("PATCH", "/workspaces/:workspace/secret-scanning/custom-patterns/:id", Op::Security(SecurityOp::UpdateCustomPattern), &[]),
323 route("DELETE", "/repos/:owner/:name/secret-scanning/custom-patterns/:id", Op::Security(SecurityOp::DeleteCustomPattern), &[]),
324 route("DELETE", "/workspaces/:workspace/secret-scanning/custom-patterns/:id", Op::Security(SecurityOp::DeleteCustomPattern), &[]),
325 route("GET", "/repos/:owner/:name/code-scanning/alerts", Op::Security(SecurityOp::ListCodeAlerts), &[("state", "state"), ("severity", "severity"), ("tool", "tool"), ("rule_id", "rule_id")]),
326 route("GET", "/workspaces/:workspace/code-scanning/alerts", Op::Security(SecurityOp::ListCodeAlerts), &[("state", "state"), ("severity", "severity"), ("tool", "tool"), ("rule_id", "rule_id")]),
327 route("GET", "/repos/:owner/:name/code-scanning/alerts/:number", Op::Security(SecurityOp::GetCodeAlert), &[]),
328 route("PATCH", "/repos/:owner/:name/code-scanning/alerts/:number", Op::Security(SecurityOp::UpdateCodeAlert), &[]),
329 route("GET", "/repos/:owner/:name/code-scanning/analyses", Op::Security(SecurityOp::ListAnalyses), &[]),
330 route("POST", "/repos/:owner/:name/code-scanning/sarifs", Op::Security(SecurityOp::UploadSarif), &[]),
331 route("GET", "/repos/:owner/:name/code-scanning/sarifs/:id", Op::Security(SecurityOp::GetSarifUpload), &[]),
332 route("GET", "/repos/:owner/:name/vulnerability-alerts", Op::Security(SecurityOp::ListVulnerabilityAlerts), &[("state", "state"), ("severity", "severity"), ("ecosystem", "ecosystem"), ("package", "package")]),
333 route("GET", "/workspaces/:workspace/vulnerability-alerts", Op::Security(SecurityOp::ListVulnerabilityAlerts), &[("state", "state"), ("severity", "severity"), ("ecosystem", "ecosystem"), ("package", "package")]),
334 route("GET", "/repos/:owner/:name/vulnerability-alerts/:id", Op::Security(SecurityOp::GetVulnerabilityAlert), &[]),
335 route("PATCH", "/repos/:owner/:name/vulnerability-alerts/:id", Op::Security(SecurityOp::UpdateVulnerabilityAlert), &[]),
336 route("GET", "/repos/:owner/:name/dependency-graph", Op::Security(SecurityOp::GetDependencyGraph), &[]),
337 route("GET", "/repos/:owner/:name/dependency-graph/sbom", Op::Security(SecurityOp::GetSbom), &[]),
338 route("GET", "/repos/:owner/:name/dependency-graph/compare/:basehead", Op::Security(SecurityOp::CompareDependencies), &[]),
339 route("GET", "/repos/:owner/:name/security/settings", Op::Security(SecurityOp::GetSettings), &[]),
340 route("PATCH", "/repos/:owner/:name/security/settings", Op::Security(SecurityOp::UpdateSettings), &[]),
341 route("GET", "/workspaces/:workspace/security/settings", Op::Security(SecurityOp::GetWorkspaceSettings), &[]),
342 route("PATCH", "/workspaces/:workspace/security/settings", Op::Security(SecurityOp::UpdateWorkspaceSettings), &[]),
343 route("GET", "/workspaces/:workspace/security/overview", Op::Security(SecurityOp::GetOverview), &[("days", "days")]),
344 // Reporting: a repository's advisories, and the vulnerability reports sent to its maintainers.
345 route("GET", "/repos/:owner/:name/security/advisories", Op::Security(SecurityOp::ListAdvisories), &[("state", "state")]),
346 route("POST", "/repos/:owner/:name/security/advisories", Op::Security(SecurityOp::CreateAdvisory), &[]),
347 route("GET", "/repos/:owner/:name/security/advisories/:id", Op::Security(SecurityOp::GetAdvisory), &[]),
348 route("PATCH", "/repos/:owner/:name/security/advisories/:id", Op::Security(SecurityOp::UpdateAdvisory), &[]),
349 route("POST", "/repos/:owner/:name/security/advisories/:id/state", Op::Security(SecurityOp::SetAdvisoryState), &[]),
350 route("GET", "/repos/:owner/:name/security/reports", Op::Security(SecurityOp::ListReports), &[("state", "state")]),
351 route("POST", "/repos/:owner/:name/security/reports", Op::Security(SecurityOp::ReportVulnerability), &[]),
352 route("PATCH", "/repos/:owner/:name/security/reports/:id", Op::Security(SecurityOp::ReviewReport), &[]),
353 route("GET", "/repos", Op::ListRepos, &[("q", "query")]),
354 route(
355 "GET",
356 "/search",
357 Op::Search,
358 &[("q", "query"), ("type", "type"), ("page", "page"), ("per_page", "per_page")],
359 ),
360 route("POST", "/repos", Op::CreateRepo, &[]),
361 route("GET", "/repos/:owner/:name", Op::GetRepo, &[]),
362 // A branch, tag or commit as one archive: a redirect to a link good for
363 // ten minutes, as GitHub's go to codeload.
364 route("GET", "/repos/:owner/:name/tarball/:ref", Op::Archives(ArchiveOp::DownloadTarball), &[]),
365 route("GET", "/repos/:owner/:name/zipball/:ref", Op::Archives(ArchiveOp::DownloadZipball), &[]),
366 route("PATCH", "/repos/:owner/:name", Op::UpdateRepo, &[]),
367 route("POST", "/repos/:owner/:name/transfer", Op::TransferRepo, &[]),
368 route("DELETE", "/repos/:owner/:name", Op::DeleteRepo, &[]),
369 route(
370 "GET",
371 "/workspaces/:workspace/repos/deleted",
372 Op::ListDeletedRepos,
373 &[],
374 ),
375 route("POST", "/repos/:owner/:name/restore", Op::RestoreRepo, &[]),
376 route("POST", "/repos/:owner/:name/purge", Op::PurgeRepo, &[]),
377 route("POST", "/repos/:owner/:name/rename", Op::RenameRepo, &[]),
378 route("POST", "/repos/:owner/:name/archive", Op::ArchiveRepo, &[]),
379 route("POST", "/repos/:owner/:name/unarchive", Op::UnarchiveRepo, &[]),
380 route(
381 "POST",
382 "/repos/:owner/:name/visibility",
383 Op::SetRepoVisibility,
384 &[],
385 ),
386 route(
387 "POST",
388 "/repos/:owner/:name/branches/:branch/rename",
389 Op::RenameBranch,
390 &[],
391 ),
392 route("POST", "/repos/:owner/:name/branches", Op::CreateBranch, &[]),
393 route("DELETE", "/repos/:owner/:name/branches/:branch", Op::DeleteBranch, &[("head", "head")]),
394 route(
395 "GET",
396 "/repos/:owner/:name/settings",
397 Op::GetRepoSettings,
398 &[],
399 ),
400 route(
401 "PATCH",
402 "/repos/:owner/:name/settings",
403 Op::UpdateRepoSettings,
404 &[],
405 ),
406 route("GET", "/repos/:owner/:name/check-names", Op::ListCheckNames, &[]),
407 // Checks: GitHub's addresses for statuses, check runs and check suites.
408 route("POST", "/repos/:owner/:name/statuses/:sha", Op::Checks(ChecksOp::CreateCommitStatus), &[]),
409 route("GET", "/repos/:owner/:name/commits/:ref/statuses", Op::Checks(ChecksOp::ListCommitStatuses), &[]),
410 route("GET", "/repos/:owner/:name/commits/:ref/status", Op::Checks(ChecksOp::GetCombinedStatus), &[]),
411 route(
412 "GET",
413 "/repos/:owner/:name/commits/:ref/check-runs",
414 Op::Checks(ChecksOp::ListCheckRunsForRef),
415 &[("check_name", "check_name"), ("status", "status"), ("app", "app"), ("filter", "filter")],
416 ),
417 route(
418 "GET",
419 "/repos/:owner/:name/commits/:ref/check-suites",
420 Op::Checks(ChecksOp::ListCheckSuitesForRef),
421 &[("app", "app"), ("check_name", "check_name")],
422 ),
423 route("POST", "/repos/:owner/:name/check-runs", Op::Checks(ChecksOp::CreateCheckRun), &[]),
424 route("GET", "/repos/:owner/:name/check-runs/:id", Op::Checks(ChecksOp::GetCheckRun), &[]),
425 route("PATCH", "/repos/:owner/:name/check-runs/:id", Op::Checks(ChecksOp::UpdateCheckRun), &[]),
426 route("GET", "/repos/:owner/:name/check-runs/:id/annotations", Op::Checks(ChecksOp::ListCheckRunAnnotations), &[]),
427 route("POST", "/repos/:owner/:name/check-runs/:id/rerequest", Op::Checks(ChecksOp::RerequestCheckRun), &[]),
428 route("GET", "/repos/:owner/:name/check-suites/:id", Op::Checks(ChecksOp::GetCheckSuite), &[]),
429 route("POST", "/repos/:owner/:name/check-suites/:id/rerequest", Op::Checks(ChecksOp::RerequestCheckSuite), &[]),
430 // Rulesets: a repository's, a workspace's, the rules of one branch,
431 // and how they judged pushes and merges.
432 route("GET", "/repos/:owner/:name/rulesets", Op::Rules(RulesOp::ListRepoRulesets), &[("include_parents", "include_parents")]),
433 route("POST", "/repos/:owner/:name/rulesets", Op::Rules(RulesOp::CreateRepoRuleset), &[]),
434 route("GET", "/repos/:owner/:name/rulesets/:id", Op::Rules(RulesOp::GetRepoRuleset), &[]),
435 route("PUT", "/repos/:owner/:name/rulesets/:id", Op::Rules(RulesOp::UpdateRepoRuleset), &[]),
436 route("DELETE", "/repos/:owner/:name/rulesets/:id", Op::Rules(RulesOp::DeleteRepoRuleset), &[]),
437 route("GET", "/repos/:owner/:name/rules/branches/:branch", Op::Rules(RulesOp::GetBranchRules), &[("target", "target")]),
438 route(
439 "GET",
440 "/repos/:owner/:name/rules/evaluations",
441 Op::Rules(RulesOp::ListRuleEvaluations),
442 &[("ruleset_id", "ruleset_id"), ("verdict", "verdict"), ("problems_only", "problems_only"), ("before", "before"), ("limit", "limit")],
443 ),
444 route("GET", "/workspaces/:workspace/rulesets", Op::Rules(RulesOp::ListWorkspaceRulesets), &[]),
445 route("POST", "/workspaces/:workspace/rulesets", Op::Rules(RulesOp::CreateWorkspaceRuleset), &[]),
446 route("GET", "/workspaces/:workspace/rulesets/:id", Op::Rules(RulesOp::GetWorkspaceRuleset), &[]),
447 route("PUT", "/workspaces/:workspace/rulesets/:id", Op::Rules(RulesOp::UpdateWorkspaceRuleset), &[]),
448 route("DELETE", "/workspaces/:workspace/rulesets/:id", Op::Rules(RulesOp::DeleteWorkspaceRuleset), &[]),
449 route(
450 "GET",
451 "/workspaces/:workspace/rules/evaluations",
452 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
453 &[("ruleset_id", "ruleset_id"), ("verdict", "verdict"), ("problems_only", "problems_only"), ("before", "before"), ("limit", "limit")],
454 ),
455 // Deployments wherever they run, their statuses, and environments.
456 route(
457 "GET",
458 "/repos/:owner/:name/deployments",
459 Op::Deployments(DeploymentsOp::ListDeployments),
460 &[("environment", "environment"), ("ref", "ref"), ("sha", "sha"), ("task", "task"), ("state", "state"), ("source", "source"), ("creator", "creator"), ("page", "page"), ("per_page", "per_page")],
461 ),
462 route("POST", "/repos/:owner/:name/deployments", Op::Deployments(DeploymentsOp::CreateDeployment), &[]),
463 // A g1t Actions job opening a g1t.page build it runs itself.
464 route("POST", "/repos/:owner/:name/deployments/builds", Op::Deployments(DeploymentsOp::StartDeploymentBuild), &[]),
465 route("GET", "/repos/:owner/:name/deployments/:id", Op::Deployments(DeploymentsOp::GetDeployment), &[]),
466 route("GET", "/repos/:owner/:name/deployments/:id/statuses", Op::Deployments(DeploymentsOp::ListDeploymentStatuses), &[]),
467 route("POST", "/repos/:owner/:name/deployments/:id/statuses", Op::Deployments(DeploymentsOp::CreateDeploymentStatus), &[]),
468 route("GET", "/repos/:owner/:name/environments", Op::Deployments(DeploymentsOp::ListEnvironments), &[]),
469 route("GET", "/repos/:owner/:name/environments/:environment", Op::Deployments(DeploymentsOp::GetEnvironment), &[]),
470 // Environments' protection rules, and the runs they hold.
471 route("PUT", "/repos/:owner/:name/environments/:environment", Op::Protection(ProtectionOp::UpdateEnvironment), &[]),
472 route("DELETE", "/repos/:owner/:name/environments/:environment", Op::Protection(ProtectionOp::DeleteEnvironment), &[]),
473 route(
474 "GET",
475 "/repos/:owner/:name/actions/runs/:id/pending_deployments",
476 Op::Protection(ProtectionOp::GetPendingDeployments),
477 &[],
478 ),
479 route(
480 "POST",
481 "/repos/:owner/:name/actions/runs/:id/pending_deployments",
482 Op::Protection(ProtectionOp::ReviewPendingDeployments),
483 &[],
484 ),
485 route("POST", "/repos/:owner/:name/actions/runs/:id/approve", Op::Protection(ProtectionOp::ApproveWorkflowRun), &[]),
486 route("GET", "/repos/:owner/:name/actions/permissions/workflow", Op::Protection(ProtectionOp::GetWorkflowPermissions), &[]),
487 route("PUT", "/repos/:owner/:name/actions/permissions/workflow", Op::Protection(ProtectionOp::SetWorkflowPermissions), &[]),
488 route(
489 "GET",
490 "/repos/:owner/:name/actions/permissions/fork-pr-contributor-approval",
491 Op::Protection(ProtectionOp::GetForkPrApproval),
492 &[],
493 ),
494 route(
495 "PUT",
496 "/repos/:owner/:name/actions/permissions/fork-pr-contributor-approval",
497 Op::Protection(ProtectionOp::SetForkPrApproval),
498 &[],
499 ),
500 route("GET", "/repos/:owner/:name/actions/permissions/access", Op::Protection(ProtectionOp::GetActionsAccess), &[]),
501 route("PUT", "/repos/:owner/:name/actions/permissions/access", Op::Protection(ProtectionOp::SetActionsAccess), &[]),
502 route("POST", "/repos/:owner/:name/dispatches", Op::Protection(ProtectionOp::CreateRepositoryDispatch), &[]),
503 route(
504 "GET",
505 "/workspaces/:workspace/actions/permissions/workflow",
506 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
507 &[],
508 ),
509 route(
510 "PUT",
511 "/workspaces/:workspace/actions/permissions/workflow",
512 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
513 &[],
514 ),
515 route(
516 "GET",
517 "/workspaces/:workspace/actions/managed-workflows",
518 Op::Protection(ProtectionOp::ListWorkspaceManagedWorkflows),
519 &[],
520 ),
521 route(
522 "POST",
523 "/workspaces/:workspace/actions/managed-workflows",
524 Op::Protection(ProtectionOp::CreateWorkspaceManagedWorkflow),
525 &[],
526 ),
527 route(
528 "PATCH",
529 "/workspaces/:workspace/actions/managed-workflows/:workflow",
530 Op::Protection(ProtectionOp::UpdateWorkspaceManagedWorkflow),
531 &[],
532 ),
533 route(
534 "DELETE",
535 "/workspaces/:workspace/actions/managed-workflows/:workflow",
536 Op::Protection(ProtectionOp::DeleteWorkspaceManagedWorkflow),
537 &[],
538 ),
539 route("GET", "/repos/:owner/:name/queue", Op::GetMergeQueue, &[]),
540 route("POST", "/repos/:owner/:name/memory", Op::Remember, &[]),
541 route(
542 "GET",
543 "/repos/:owner/:name/memory",
544 Op::Recall,
545 &[("q", "query"), ("limit", "limit")],
546 ),
547 route(
548 "GET",
549 "/repos/:owner/:name/events",
550 Op::ListEvents,
551 &[("before", "before")],
552 ),
553 route("GET", "/repos/:owner/:name/labels", Op::ListLabels, &[]),
554 route("POST", "/repos/:owner/:name/labels", Op::CreateLabel, &[]),
555 route("POST", "/repos/:owner/:name/labels/defaults", Op::AddDefaultLabels, &[]),
556 route("PATCH", "/repos/:owner/:name/labels/:label", Op::UpdateLabel, &[]),
557 route("DELETE", "/repos/:owner/:name/labels/:label", Op::DeleteLabel, &[]),
558 route("GET", "/repos/:owner/:name/issues/:number/labels", Op::ListIssueLabels, &[]),
559 route("POST", "/repos/:owner/:name/issues/:number/labels", Op::AddIssueLabels, &[]),
560 route("PUT", "/repos/:owner/:name/issues/:number/labels", Op::SetIssueLabels, &[]),
561 route("DELETE", "/repos/:owner/:name/issues/:number/labels", Op::RemoveIssueLabels, &[]),
562 route("DELETE", "/repos/:owner/:name/issues/:number/labels/:label", Op::RemoveIssueLabels, &[]),
563 route("GET", "/repos/:owner/:name/milestones", Op::ListMilestones, &[("state", "state")]),
564 route("POST", "/repos/:owner/:name/milestones", Op::CreateMilestone, &[]),
565 route("GET", "/repos/:owner/:name/milestones/:milestone", Op::GetMilestone, &[]),
566 route("PATCH", "/repos/:owner/:name/milestones/:milestone", Op::UpdateMilestone, &[]),
567 route("DELETE", "/repos/:owner/:name/milestones/:milestone", Op::DeleteMilestone, &[]),
568 route(
569 "GET",
570 "/repos/:owner/:name/issues",
571 Op::ListIssues,
572 &[("state", "state"), ("label", "label"), ("milestone", "milestone")],
573 ),
574 route("POST", "/repos/:owner/:name/issues", Op::CreateIssue, &[]),
575 route(
576 "GET",
577 "/repos/:owner/:name/issues/:number",
578 Op::GetIssue,
579 &[],
580 ),
581 route(
582 "PATCH",
583 "/repos/:owner/:name/issues/:number",
584 Op::UpdateIssue,
585 &[],
586 ),
587 route(
588 "POST",
589 "/repos/:owner/:name/issues/:number/close",
590 Op::CloseIssue,
591 &[],
592 ),
593 route(
594 "POST",
595 "/repos/:owner/:name/issues/:number/reopen",
596 Op::ReopenIssue,
597 &[],
598 ),
599 route(
600 "POST",
601 "/repos/:owner/:name/issues/import",
602 Op::ImportIssue,
603 &[],
604 ),
605 route(
606 "GET",
607 "/repos/:owner/:name/context",
608 Op::GetContext,
609 &[("reference", "reference")],
610 ),
611 route(
612 "GET",
613 "/workspaces/:workspace/integrations",
614 Op::ListIntegrations,
615 &[],
616 ),
617 route(
618 "POST",
619 "/workspaces/:workspace/integrations",
620 Op::ConnectIntegration,
621 &[],
622 ),
623 route(
624 "GET",
625 "/repos/:owner/:name/hooks",
626 Op::ListWebhooks,
627 &[],
628 ),
629 route(
630 "POST",
631 "/repos/:owner/:name/hooks",
632 Op::CreateWebhook,
633 &[],
634 ),
635 route(
636 "PATCH",
637 "/repos/:owner/:name/hooks/:id",
638 Op::UpdateWebhook,
639 &[],
640 ),
641 route(
642 "DELETE",
643 "/repos/:owner/:name/hooks/:id",
644 Op::DeleteWebhook,
645 &[],
646 ),
647 route(
648 "POST",
649 "/repos/:owner/:name/hooks/:id/pings",
650 Op::PingWebhook,
651 &[],
652 ),
653 route(
654 "GET",
655 "/repos/:owner/:name/hooks/:id/deliveries",
656 Op::ListWebhookDeliveries,
657 &[],
658 ),
659 route(
660 "POST",
661 "/repos/:owner/:name/hooks/:id/deliveries/:delivery/redeliver",
662 Op::RedeliverWebhook,
663 &[],
664 ),
665 route(
666 "GET",
667 "/workspaces/:workspace/hooks",
668 Op::ListWebhooks,
669 &[],
670 ),
671 route(
672 "POST",
673 "/workspaces/:workspace/hooks",
674 Op::CreateWebhook,
675 &[],
676 ),
677 route(
678 "PATCH",
679 "/workspaces/:workspace/hooks/:id",
680 Op::UpdateWebhook,
681 &[],
682 ),
683 route(
684 "DELETE",
685 "/workspaces/:workspace/hooks/:id",
686 Op::DeleteWebhook,
687 &[],
688 ),
689 route(
690 "POST",
691 "/workspaces/:workspace/hooks/:id/pings",
692 Op::PingWebhook,
693 &[],
694 ),
695 route(
696 "GET",
697 "/workspaces/:workspace/hooks/:id/deliveries",
698 Op::ListWebhookDeliveries,
699 &[],
700 ),
701 route(
702 "POST",
703 "/workspaces/:workspace/hooks/:id/deliveries/:delivery/redeliver",
704 Op::RedeliverWebhook,
705 &[],
706 ),
707 route(
708 "PATCH",
709 "/workspaces/:workspace/integrations/:id",
710 Op::UpdateIntegration,
711 &[],
712 ),
713 route(
714 "DELETE",
715 "/workspaces/:workspace/integrations/:id",
716 Op::DisconnectIntegration,
717 &[],
718 ),
719 route(
720 "POST",
721 "/workspaces/:workspace/integrations/:id/test",
722 Op::TestIntegration,
723 &[],
724 ),
725 route(
726 "GET",
727 "/repos/:owner/:name/actions/workflows",
728 Op::ListWorkflows,
729 &[],
730 ),
731 route(
732 "GET",
733 "/repos/:owner/:name/actions/workflows/:workflow/runs",
734 Op::ListWorkflowRuns,
735 &[("branch", "branch"), ("event", "event"), ("per_page", "limit")],
736 ),
737 route(
738 "POST",
739 "/repos/:owner/:name/actions/workflows/:workflow/dispatches",
740 Op::DispatchWorkflow,
741 &[],
742 ),
743 route(
744 "PATCH",
745 "/repos/:owner/:name/actions/workflows/:workflow",
746 Op::UpdateWorkflow,
747 &[],
748 ),
749 route(
750 "PUT",
751 "/repos/:owner/:name/actions/workflows/:workflow/enable",
752 Op::UpdateWorkflow,
753 &[],
754 ),
755 route(
756 "PUT",
757 "/repos/:owner/:name/actions/workflows/:workflow/disable",
758 Op::UpdateWorkflow,
759 &[],
760 ),
761 route(
762 "GET",
763 "/repos/:owner/:name/actions/runs",
764 Op::ListWorkflowRuns,
765 &[("workflow", "workflow"), ("branch", "branch"), ("event", "event"), ("pull", "pull"), ("head_sha", "sha"), ("per_page", "limit")],
766 ),
767 route(
768 "GET",
769 "/repos/:owner/:name/actions/runs/:id",
770 Op::GetWorkflowRun,
771 &[],
772 ),
773 route(
774 "GET",
775 "/repos/:owner/:name/actions/runs/:id/attempts/:attempt",
776 Op::GetWorkflowRun,
777 &[],
778 ),
779 route(
780 "POST",
781 "/repos/:owner/:name/actions/runs/:id/cancel",
782 Op::CancelWorkflowRun,
783 &[],
784 ),
785 route(
786 "POST",
787 "/repos/:owner/:name/actions/runs/:id/force-cancel",
788 Op::CancelWorkflowRun,
789 &[],
790 ),
791 route(
792 "POST",
793 "/repos/:owner/:name/actions/runs/:id/rerun",
794 Op::RerunWorkflowRun,
795 &[],
796 ),
797 route(
798 "POST",
799 "/repos/:owner/:name/actions/runs/:id/rerun-failed-jobs",
800 Op::RerunWorkflowRun,
801 &[],
802 ),
803 route(
804 "POST",
805 "/repos/:owner/:name/actions/jobs/:job/rerun",
806 Op::RerunWorkflowRun,
807 &[],
808 ),
809 route(
810 "GET",
811 "/repos/:owner/:name/actions/jobs/:job/logs",
812 Op::GetJobLogs,
813 &[("after", "after")],
814 ),
815 // Packages, at GitHub's addresses with the workspace in place of the
816 // organization. A name with a slash is one URL-encoded segment.
817 route("GET", "/workspaces/:workspace/packages", Op::Packages(PackagesOp::ListPackages), &[("package_type", "package_type"), ("q", "q"), ("state", "state")]),
818 route("GET", "/workspaces/:workspace/packages/:package_type/:package_name", Op::Packages(PackagesOp::GetPackage), &[]),
819 route("PATCH", "/workspaces/:workspace/packages/:package_type/:package_name", Op::Packages(PackagesOp::UpdatePackage), &[]),
820 route("DELETE", "/workspaces/:workspace/packages/:package_type/:package_name", Op::Packages(PackagesOp::DeletePackage), &[]),
821 route("POST", "/workspaces/:workspace/packages/:package_type/:package_name/restore", Op::Packages(PackagesOp::RestorePackage), &[]),
822 route("GET", "/workspaces/:workspace/packages/:package_type/:package_name/versions", Op::Packages(PackagesOp::ListVersions), &[("state", "state")]),
823 route("GET", "/workspaces/:workspace/packages/:package_type/:package_name/versions/:version_id", Op::Packages(PackagesOp::GetVersion), &[]),
824 route("DELETE", "/workspaces/:workspace/packages/:package_type/:package_name/versions/:version_id", Op::Packages(PackagesOp::DeleteVersion), &[]),
825 route("POST", "/workspaces/:workspace/packages/:package_type/:package_name/versions/:version_id/restore", Op::Packages(PackagesOp::RestoreVersion), &[]),
826 route("PUT", "/workspaces/:workspace/packages/:package_type/:package_name/repository", Op::Packages(PackagesOp::LinkPackage), &[]),
827 route("DELETE", "/workspaces/:workspace/packages/:package_type/:package_name/repository", Op::Packages(PackagesOp::UnlinkPackage), &[]),
828 route("GET", "/workspaces/:workspace/packages/:package_type/:package_name/access", Op::Packages(PackagesOp::ListAccess), &[]),
829 route("PUT", "/workspaces/:workspace/packages/:package_type/:package_name/access", Op::Packages(PackagesOp::SetAccess), &[]),
830 route("DELETE", "/workspaces/:workspace/packages/:package_type/:package_name/access", Op::Packages(PackagesOp::RemoveAccess), &[("username", "username"), ("team", "team")]),
831 route("GET", "/workspaces/:workspace/packages/:package_type/:package_name/actions-access", Op::Packages(PackagesOp::ListActionsAccess), &[]),
832 route("PUT", "/workspaces/:workspace/packages/:package_type/:package_name/actions-access", Op::Packages(PackagesOp::SetActionsAccess), &[]),
833 route("DELETE", "/workspaces/:workspace/packages/:package_type/:package_name/actions-access/:repository", Op::Packages(PackagesOp::RemoveActionsAccess), &[]),
834 // Artifacts, at GitHub's addresses. `…/zip` answers with a redirect to
835 // a signed link (lib.rs).
836 route("GET", "/repos/:owner/:name/actions/artifacts", Op::Artifacts(ArtifactsOp::ListArtifacts), &[("name", "name"), ("page", "page"), ("per_page", "per_page")]),
837 route("GET", "/repos/:owner/:name/actions/runs/:id/artifacts", Op::Artifacts(ArtifactsOp::ListRunArtifacts), &[("name", "name")]),
838 route("GET", "/repos/:owner/:name/actions/artifacts/:id", Op::Artifacts(ArtifactsOp::GetArtifact), &[]),
839 route("GET", "/repos/:owner/:name/actions/artifacts/:id/zip", Op::Artifacts(ArtifactsOp::DownloadArtifact), &[]),
840 route("DELETE", "/repos/:owner/:name/actions/artifacts/:id", Op::Artifacts(ArtifactsOp::DeleteArtifact), &[]),
841 route("GET", "/repos/:owner/:name/actions/permissions/artifact-and-log-retention", Op::Artifacts(ArtifactsOp::GetArtifactRetention), &[]),
842 route("PUT", "/repos/:owner/:name/actions/permissions/artifact-and-log-retention", Op::Artifacts(ArtifactsOp::SetArtifactRetention), &[]),
843 route(
844 "GET",
845 "/repos/:owner/:name/actions/secrets",
846 Op::ListActionsSecrets,
847 &[],
848 ),
849 route(
850 "PUT",
851 "/repos/:owner/:name/actions/secrets/:setting",
852 Op::SetActionsSecret,
853 &[],
854 ),
855 route(
856 "DELETE",
857 "/repos/:owner/:name/actions/secrets/:setting",
858 Op::DeleteActionsSecret,
859 &[],
860 ),
861 route(
862 "GET",
863 "/repos/:owner/:name/actions/variables",
864 Op::ListActionsVariables,
865 &[],
866 ),
867 route(
868 "POST",
869 "/repos/:owner/:name/actions/variables",
870 Op::SetActionsVariable,
871 &[],
872 ),
873 route(
874 "PATCH",
875 "/repos/:owner/:name/actions/variables/:setting",
876 Op::SetActionsVariable,
877 &[],
878 ),
879 route(
880 "DELETE",
881 "/repos/:owner/:name/actions/variables/:setting",
882 Op::DeleteActionsVariable,
883 &[],
884 ),
885 route(
886 "GET",
887 "/workspaces/:workspace/actions/secrets",
888 Op::ListActionsSecrets,
889 &[],
890 ),
891 route(
892 "PUT",
893 "/workspaces/:workspace/actions/secrets/:setting",
894 Op::SetActionsSecret,
895 &[],
896 ),
897 route(
898 "DELETE",
899 "/workspaces/:workspace/actions/secrets/:setting",
900 Op::DeleteActionsSecret,
901 &[],
902 ),
903 route(
904 "GET",
905 "/workspaces/:workspace/actions/variables",
906 Op::ListActionsVariables,
907 &[],
908 ),
909 route(
910 "POST",
911 "/workspaces/:workspace/actions/variables",
912 Op::SetActionsVariable,
913 &[],
914 ),
915 route(
916 "PATCH",
917 "/workspaces/:workspace/actions/variables/:setting",
918 Op::SetActionsVariable,
919 &[],
920 ),
921 route(
922 "DELETE",
923 "/workspaces/:workspace/actions/variables/:setting",
924 Op::DeleteActionsVariable,
925 &[],
926 ),
927 // Self-hosted runners: a repository's own, or a workspace's.
928 route("GET", "/repos/:owner/:name/actions/runners", Op::ListRunners, &[]),
929 route("POST", "/repos/:owner/:name/actions/runners/registration-token", Op::CreateRunnerRegistrationToken, &[]),
930 route("DELETE", "/repos/:owner/:name/actions/runners/:id", Op::RemoveRunner, &[]),
931 route("GET", "/repos/:owner/:name/actions/runner-settings", Op::GetRunnerSettings, &[]),
932 route("PATCH", "/repos/:owner/:name/actions/runner-settings", Op::UpdateRunnerSettings, &[]),
933 route("GET", "/workspaces/:workspace/actions/runners", Op::ListRunners, &[]),
934 route("POST", "/workspaces/:workspace/actions/runners/registration-token", Op::CreateRunnerRegistrationToken, &[]),
935 route("DELETE", "/workspaces/:workspace/actions/runners/:id", Op::RemoveRunner, &[]),
936 route("GET", "/workspaces/:workspace/actions/runner-settings", Op::GetRunnerSettings, &[]),
937 route("PATCH", "/workspaces/:workspace/actions/runner-settings", Op::UpdateRunnerSettings, &[]),
938 route("GET", "/workspaces/:workspace/actions/runner-groups", Op::ListRunnerGroups, &[]),
939 route("POST", "/workspaces/:workspace/actions/runner-groups", Op::CreateRunnerGroup, &[]),
940 route("PATCH", "/workspaces/:workspace/actions/runner-groups/:id", Op::UpdateRunnerGroup, &[]),
941 route("DELETE", "/workspaces/:workspace/actions/runner-groups/:id", Op::DeleteRunnerGroup, &[]),
942 route(
943 "POST",
944 "/repos/:owner/:name/issues/:number/comments",
945 Op::AddComment,
946 &[],
947 ),
948 route("PATCH", "/repos/:owner/:name/issues/comments/:comment_id", Op::EditComment, &[]),
949 route("DELETE", "/repos/:owner/:name/issues/comments/:comment_id", Op::DeleteComment, &[]),
950 route(
951 "GET",
952 "/repos/:owner/:name/pulls",
953 Op::ListPullRequests,
954 &[("state", "state"), ("label", "label"), ("milestone", "milestone"), ("base", "base")],
955 ),
956 route(
957 "POST",
958 "/repos/:owner/:name/pulls",
959 Op::CreatePullRequest,
960 &[],
961 ),
962 route(
963 "GET",
964 "/repos/:owner/:name/pulls/:number",
965 Op::GetPullRequest,
966 &[],
967 ),
968 route(
969 "PATCH",
970 "/repos/:owner/:name/pulls/:number",
971 Op::UpdatePullRequest,
972 &[],
973 ),
974 route(
975 "GET",
976 "/repos/:owner/:name/pulls/:number/changes",
977 Op::GetPullRequestChanges,
978 &[],
979 ),
980 route(
981 "POST",
982 "/repos/:owner/:name/pulls/:number/reviews",
983 Op::ReviewPullRequest,
984 &[],
985 ),
986 route(
987 "POST",
988 "/repos/:owner/:name/pulls/:number/requested_reviewers",
989 Op::RequestReviewers,
990 &[],
991 ),
992 route(
993 "DELETE",
994 "/repos/:owner/:name/pulls/:number/requested_reviewers",
995 Op::RemoveRequestedReviewers,
996 &[],
997 ),
998 route(
999 "GET",
1000 "/repos/:owner/:name/pulls/:number/session",
1001 Op::ReadSession,
1002 &[("after", "after")],
1003 ),
1004 route(
1005 "POST",
1006 "/repos/:owner/:name/pulls/:number/session",
1007 Op::RecordSession,
1008 &[],
1009 ),
1010 route(
1011 "POST",
1012 "/repos/:owner/:name/pulls/:number/ready",
1013 Op::MarkPullRequestReady,
1014 &[],
1015 ),
1016 route("POST", "/repos/:owner/:name/pulls/:number/draft", Op::ConvertPullRequestToDraft, &[]),
1017 route(
1018 "POST",
1019 "/repos/:owner/:name/pulls/:number/close",
1020 Op::ClosePullRequest,
1021 &[],
1022 ),
1023 route("POST", "/repos/:owner/:name/pulls/:number/reopen", Op::ReopenPullRequest, &[]),
1024 route(
1025 "POST",
1026 "/repos/:owner/:name/pulls/:number/merge",
1027 Op::MergePullRequest,
1028 &[],
1029 ),
1030 // Artifacts mode's docs, slides, designs and dashboards. Search comes
1031 // before an artifact by id, which it would otherwise match.
1032 route("GET", "/workspaces/:workspace/artifacts", Op::Folios(FoliosOp::List), &[("tab", "tab"), ("kind", "kind"), ("space", "space"), ("project", "project"), ("q", "q"), ("state", "state"), ("cursor", "cursor"), ("limit", "limit")]),
1033 route("POST", "/workspaces/:workspace/artifacts", Op::Folios(FoliosOp::Create), &[]),
1034 route("GET", "/workspaces/:workspace/artifacts/search", Op::Folios(FoliosOp::Search), &[("q", "q"), ("kind", "kind"), ("space", "space"), ("project", "project"), ("limit", "limit")]),
1035 route("GET", "/workspaces/:workspace/artifacts/:artifact_id", Op::Folios(FoliosOp::Get), &[]),
1036 route("PATCH", "/workspaces/:workspace/artifacts/:artifact_id", Op::Folios(FoliosOp::Update), &[]),
1037 route("DELETE", "/workspaces/:workspace/artifacts/:artifact_id", Op::Folios(FoliosOp::Trash), &[]),
1038 route("POST", "/workspaces/:workspace/artifacts/:artifact_id/restore", Op::Folios(FoliosOp::Restore), &[]),
1039 route("POST", "/workspaces/:workspace/artifacts/:artifact_id/purge", Op::Folios(FoliosOp::Purge), &[]),
1040 route("GET", "/workspaces/:workspace/artifacts/:artifact_id/content", Op::Folios(FoliosOp::GetContent), &[]),
1041 route("PUT", "/workspaces/:workspace/artifacts/:artifact_id/content", Op::Folios(FoliosOp::Edit), &[]),
1042 route("GET", "/workspaces/:workspace/artifacts/:artifact_id/access", Op::Folios(FoliosOp::GetAccess), &[]),
1043 route("PUT", "/workspaces/:workspace/artifacts/:artifact_id/access", Op::Folios(FoliosOp::SetAccess), &[]),
1044 route("GET", "/workspaces/:workspace/artifacts/:artifact_id/versions", Op::Folios(FoliosOp::ListVersions), &[]),
1045 route("POST", "/workspaces/:workspace/artifacts/:artifact_id/versions/:version_id/restore", Op::Folios(FoliosOp::RestoreVersion), &[]),
1046 route("GET", "/workspaces/:workspace/artifact-templates", Op::Folios(FoliosOp::ListTemplates), &[("kind", "kind")]),
1047 route("GET", "/workspaces/:workspace/artifact-spaces", Op::Folios(FoliosOp::ListSpaces), &[]),
1048 route("POST", "/workspaces/:workspace/datasets/query", Op::Folios(FoliosOp::QueryDataset), &[]),
1049];
1050
1051impl Route {
1052 /// Whether the route answers success with `204` and no body, as
1053 /// GitHub's address for the same does. MCP still answers `true`.
1054 pub fn no_content(&self) -> bool {
1055 matches!(
1056 self.op,
1057 Op::DeleteComment
1058 )
1059 }
1060
1061 /// The names of the route's path parameters, in order.
1062 pub fn params(&self) -> impl Iterator<Item = &'static str> {
1063 self.path
1064 .split('/')
1065 .filter_map(|segment| segment.strip_prefix(':'))
1066 }
1067
1068 /// The values of the path parameters, if `path` is this route's.
1069 fn matches<'a>(&self, path: &'a str) -> Option<Vec<(&'static str, &'a str)>> {
1070 let mut values = Vec::new();
1071 let mut actual = path.trim_end_matches('/').split('/');
1072 for expected in self.path.split('/') {
1073 let segment = actual.next()?;
1074 match expected.strip_prefix(':') {
1075 Some(name) if !segment.is_empty() => values.push((name, segment)),
1076 Some(_) => return None,
1077 None if expected == segment => {}
1078 None => return None,
1079 }
1080 }
1081 actual.next().is_none().then_some(values)
1082 }
1083}
1084
1085/// A path segment with its `%XX` escapes decoded; as given when that is not
1086/// UTF-8.
1087fn percent_decoded(segment: &str) -> String {
1088 let bytes = segment.as_bytes();
1089 let mut out = Vec::with_capacity(bytes.len());
1090 let mut i = 0;
1091 while i < bytes.len() {
1092 let escaped = (bytes[i] == b'%')
1093 .then(|| segment.get(i + 1..i + 3))
1094 .flatten()
1095 .filter(|hex| hex.bytes().all(|byte| byte.is_ascii_hexdigit()))
1096 .and_then(|hex| u8::from_str_radix(hex, 16).ok());
1097 match escaped {
1098 Some(byte) => {
1099 out.push(byte);
1100 i += 3;
1101 }
1102 None => {
1103 out.push(bytes[i]);
1104 i += 1;
1105 }
1106 }
1107 }
1108 String::from_utf8(out).unwrap_or_else(|_| segment.to_owned())
1109}
1110
1111/// The route for a request, and the operation input it describes.
1112///
1113/// The input is the JSON body, overlaid with the query parameters the route
1114/// reads and then with what the path names: `owner` and `name` become
1115/// `repo`, as does a team's `repo` with its `workspace`, and `number`
1116/// becomes an integer.
1117pub fn resolve(
1118 method: &str,
1119 path: &str,
1120 query: &[(String, String)],
1121 body: Value,
1122) -> Option<(&'static Route, Value)> {
1123 let (route, params) = ROUTES
1124 .iter()
1125 .filter(|route| route.method == method)
1126 .find_map(|route| Some((route, route.matches(path)?)))?;
1127
1128 let mut input = match body {
1129 Value::Object(fields) => fields,
1130 _ => Map::new(),
1131 };
1132 for (name, key) in route.query {
1133 if let Some((_, value)) = query.iter().find(|(query_name, _)| query_name == name) {
1134 input.insert((*key).to_owned(), Value::String(value.clone()));
1135 }
1136 }
1137 let param = |wanted: &str| {
1138 params
1139 .iter()
1140 .find(|(name, _)| *name == wanted)
1141 .map(|(_, value)| *value)
1142 };
1143 if let (Some(owner), Some(name)) = (param("owner"), param("name")) {
1144 input.insert("repo".to_owned(), Value::String(format!("{owner}/{name}")));
1145 }
1146 // Every other name the path gives, under that name; the ones below that
1147 // need more (a repository, a number, an encoded name) are set after.
1148 for (key, value) in &params {
1149 if !matches!(*key, "owner" | "name") {
1150 input.insert((*key).to_owned(), Value::String(percent_decoded(value)));
1151 }
1152 }
1153 // A repository of a team's workspace, named by itself.
1154 if let (Some(workspace), Some(name)) = (param("workspace"), param("repo")) {
1155 input.insert("repo".to_owned(), Value::String(format!("{workspace}/{name}")));
1156 }
1157 // A branch name may hold slashes, sent URL-encoded as one segment, and
1158 // a label's name spaces.
1159 if let Some(branch) = param("branch") {
1160 input.insert("branch".to_owned(), Value::String(percent_decoded(branch)));
1161 }
1162 // An environment's name may hold slashes and spaces, URL-encoded.
1163 if let Some(environment) = param("environment") {
1164 input.insert("environment".to_owned(), Value::String(percent_decoded(environment)));
1165 }
1166 if let Some(label) = param("label") {
1167 input.insert("label".to_owned(), Value::String(percent_decoded(label)));
1168 }
1169 if let Some(milestone) = param("milestone") {
1170 // Not a number: zero, which no milestone has.
1171 input.insert("milestone".to_owned(), milestone.parse::<u32>().unwrap_or(0).into());
1172 }
1173 // GitHub says some things with the path alone.
1174 if route.path.ends_with("/enable") || route.path.ends_with("/disable") {
1175 input.insert("enabled".to_owned(), Value::Bool(route.path.ends_with("/enable")));
1176 }
1177 if route.path.ends_with("/rerun-failed-jobs") {
1178 input.insert("failed_only".to_owned(), Value::Bool(true));
1179 }
1180 if route.path.ends_with("/force-cancel") {
1181 input.insert("force".to_owned(), Value::Bool(true));
1182 }
1183 // Unsaving and waking a thread are a DELETE of what PUT made.
1184 if route.method == "DELETE" && route.path.ends_with("/saved") {
1185 input.insert("saved".to_owned(), Value::Bool(false));
1186 }
1187 if route.method == "DELETE" && route.path.ends_with("/snooze") {
1188 input.remove("until");
1189 }
1190 if let Some(number) = param("number") {
1191 // Not a number: zero, which no issue or pull request has.
1192 input.insert(
1193 "number".to_owned(),
1194 number.parse::<u32>().unwrap_or(0).into(),
1195 );
1196 }
1197 Some((route, Value::Object(input)))
1198}
1199
1200#[cfg(test)]
1201mod tests {
1202 use serde_json::json;
1203
1204 use super::*;
1205
1206 /// Every name a route's path gives reaches the operation: a name left
1207 /// off the lists above is dropped, and the operation answers that it
1208 /// was not given (the project routes were, until this test).
1209 #[test]
1210 fn every_path_parameter_reaches_the_input() {
1211 for route in ROUTES.iter() {
1212 let names: Vec<&str> = route.path.split('/').filter_map(|part| part.strip_prefix(':')).collect();
1213 if names.is_empty() {
1214 continue;
1215 }
1216 let path: String = route
1217 .path
1218 .split('/')
1219 .map(|part| match part.strip_prefix(':') {
1220 Some("number" | "milestone") => "7".to_owned(),
1221 Some(name) => format!("{name}-x"),
1222 None => part.to_owned(),
1223 })
1224 .collect::<Vec<_>>()
1225 .join("/");
1226 let (found, input) = resolve(route.method, &path, &[], json!({})).unwrap();
1227 // A path two routes could take is checked under the first.
1228 if found.path != route.path {
1229 continue;
1230 }
1231 for name in names {
1232 let key = match name {
1233 "owner" | "name" => "repo",
1234 "repo" if names_has_workspace(route.path) => "repo",
1235 other => other,
1236 };
1237 assert!(
1238 input.get(key).is_some_and(|value| !value.is_null()),
1239 "{} {}: :{name} does not reach the input",
1240 route.method,
1241 route.path
1242 );
1243 }
1244 }
1245 }
1246
1247 fn names_has_workspace(path: &str) -> bool {
1248 path.split('/').any(|part| part == ":workspace")
1249 }
1250
1251 #[test]
1252 fn a_path_resolves_to_its_operation_and_input() {
1253 let (route, input) = resolve(
1254 "POST",
1255 "/repos/flagon-io/hello/pulls/14/merge",
1256 &[],
1257 json!({ "keep_issue_open": true, "number": 99, "repo": "someone/else" }),
1258 )
1259 .unwrap();
1260 assert_eq!(route.op, Op::MergePullRequest);
1261 // What the path names wins over the body.
1262 assert_eq!(
1263 input,
1264 json!({ "keep_issue_open": true, "number": 14, "repo": "flagon-io/hello" })
1265 );
1266 }
1267
1268 #[test]
1269 fn a_branch_with_slashes_is_one_encoded_segment() {
1270 let (route, input) = resolve(
1271 "POST",
1272 "/repos/flagon-io/hello/branches/feature%2Flogin/rename",
1273 &[],
1274 json!({ "new_name": "feature/sign-in" }),
1275 )
1276 .unwrap();
1277 assert_eq!(route.op, Op::RenameBranch);
1278 assert_eq!(
1279 input,
1280 json!({ "new_name": "feature/sign-in", "branch": "feature/login", "repo": "flagon-io/hello" })
1281 );
1282 assert_eq!(percent_decoded("100%"), "100%");
1283 assert_eq!(percent_decoded("a%2bb%zz"), "a+b%zz");
1284 }
1285
1286 #[test]
1287 fn a_collaborator_is_named_by_username() {
1288 let (route, input) = resolve(
1289 "PATCH",
1290 "/repos/flagon-io/hello/collaborators/ada",
1291 &[],
1292 json!({ "role": "maintain" }),
1293 )
1294 .unwrap();
1295 assert_eq!(route.op, Op::UpdateCollaborator);
1296 assert_eq!(input, json!({ "role": "maintain", "username": "ada", "repo": "flagon-io/hello" }));
1297 let (route, input) = resolve("DELETE", "/user/repository_invitations/rin_1", &[], Value::Null).unwrap();
1298 assert_eq!(route.op, Op::DeclineRepoInvitation);
1299 assert_eq!(input, json!({ "id": "rin_1" }));
1300 }
1301
1302 #[test]
1303 fn teams_are_addressed_by_workspace_and_slug() {
1304 let query = [("q".to_owned(), "back".to_owned())];
1305 let (route, input) = resolve("GET", "/workspaces/acme/teams", &query, Value::Null).unwrap();
1306 assert_eq!(route.op, Op::ListTeams);
1307 assert_eq!(input, json!({ "query": "back", "workspace": "acme" }));
1308 let (route, input) = resolve("PATCH", "/workspaces/acme/teams/backend", &[], json!({ "name": "Back end" })).unwrap();
1309 assert_eq!(route.op, Op::UpdateTeam);
1310 assert_eq!(input, json!({ "name": "Back end", "workspace": "acme", "team": "backend" }));
1311 let (route, input) =
1312 resolve("PUT", "/workspaces/acme/teams/backend/members/ana", &[], json!({ "role": "maintainer" })).unwrap();
1313 assert_eq!(route.op, Op::SetTeamMember);
1314 assert_eq!(input, json!({ "role": "maintainer", "workspace": "acme", "team": "backend", "username": "ana" }));
1315 let query = [("include_child_teams".to_owned(), "true".to_owned())];
1316 let (route, input) = resolve("GET", "/workspaces/acme/teams/backend/members", &query, Value::Null).unwrap();
1317 assert_eq!(route.op, Op::ListTeamMembers);
1318 assert_eq!(input, json!({ "include_child_teams": "true", "workspace": "acme", "team": "backend" }));
1319 // A repository is named by itself, in the team's workspace.
1320 let (route, input) =
1321 resolve("PUT", "/workspaces/acme/teams/backend/repos/rocket", &[], json!({ "role": "write" })).unwrap();
1322 assert_eq!(route.op, Op::SetTeamRepo);
1323 assert_eq!(input, json!({ "role": "write", "workspace": "acme", "team": "backend", "repo": "acme/rocket" }));
1324 let op = |method: &str, path: &str| resolve(method, path, &[], Value::Null).unwrap().0.op;
1325 assert_eq!(op("DELETE", "/workspaces/acme/teams/backend/repos/rocket"), Op::RemoveTeamRepo);
1326 assert_eq!(op("GET", "/workspaces/acme/teams/backend/teams"), Op::ListChildTeams);
1327 assert_eq!(op("GET", "/workspaces/acme/teams/backend/repos"), Op::ListTeamRepos);
1328 assert_eq!(op("PUT", "/workspaces/acme/teams/backend/review_assignment"), Op::SetTeamReviewAssignment);
1329 assert_eq!(op("DELETE", "/workspaces/acme/teams/backend"), Op::DeleteTeam);
1330 assert_eq!(op("POST", "/workspaces/acme/teams"), Op::CreateTeam);
1331 assert_eq!(op("GET", "/workspaces/acme/teams/backend"), Op::GetTeam);
1332 assert_eq!(op("DELETE", "/workspaces/acme/teams/backend/members/ana"), Op::RemoveTeamMember);
1333 let (route, input) = resolve("GET", "/workspaces/acme/members/ana/teams", &[], Value::Null).unwrap();
1334 assert_eq!(route.op, Op::ListUserTeams);
1335 assert_eq!(input, json!({ "workspace": "acme", "username": "ana" }));
1336 }
1337
1338 #[test]
1339 fn reviewers_are_requested_and_code_owners_checked_on_a_repository() {
1340 let body = json!({ "reviewers": ["ana"], "team_reviewers": ["backend"] });
1341 let (route, input) = resolve("POST", "/repos/acme/rocket/pulls/7/requested_reviewers", &[], body.clone()).unwrap();
1342 assert_eq!(route.op, Op::RequestReviewers);
1343 assert_eq!(
1344 input,
1345 json!({ "reviewers": ["ana"], "team_reviewers": ["backend"], "repo": "acme/rocket", "number": 7 })
1346 );
1347 let (route, _) = resolve("DELETE", "/repos/acme/rocket/pulls/7/requested_reviewers", &[], body).unwrap();
1348 assert_eq!(route.op, Op::RemoveRequestedReviewers);
1349 let query = [("ref".to_owned(), "main".to_owned())];
1350 let (route, input) = resolve("GET", "/repos/acme/rocket/codeowners/errors", &query, Value::Null).unwrap();
1351 assert_eq!(route.op, Op::GetCodeownersErrors);
1352 assert_eq!(input, json!({ "ref": "main", "repo": "acme/rocket" }));
1353 }
1354
1355 #[test]
1356 fn notifications_are_addressed_as_threads_and_by_issue() {
1357 let (route, input) = resolve("DELETE", "/notifications/threads/ntf_1", &[], Value::Null).unwrap();
1358 assert_eq!(route.op, Op::MarkThreadDone);
1359 assert_eq!(input, json!({ "id": "ntf_1" }));
1360 let (route, input) = resolve("DELETE", "/notifications/threads/ntf_1/saved", &[], Value::Null).unwrap();
1361 assert_eq!(route.op, Op::SaveThread);
1362 assert_eq!(input, json!({ "id": "ntf_1", "saved": false }));
1363 let (route, input) = resolve("DELETE", "/notifications/threads/ntf_1/snooze", &[], json!({ "until": "x" })).unwrap();
1364 assert_eq!(route.op, Op::SnoozeThread);
1365 assert_eq!(input, json!({ "id": "ntf_1" }));
1366 let query = [("all".to_owned(), "true".to_owned()), ("per_page".to_owned(), "50".to_owned())];
1367 let (route, input) = resolve("GET", "/repos/acme/rocket/notifications", &query, Value::Null).unwrap();
1368 assert_eq!(route.op, Op::ListNotifications);
1369 assert_eq!(input, json!({ "all": "true", "per_page": "50", "repo": "acme/rocket" }));
1370 let (route, input) = resolve("PUT", "/repos/acme/rocket/issues/7/subscription", &[], json!({ "ignored": true })).unwrap();
1371 assert_eq!(route.op, Op::SetThreadSubscription);
1372 assert_eq!(input, json!({ "ignored": true, "number": 7, "repo": "acme/rocket" }));
1373 assert_eq!(resolve("GET", "/user/subscriptions", &[], Value::Null).unwrap().0.op, Op::ListWatchedRepos);
1374 }
1375
1376 #[test]
1377 fn labels_and_milestones_are_named_in_the_path() {
1378 let (route, input) = resolve("PATCH", "/repos/acme/web/labels/good%20first%20issue", &[], json!({ "color": "7057ff" })).unwrap();
1379 assert_eq!(route.op, Op::UpdateLabel);
1380 assert_eq!(input, json!({ "color": "7057ff", "label": "good first issue", "repo": "acme/web" }));
1381 let (route, input) = resolve("DELETE", "/repos/acme/web/issues/7/labels/bug", &[], Value::Null).unwrap();
1382 assert_eq!(route.op, Op::RemoveIssueLabels);
1383 assert_eq!(input, json!({ "label": "bug", "number": 7, "repo": "acme/web" }));
1384 let (route, input) = resolve("DELETE", "/repos/acme/web/issues/7/labels", &[], Value::Null).unwrap();
1385 assert_eq!(route.op, Op::RemoveIssueLabels);
1386 assert_eq!(input, json!({ "number": 7, "repo": "acme/web" }));
1387 let (route, _) = resolve("POST", "/repos/acme/web/labels/defaults", &[], Value::Null).unwrap();
1388 assert_eq!(route.op, Op::AddDefaultLabels);
1389 let (route, input) = resolve("PATCH", "/repos/acme/web/milestones/3", &[], json!({ "state": "closed" })).unwrap();
1390 assert_eq!(route.op, Op::UpdateMilestone);
1391 assert_eq!(input, json!({ "state": "closed", "milestone": 3, "repo": "acme/web" }));
1392 let (route, input) = resolve("PATCH", "/repos/acme/web/pulls/9", &[], json!({ "base": "release" })).unwrap();
1393 assert_eq!(route.op, Op::UpdatePullRequest);
1394 assert_eq!(input, json!({ "base": "release", "number": 9, "repo": "acme/web" }));
1395 }
1396
1397 #[test]
1398 fn pull_requests_reopen_and_turn_draft_and_comments_are_named_by_id() {
1399 let op = |method: &str, path: &str| resolve(method, path, &[], Value::Null).unwrap().0.op;
1400 assert_eq!(op("POST", "/repos/acme/web/pulls/9/reopen"), Op::ReopenPullRequest);
1401 assert_eq!(op("POST", "/repos/acme/web/pulls/9/draft"), Op::ConvertPullRequestToDraft);
1402 assert_eq!(op("POST", "/repos/acme/web/pulls/9/close"), Op::ClosePullRequest);
1403 // Reopening and closing with a PATCH, as `state`.
1404 let (route, input) = resolve("PATCH", "/repos/acme/web/pulls/9", &[], json!({ "state": "open" })).unwrap();
1405 assert_eq!(route.op, Op::UpdatePullRequest);
1406 assert_eq!(input, json!({ "state": "open", "number": 9, "repo": "acme/web" }));
1407 let (route, input) =
1408 resolve("PATCH", "/repos/acme/web/issues/comments/cmt_1", &[], json!({ "body": "Better" })).unwrap();
1409 assert_eq!(route.op, Op::EditComment);
1410 assert_eq!(input, json!({ "body": "Better", "comment_id": "cmt_1", "repo": "acme/web" }));
1411 let (route, input) = resolve("DELETE", "/repos/acme/web/issues/comments/cmt_1", &[], Value::Null).unwrap();
1412 assert_eq!(route.op, Op::DeleteComment);
1413 assert_eq!(input, json!({ "comment_id": "cmt_1", "repo": "acme/web" }));
1414 // Still an issue's comments, labels and subscription.
1415 assert_eq!(op("POST", "/repos/acme/web/issues/7/comments"), Op::AddComment);
1416 assert_eq!(op("DELETE", "/repos/acme/web/issues/7/labels"), Op::RemoveIssueLabels);
1417 assert_eq!(op("DELETE", "/repos/acme/web/issues/7/subscription"), Op::DeleteThreadSubscription);
1418 }
1419
1420 #[test]
1421 fn observability_is_addressed_by_workspace_and_project() {
1422 let query = [("level".to_owned(), "error,warn".to_owned()), ("q".to_owned(), "timeout".to_owned())];
1423 let (route, input) = resolve("GET", "/workspaces/acme/projects/web/observability/logs", &query, Value::Null).unwrap();
1424 assert_eq!(route.op, Op::Telemetry(TelemetryOp::ListLogs));
1425 assert_eq!(input, json!({ "level": "error,warn", "q": "timeout", "workspace": "acme", "project": "web" }));
1426 let (route, input) =
1427 resolve("GET", "/workspaces/acme/projects/web/observability/metrics/http.server.request.duration", &[], Value::Null).unwrap();
1428 assert_eq!(route.op, Op::Telemetry(TelemetryOp::GetMetric));
1429 assert_eq!(input["metric"], json!("http.server.request.duration"));
1430 let (route, input) =
1431 resolve("PATCH", "/workspaces/acme/projects/web/observability/errors/f00d", &[], json!({ "state": "resolved" })).unwrap();
1432 assert_eq!(route.op, Op::Telemetry(TelemetryOp::UpdateError));
1433 assert_eq!(input, json!({ "state": "resolved", "workspace": "acme", "project": "web", "fingerprint": "f00d" }));
1434 }
1435
1436 #[test]
1437 fn billing_is_addressed_by_workspace() {
1438 let query = [("from".to_owned(), "2026-10-01".to_owned()), ("products".to_owned(), "agent,sandboxes".to_owned())];
1439 let (route, input) = resolve("GET", "/workspaces/acme/usage", &query, Value::Null).unwrap();
1440 assert_eq!(route.op, Op::GetUsage);
1441 assert_eq!(input, json!({ "from": "2026-10-01", "products": "agent,sandboxes", "workspace": "acme" }));
1442 let (route, input) = resolve("PUT", "/workspaces/acme/budget", &[], json!({ "alerts": [50] })).unwrap();
1443 assert_eq!(route.op, Op::SetBudget);
1444 assert_eq!(input, json!({ "alerts": [50], "workspace": "acme" }));
1445 let op = |method: &str, path: &str| resolve(method, path, &[], Value::Null).unwrap().0.op;
1446 assert_eq!(op("GET", "/workspaces/acme/budget"), Op::GetBudget);
1447 assert_eq!(op("GET", "/workspaces/acme/ai_credit"), Op::GetAiCredit);
1448 assert_eq!(op("POST", "/workspaces/acme/ai_credit/checkout"), Op::BuyAiCredit);
1449 assert_eq!(op("GET", "/workspaces/acme/invoices"), Op::ListInvoices);
1450 assert_eq!(op("GET", "/workspaces/acme/billing_details"), Op::GetBillingDetails);
1451 }
1452
1453 #[test]
1454 fn checks_are_at_githubs_addresses() {
1455 let sha = "a".repeat(40);
1456 let body = json!({ "state": "success", "context": "ci/build" });
1457 let (route, input) = resolve("POST", &format!("/repos/acme/web/statuses/{sha}"), &[], body).unwrap();
1458 assert_eq!(route.op, Op::Checks(ChecksOp::CreateCommitStatus));
1459 assert_eq!(input, json!({ "state": "success", "context": "ci/build", "sha": sha, "repo": "acme/web" }));
1460 let (route, input) = resolve("GET", "/repos/acme/web/commits/release%2F1.x/status", &[], Value::Null).unwrap();
1461 assert_eq!(route.op, Op::Checks(ChecksOp::GetCombinedStatus));
1462 assert_eq!(input, json!({ "ref": "release/1.x", "repo": "acme/web" }));
1463 let query = [("check_name".to_owned(), "lint".to_owned())];
1464 let (route, input) = resolve("GET", "/repos/acme/web/commits/main/check-runs", &query, Value::Null).unwrap();
1465 assert_eq!(route.op, Op::Checks(ChecksOp::ListCheckRunsForRef));
1466 assert_eq!(input, json!({ "check_name": "lint", "ref": "main", "repo": "acme/web" }));
1467 let (route, input) = resolve("PATCH", "/repos/acme/web/check-runs/cr_1", &[], json!({ "conclusion": "success" })).unwrap();
1468 assert_eq!(route.op, Op::Checks(ChecksOp::UpdateCheckRun));
1469 assert_eq!(input, json!({ "conclusion": "success", "id": "cr_1", "repo": "acme/web" }));
1470 let op = |method: &str, path: &str| resolve(method, path, &[], Value::Null).unwrap().0.op;
1471 assert_eq!(op("POST", "/repos/acme/web/check-runs"), Op::Checks(ChecksOp::CreateCheckRun));
1472 assert_eq!(op("GET", "/repos/acme/web/check-runs/cr_1/annotations"), Op::Checks(ChecksOp::ListCheckRunAnnotations));
1473 assert_eq!(op("POST", "/repos/acme/web/check-suites/cs_1/rerequest"), Op::Checks(ChecksOp::RerequestCheckSuite));
1474 assert_eq!(op("GET", "/repos/acme/web/commits/main/check-suites"), Op::Checks(ChecksOp::ListCheckSuitesForRef));
1475 }
1476
1477 #[test]
1478 fn archives_are_at_githubs_addresses_and_redirect() {
1479 let sha = "4807077b296e6edbf410d55e72749d3e1170c291";
1480 let (route, input) = resolve("GET", &format!("/repos/acme/web/tarball/{sha}"), &[], Value::Null).unwrap();
1481 assert_eq!(route.op, Op::Archives(ArchiveOp::DownloadTarball));
1482 assert_eq!(input, json!({ "ref": sha, "repo": "acme/web" }));
1483 // A branch with slashes, URL-encoded as octokit sends it.
1484 let (route, input) = resolve("GET", "/repos/acme/web/zipball/release%2F1.x", &[], Value::Null).unwrap();
1485 assert_eq!(route.op, Op::Archives(ArchiveOp::DownloadZipball));
1486 assert_eq!(input, json!({ "ref": "release/1.x", "repo": "acme/web" }));
1487 // Both answer with a redirect to their link, as the artifact download does.
1488 assert!(route.op.redirects());
1489 assert!(Op::Archives(ArchiveOp::DownloadTarball).redirects());
1490 assert!(Op::Artifacts(ArtifactsOp::DownloadArtifact).redirects());
1491 assert!(!Op::GetRepo.redirects());
1492 // Anyone may ask for a public repository's.
1493 assert!(!route.op.needs_user());
1494 }
1495
1496 #[test]
1497 fn query_parameters_are_renamed() {
1498 let query = [
1499 ("q".to_owned(), "parser".to_owned()),
1500 ("x".to_owned(), "y".to_owned()),
1501 ];
1502 let (route, input) = resolve("GET", "/repos", &query, Value::Null).unwrap();
1503 assert_eq!(route.op, Op::ListRepos);
1504 assert_eq!(input, json!({ "query": "parser" }));
1505 }
1506
1507 #[test]
1508 fn method_and_shape_must_match() {
1509 assert!(resolve("GET", "/repos/a/b/issues/1/close", &[], Value::Null).is_none());
1510 assert!(resolve("GET", "/repos/a", &[], Value::Null).is_none());
1511 assert!(resolve("GET", "/repos/a/b/issues/1/extra", &[], Value::Null).is_none());
1512 assert!(resolve("GET", "/repos/a/b/", &[], Value::Null).is_some());
1513 }
1514
1515 #[test]
1516 fn every_parameter_and_query_name_is_an_input() {
1517 for route in ROUTES {
1518 let properties = route.op.properties();
1519 for (_, key) in route.query {
1520 assert!(properties.contains_key(*key), "{}: {key}", route.path);
1521 }
1522 for name in route.params() {
1523 let covered = matches!(name, "owner" | "name") && properties.contains_key("repo")
1524 || properties.contains_key(name);
1525 assert!(covered, "{}: {name}", route.path);
1526 }
1527 }
1528 }
1529
1530 #[test]
1531 fn every_operation_has_a_route() {
1532 for op in Op::ALL {
1533 assert!(ROUTES.iter().any(|route| route.op == op), "{}", op.name());
1534 }
1535 }
1536}