Skip to content
Sign in

flagon-io/g1t

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