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.

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