Skip to content
Sign up

flagon-io/g1t

public
00

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

g1t.sh
gitagentscloudflarerustforgemcp
1,387 linesCodeBlameRaw
1//! The OpenAPI document, generated from the same list the routes are.
2//!
3//! The docs site builds its API reference from a copy of this document,
4//! `apps/docs/src/data/openapi.json`. A test keeps the copy current: run
5//! `G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi` to rewrite it.
6
7use g1t_contracts::scopes::scope_for;
8use serde_json::{Map, Value, json};
9
10use crate::about::AboutOp;
11use crate::run_artifacts::ArtifactsOp;
12use crate::archives::ArchiveOp;
13use crate::deploy_keys::DeployKeysOp;
14use crate::deployments::DeploymentsOp;
15use crate::telemetry::TelemetryOp;
16use crate::packages::PackagesOp;
17use crate::folios::FoliosOp;
18use crate::coordination::CoordinationOp;
19use crate::protection::ProtectionOp;
20use crate::token_policy::TokenOp;
21use crate::operations::Op;
22use crate::checks::ChecksOp;
23use crate::rules::RulesOp;
24use crate::security::SecurityOp;
25use crate::rest::{ROUTES, Route};
26
27/// The sections of the API reference: a name, what it covers, and its
28/// operations in the order a reader meets them.
29const SECTIONS: &[(&str, &str, &[Op])] = &[
30 (
31 "Accounts",
32 "Signing in from a tool, who a token acts as, and your email addresses.",
33 &[Op::Whoami, Op::ListEmails, Op::AddEmail, Op::ConfirmEmail, Op::RemoveEmail, Op::UpdateEmailSettings],
34 ),
35 (
36 "Notifications",
37 "Your inbox: a thread for each thing you were told about (an issue, a pull request, a workflow on a branch, a deployment), why you were told, and what you subscribe to and watch. Your own: personal tokens and sessions only.",
38 &[
39 Op::ListNotifications,
40 Op::MarkNotificationsRead,
41 Op::GetNotificationThread,
42 Op::MarkThreadRead,
43 Op::MarkThreadDone,
44 Op::SaveThread,
45 Op::SnoozeThread,
46 Op::GetThreadSubscription,
47 Op::SetThreadSubscription,
48 Op::DeleteThreadSubscription,
49 Op::GetRepoSubscription,
50 Op::SetRepoSubscription,
51 Op::DeleteRepoSubscription,
52 Op::ListWatchedRepos,
53 ],
54 ),
55 (
56 "Pinned projects",
57 "The projects you keep at the top of a workspace's sidebar, in your order, up to eight a workspace. Your own: personal tokens and sessions only.",
58 &[Op::ListPinnedProjects, Op::PinProject, Op::UnpinProject, Op::ReorderPinnedProjects],
59 ),
60 (
61 "Projects",
62 "A project is what a workspace builds and runs, from a repository or a root directory in one. Each says what it is, where it runs and where to find it: its homepage, docs and other links.",
63 &[Op::ListProjects, Op::GetProject, Op::UpdateProject],
64 ),
65 (
66 "Workspaces",
67 "A workspace owns repositories and is the first part of their address. People and agents work in workspaces.",
68 &[Op::GetWorkspace, Op::CreateWorkspace, Op::UpdateWorkspace, Op::DeleteWorkspace],
69 ),
70 (
71 "Personal access tokens",
72 "A workspace's rules for its members' personal access tokens: whether tokens made for all of a member's workspaces reach it, whether tokens may be made for it alone and wait for an owner's approval, and how long a token may last; the tokens that reach it, approving or denying the ones that wait, and revoking one there. Owners only, as people.",
73 &[
74 Op::Tokens(TokenOp::GetTokenPolicy),
75 Op::Tokens(TokenOp::SetTokenPolicy),
76 Op::Tokens(TokenOp::ListMemberTokens),
77 Op::Tokens(TokenOp::ListTokenRequests),
78 Op::Tokens(TokenOp::ReviewTokenRequest),
79 Op::Tokens(TokenOp::RevokeMemberToken),
80 ],
81 ),
82 (
83 "Members",
84 "A workspace's members and owners: who belongs to it, their roles (owner or member, with billing manager and security manager on top), handing it to another member, and leaving it.",
85 &[Op::ListMembers, Op::UpdateMember, Op::RemoveMember, Op::TransferOwnership, Op::LeaveWorkspace],
86 ),
87 (
88 "Invites",
89 "Inviting people into a workspace by username or email, and answering the invitations to workspaces sent to you.",
90 &[
91 Op::ListWorkspaceInvites,
92 Op::InviteMember,
93 Op::RevokeWorkspaceInvite,
94 Op::ListInvitations,
95 Op::AcceptInvitation,
96 Op::DeclineInvitation,
97 ],
98 ),
99 (
100 "Billing",
101 "A workspace's usage, its budget and its invoices. Members read them; owners change the budget, as people. A run's token never changes billing.",
102 &[
103 Op::GetUsage,
104 Op::GetBudget,
105 Op::SetBudget,
106 Op::ListInvoices,
107 Op::GetBillingDetails,
108 ],
109 ),
110 (
111 "Repositories",
112 "A repository, how it handles pull requests, and its timeline: renaming, archiving, moving and deleting it; and its files at a branch, tag or commit as a tarball or zipball.",
113 &[
114 Op::ListRepos,
115 Op::CreateRepo,
116 Op::GetRepo,
117 Op::Archives(ArchiveOp::DownloadTarball),
118 Op::Archives(ArchiveOp::DownloadZipball),
119 Op::UpdateRepo,
120 Op::RenameRepo,
121 Op::RenameBranch,
122 Op::CreateBranch,
123 Op::DeleteBranch,
124 Op::SetRepoVisibility,
125 Op::ArchiveRepo,
126 Op::UnarchiveRepo,
127 Op::TransferRepo,
128 Op::DeleteRepo,
129 Op::ListDeletedRepos,
130 Op::RestoreRepo,
131 Op::PurgeRepo,
132 Op::GetRepoSettings,
133 Op::UpdateRepoSettings,
134 Op::ListCheckNames,
135 Op::GetCodeownersErrors,
136 Op::ListEvents,
137 ],
138 ),
139 (
140 "Repository insights",
141 "What a repository's default branch says about it, read in the background and kept by commit: the languages it is written in, who made it, and its license.",
142 &[Op::About(AboutOp::GetLanguages), Op::About(AboutOp::ListContributors), Op::About(AboutOp::GetLicense)],
143 ),
144 (
145 "Stars",
146 "Starring a repository, to keep it and to say you like it: who starred one, and what you starred.",
147 &[
148 Op::About(AboutOp::ListStargazers),
149 Op::About(AboutOp::ListStarred),
150 Op::About(AboutOp::CheckStarred),
151 Op::About(AboutOp::Star),
152 Op::About(AboutOp::Unstar),
153 ],
154 ),
155 (
156 "Releases",
157 "A release is a tag published with a title and notes. The latest is the newest published one that is neither a draft nor a prerelease.",
158 &[
159 Op::About(AboutOp::ListReleases),
160 Op::About(AboutOp::CreateRelease),
161 Op::About(AboutOp::GetLatestRelease),
162 Op::About(AboutOp::GetReleaseByTag),
163 Op::About(AboutOp::GetRelease),
164 Op::About(AboutOp::UpdateRelease),
165 Op::About(AboutOp::DeleteRelease),
166 ],
167 ),
168 (
169 "Access",
170 "Who can do what in a repository: repository roles, people given a role on one repository (outside collaborators when they are not members), invitations, a workspace's base permission, and deploy keys: SSH keys that reach one repository.",
171 &[
172 Op::ListCollaborators,
173 Op::AddCollaborator,
174 Op::UpdateCollaborator,
175 Op::RemoveCollaborator,
176 Op::GetCollaboratorPermission,
177 Op::ListRepoInvitations,
178 Op::RevokeRepoInvitation,
179 Op::ListMyRepoInvitations,
180 Op::AcceptRepoInvitation,
181 Op::DeclineRepoInvitation,
182 Op::SetBasePermission,
183 Op::ListOutsideCollaborators,
184 Op::DeployKeys(DeployKeysOp::ListDeployKeys),
185 Op::DeployKeys(DeployKeysOp::GetDeployKey),
186 Op::DeployKeys(DeployKeysOp::CreateDeployKey),
187 Op::DeployKeys(DeployKeysOp::DeleteDeployKey),
188 ],
189 ),
190 (
191 "Teams",
192 "Groups of a workspace's members: given a role on repositories together, mentioned together as @workspace/team, and asked to review together. Any member may create a team; the workspace's owners and the team's maintainers manage it.",
193 &[
194 Op::ListTeams,
195 Op::CreateTeam,
196 Op::GetTeam,
197 Op::UpdateTeam,
198 Op::DeleteTeam,
199 Op::ListTeamMembers,
200 Op::SetTeamMember,
201 Op::RemoveTeamMember,
202 Op::ListChildTeams,
203 Op::ListTeamRepos,
204 Op::SetTeamRepo,
205 Op::RemoveTeamRepo,
206 Op::SetTeamReviewAssignment,
207 Op::ListUserTeams,
208 ],
209 ),
210 (
211 "Security",
212 "Secrets found in what is pushed and in a repository's history, and dependencies with known vulnerabilities: listing the alerts, and dismissing or reopening them.",
213 &[Op::ListSecurityAlerts, Op::DismissSecurityAlert, Op::ReopenSecurityAlert],
214 ),
215 (
216 "Secret scanning",
217 "Secrets found in pushes and history, where each one is, pushing past push protection with a reason (and asking for approval when the workspace delegates bypasses), checking with a secret's issuer whether it still works, and custom patterns.",
218 &[
219 Op::Security(SecurityOp::ListSecretAlerts),
220 Op::Security(SecurityOp::GetSecretAlert),
221 Op::Security(SecurityOp::UpdateSecretAlert),
222 Op::Security(SecurityOp::ListSecretLocations),
223 Op::Security(SecurityOp::BypassPushProtection),
224 Op::Security(SecurityOp::CheckSecretValidity),
225 Op::Security(SecurityOp::ListBypassRequests),
226 Op::Security(SecurityOp::ReviewBypassRequest),
227 Op::Security(SecurityOp::ListCustomPatterns),
228 Op::Security(SecurityOp::CreateCustomPattern),
229 Op::Security(SecurityOp::UpdateCustomPattern),
230 Op::Security(SecurityOp::DeleteCustomPattern),
231 Op::Security(SecurityOp::DryRunCustomPattern),
232 ],
233 ),
234 (
235 "Code scanning",
236 "Results of static analysis tools, uploaded as SARIF: alerts on the default branch, the analyses that made them, uploads, and putting g1t on an alert to fix it.",
237 &[
238 Op::Security(SecurityOp::ListCodeAlerts),
239 Op::Security(SecurityOp::GetCodeAlert),
240 Op::Security(SecurityOp::UpdateCodeAlert),
241 Op::Security(SecurityOp::ListAnalyses),
242 Op::Security(SecurityOp::UploadSarif),
243 Op::Security(SecurityOp::GetSarifUpload),
244 ],
245 ),
246 (
247 "Supply chain",
248 "What a repository depends on: vulnerability alerts, the dependency graph, an SPDX SBOM of it, and comparing two commits' dependencies as dependency review does.",
249 &[
250 Op::Security(SecurityOp::ListVulnerabilityAlerts),
251 Op::Security(SecurityOp::GetVulnerabilityAlert),
252 Op::Security(SecurityOp::UpdateVulnerabilityAlert),
253 Op::Security(SecurityOp::GetDependencyGraph),
254 Op::Security(SecurityOp::GetSbom),
255 Op::Security(SecurityOp::CompareDependencies),
256 ],
257 ),
258 (
259 "Security settings",
260 "When pull request checks fail, dependency review's policy, delegated bypass and validity checks, and a workspace's security overview.",
261 &[
262 Op::Security(SecurityOp::GetSettings),
263 Op::Security(SecurityOp::UpdateSettings),
264 Op::Security(SecurityOp::GetWorkspaceSettings),
265 Op::Security(SecurityOp::UpdateWorkspaceSettings),
266 Op::Security(SecurityOp::GetOverview),
267 ],
268 ),
269 (
270 "Security advisories",
271 "What a repository says about vulnerabilities in what it ships: advisories drafted, published and withdrawn by its maintainers, and the vulnerability reports people send them privately when the repository takes them.",
272 &[
273 Op::Security(SecurityOp::ListAdvisories),
274 Op::Security(SecurityOp::CreateAdvisory),
275 Op::Security(SecurityOp::GetAdvisory),
276 Op::Security(SecurityOp::UpdateAdvisory),
277 Op::Security(SecurityOp::SetAdvisoryState),
278 Op::Security(SecurityOp::ListReports),
279 Op::Security(SecurityOp::ReportVulnerability),
280 Op::Security(SecurityOp::ReviewReport),
281 ],
282 ),
283 (
284 "Rules",
285 "Rulesets: what may happen to a repository's branches and tags and what a pull request needs before it merges, for a repository or across a workspace; the rules that hold for one branch; and how they judged each push and merge, with insights.",
286 &[
287 Op::Rules(RulesOp::ListRepoRulesets),
288 Op::Rules(RulesOp::CreateRepoRuleset),
289 Op::Rules(RulesOp::GetRepoRuleset),
290 Op::Rules(RulesOp::UpdateRepoRuleset),
291 Op::Rules(RulesOp::DeleteRepoRuleset),
292 Op::Rules(RulesOp::GetBranchRules),
293 Op::Rules(RulesOp::ListRuleEvaluations),
294 Op::Rules(RulesOp::ListWorkspaceRulesets),
295 Op::Rules(RulesOp::CreateWorkspaceRuleset),
296 Op::Rules(RulesOp::GetWorkspaceRuleset),
297 Op::Rules(RulesOp::UpdateWorkspaceRuleset),
298 Op::Rules(RulesOp::DeleteWorkspaceRuleset),
299 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
300 ],
301 ),
302 (
303 "Checks",
304 "What CI, integrations and g1t Actions say about a commit, in the shapes CI tools already send: statuses (a state per context) and check runs (a lifecycle, a conclusion, a Markdown report, annotations on lines and buttons), grouped per reporter into check suites. g1t Actions jobs are check runs too. Required checks are met by either.",
305 &[
306 Op::Checks(ChecksOp::CreateCommitStatus),
307 Op::Checks(ChecksOp::ListCommitStatuses),
308 Op::Checks(ChecksOp::GetCombinedStatus),
309 Op::Checks(ChecksOp::CreateCheckRun),
310 Op::Checks(ChecksOp::UpdateCheckRun),
311 Op::Checks(ChecksOp::GetCheckRun),
312 Op::Checks(ChecksOp::ListCheckRunAnnotations),
313 Op::Checks(ChecksOp::RerequestCheckRun),
314 Op::Checks(ChecksOp::ListCheckRunsForRef),
315 Op::Checks(ChecksOp::ListCheckSuitesForRef),
316 Op::Checks(ChecksOp::GetCheckSuite),
317 Op::Checks(ChecksOp::RerequestCheckSuite),
318 ],
319 ),
320 (
321 "Issues",
322 "What should change in a repository, with labels and comments. Issues and pull requests share one sequence of numbers.",
323 &[
324 Op::ListIssues,
325 Op::CreateIssue,
326 Op::GetIssue,
327 Op::UpdateIssue,
328 Op::CloseIssue,
329 Op::ReopenIssue,
330 Op::AddComment,
331 Op::EditComment,
332 Op::DeleteComment,
333 Op::ListIssueLabels,
334 Op::AddIssueLabels,
335 Op::SetIssueLabels,
336 Op::RemoveIssueLabels,
337 ],
338 ),
339 (
340 "Claims and work",
341 "Coordinating work on issues: an advisory, expiring claim that says you are on one (never a lock), handing it off with a note, and everything an agent needs before starting on an issue in one call. What an issue is blocked by is set with update_issue.",
342 &[
343 Op::Coordination(CoordinationOp::GetWork),
344 Op::Coordination(CoordinationOp::ClaimIssue),
345 Op::Coordination(CoordinationOp::ReleaseClaim),
346 Op::Coordination(CoordinationOp::HandOffIssue),
347 Op::Coordination(CoordinationOp::ListClaims),
348 ],
349 ),
350 (
351 "Labels and milestones",
352 "A repository's labels, which issues and pull requests carry by name, and its milestones, which gather them under a goal and a due date.",
353 &[
354 Op::ListLabels,
355 Op::CreateLabel,
356 Op::UpdateLabel,
357 Op::DeleteLabel,
358 Op::AddDefaultLabels,
359 Op::ListMilestones,
360 Op::CreateMilestone,
361 Op::GetMilestone,
362 Op::UpdateMilestone,
363 Op::DeleteMilestone,
364 ],
365 ),
366 (
367 "Pull requests",
368 "A proposed change in its own fork or on a branch. Several can be made for one issue; the one merged resolves it.",
369 &[
370 Op::ListPullRequests,
371 Op::CreatePullRequest,
372 Op::GetPullRequest,
373 Op::UpdatePullRequest,
374 Op::GetPullRequestChanges,
375 Op::MarkPullRequestReady,
376 Op::ConvertPullRequestToDraft,
377 Op::RequestReviewers,
378 Op::RemoveRequestedReviewers,
379 Op::ReviewPullRequest,
380 Op::MergePullRequest,
381 Op::ClosePullRequest,
382 Op::ReopenPullRequest,
383 Op::GetMergeQueue,
384 ],
385 ),
386 (
387 "Sessions",
388 "Who is working on what, and how a pull request was made. A session is one run of your own harness (a Claude Code session, a Codex run) on a repository: started once, kept alive by heartbeats, attached to an issue and a pull request, and recording prompts, reasoning and the tools that ran. A pull request's session shows what was recorded on it.",
389 &[
390 Op::Coordination(CoordinationOp::StartSession),
391 Op::Coordination(CoordinationOp::UpdateSession),
392 Op::Coordination(CoordinationOp::EndSession),
393 Op::Coordination(CoordinationOp::GetSession),
394 Op::Coordination(CoordinationOp::ListSessions),
395 Op::Coordination(CoordinationOp::RecordSessionEntries),
396 Op::ReadSession,
397 Op::RecordSession,
398 ],
399 ),
400 (
401 "Decisions and why",
402 "Decision records: why the work is the way it is, and how sure that is (claimed, tested by a check or the merge queue, or approved by a person). And why a line of code is the way it is: its commit, pull request, issue, decisions and session.",
403 &[Op::ListDecisions, Op::RecordDecision, Op::Why],
404 ),
405 (
406 "Memory",
407 "What agents and people learned that the next agent should know, for one project or across a workspace. Members only; never a secret.",
408 &[Op::Remember, Op::Recall],
409 ),
410 (
411 "Search",
412 "One search across all of g1t: repositories, code, issues, pull requests, people and workspaces. Public content for everyone, and private content in workspaces you belong to.",
413 &[Op::Search],
414 ),
415 (
416 "Actions",
417 "GitHub Actions workflows in .g1t/workflows, their runs, and their jobs' logs.",
418 &[
419 Op::ListWorkflows,
420 Op::ListWorkflowRuns,
421 Op::GetWorkflowRun,
422 Op::GetJobLogs,
423 Op::DispatchWorkflow,
424 Op::CancelWorkflowRun,
425 Op::RerunWorkflowRun,
426 Op::UpdateWorkflow,
427 Op::Artifacts(ArtifactsOp::ListArtifacts),
428 Op::Artifacts(ArtifactsOp::ListRunArtifacts),
429 Op::Artifacts(ArtifactsOp::GetArtifact),
430 Op::Artifacts(ArtifactsOp::DownloadArtifact),
431 Op::Artifacts(ArtifactsOp::DeleteArtifact),
432 Op::Artifacts(ArtifactsOp::GetArtifactRetention),
433 Op::Artifacts(ArtifactsOp::SetArtifactRetention),
434 ],
435 ),
436 (
437 "Packages",
438 "A workspace's packages in every registry: their versions and download counts, deleting and restoring them within 30 days, their visibility and repository, the people and teams with a role on them, and which repositories' workflows may use them (Manage Actions access). A package is named by its type and its name, URL-encoded where it holds a slash.",
439 &[
440 Op::Packages(PackagesOp::ListPackages),
441 Op::Packages(PackagesOp::GetPackage),
442 Op::Packages(PackagesOp::UpdatePackage),
443 Op::Packages(PackagesOp::DeletePackage),
444 Op::Packages(PackagesOp::RestorePackage),
445 Op::Packages(PackagesOp::ListVersions),
446 Op::Packages(PackagesOp::GetVersion),
447 Op::Packages(PackagesOp::DeleteVersion),
448 Op::Packages(PackagesOp::RestoreVersion),
449 Op::Packages(PackagesOp::LinkPackage),
450 Op::Packages(PackagesOp::UnlinkPackage),
451 Op::Packages(PackagesOp::ListAccess),
452 Op::Packages(PackagesOp::SetAccess),
453 Op::Packages(PackagesOp::RemoveAccess),
454 Op::Packages(PackagesOp::ListActionsAccess),
455 Op::Packages(PackagesOp::SetActionsAccess),
456 Op::Packages(PackagesOp::RemoveActionsAccess),
457 ],
458 ),
459 (
460 "Deployments",
461 "A repository's deployments wherever they run: reported from any CI with these routes, made by g1t Actions jobs with an `environment:`, or built on g1t.page. Each has statuses, shows on its commit as the check `deploy / <environment>`, and belongs to an environment.",
462 &[
463 Op::Deployments(DeploymentsOp::ListDeployments),
464 Op::Deployments(DeploymentsOp::CreateDeployment),
465 Op::Deployments(DeploymentsOp::GetDeployment),
466 Op::Deployments(DeploymentsOp::ListDeploymentStatuses),
467 Op::Deployments(DeploymentsOp::CreateDeploymentStatus),
468 Op::Deployments(DeploymentsOp::ListEnvironments),
469 Op::Deployments(DeploymentsOp::GetEnvironment),
470 Op::Deployments(DeploymentsOp::StartDeploymentBuild),
471 ],
472 ),
473 (
474 "Observability",
475 "What a project's running software did: its requests, logs, traces, grouped errors and metrics, from its apps on g1t.page with nothing to set up and from OpenTelemetry (OTLP over HTTP) sent from anywhere with an ingest token. Reading needs a role of your own on the project's repository; resolving errors, Triage; settings, ingest tokens, exports and usage, Admin.",
476 &[
477 Op::Telemetry(TelemetryOp::GetOverview),
478 Op::Telemetry(TelemetryOp::ListRequests),
479 Op::Telemetry(TelemetryOp::GetRequest),
480 Op::Telemetry(TelemetryOp::ListLogs),
481 Op::Telemetry(TelemetryOp::ListTraces),
482 Op::Telemetry(TelemetryOp::GetTrace),
483 Op::Telemetry(TelemetryOp::ListErrors),
484 Op::Telemetry(TelemetryOp::UpdateError),
485 Op::Telemetry(TelemetryOp::ListMetrics),
486 Op::Telemetry(TelemetryOp::GetMetric),
487 Op::Telemetry(TelemetryOp::GetSettings),
488 Op::Telemetry(TelemetryOp::UpdateSettings),
489 Op::Telemetry(TelemetryOp::ListTokens),
490 Op::Telemetry(TelemetryOp::CreateToken),
491 Op::Telemetry(TelemetryOp::DeleteToken),
492 Op::Telemetry(TelemetryOp::ListExports),
493 Op::Telemetry(TelemetryOp::CreateExport),
494 Op::Telemetry(TelemetryOp::UpdateExport),
495 Op::Telemetry(TelemetryOp::DeleteExport),
496 Op::Telemetry(TelemetryOp::GetUsage),
497 ],
498 ),
499 (
500 "Run protection",
501 "What keeps workflow runs safe: environments' protection rules (required reviewers, a wait timer, which branches may deploy) and the reviews of the jobs they hold, approving a pull request's run from outside, what a job's token gets when its workflow writes no `permissions:`, and repository_dispatch, which a job's own token may send.",
502 &[
503 Op::Protection(ProtectionOp::UpdateEnvironment),
504 Op::Protection(ProtectionOp::DeleteEnvironment),
505 Op::Protection(ProtectionOp::GetPendingDeployments),
506 Op::Protection(ProtectionOp::ReviewPendingDeployments),
507 Op::Protection(ProtectionOp::ApproveWorkflowRun),
508 Op::Protection(ProtectionOp::GetWorkflowPermissions),
509 Op::Protection(ProtectionOp::SetWorkflowPermissions),
510 Op::Protection(ProtectionOp::GetForkPrApproval),
511 Op::Protection(ProtectionOp::SetForkPrApproval),
512 Op::Protection(ProtectionOp::GetActionsAccess),
513 Op::Protection(ProtectionOp::SetActionsAccess),
514 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
515 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
516 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
517 Op::Protection(ProtectionOp::ListWorkspaceManagedWorkflows),
518 Op::Protection(ProtectionOp::CreateWorkspaceManagedWorkflow),
519 Op::Protection(ProtectionOp::UpdateWorkspaceManagedWorkflow),
520 Op::Protection(ProtectionOp::DeleteWorkspaceManagedWorkflow),
521 ],
522 ),
523 (
524 "Secrets and variables",
525 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
526 &[
527 Op::ListActionsSecrets,
528 Op::SetActionsSecret,
529 Op::DeleteActionsSecret,
530 Op::ListActionsVariables,
531 Op::SetActionsVariable,
532 Op::DeleteActionsVariable,
533 ],
534 ),
535 (
536 "Runners",
537 "Self-hosted runners: your own machines, which run your workflow jobs for $0 of g1t compute. They register with a short-lived token and only ever connect out.",
538 &[
539 Op::ListRunners,
540 Op::CreateRunnerRegistrationToken,
541 Op::RemoveRunner,
542 Op::ListRunnerGroups,
543 Op::CreateRunnerGroup,
544 Op::UpdateRunnerGroup,
545 Op::DeleteRunnerGroup,
546 Op::GetRunnerSettings,
547 Op::UpdateRunnerSettings,
548 ],
549 ),
550 (
551 "Webhooks",
552 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
553 &[
554 Op::ListWebhooks,
555 Op::CreateWebhook,
556 Op::UpdateWebhook,
557 Op::DeleteWebhook,
558 Op::PingWebhook,
559 Op::ListWebhookDeliveries,
560 Op::RedeliverWebhook,
561 ],
562 ),
563 (
564 "Integrations",
565 "A workspace's connections to outside systems: AI providers, alert sources and issue trackers.",
566 &[
567 Op::ListIntegrations,
568 Op::ConnectIntegration,
569 Op::UpdateIntegration,
570 Op::DisconnectIntegration,
571 Op::TestIntegration,
572 Op::GetContext,
573 Op::ImportIssue,
574 ],
575 ),
576 (
577 "Artifacts",
578 "A workspace's docs, slides, designs and dashboards (Artifacts mode): listing and searching the ones you can open, reading and editing their content in Markdown, making, moving, trashing and restoring them, their versions, and who can open them. Each answers for your own role on it. Not workflow runs' artifacts, which are under Actions. Slides, designs and dashboards answer that they are not here yet.",
579 &[
580 Op::Folios(FoliosOp::List),
581 Op::Folios(FoliosOp::Search),
582 Op::Folios(FoliosOp::Get),
583 Op::Folios(FoliosOp::GetContent),
584 Op::Folios(FoliosOp::ListVersions),
585 Op::Folios(FoliosOp::GetAccess),
586 Op::Folios(FoliosOp::ListTemplates),
587 Op::Folios(FoliosOp::ListSpaces),
588 Op::Folios(FoliosOp::QueryDataset),
589 Op::Folios(FoliosOp::Create),
590 Op::Folios(FoliosOp::Update),
591 Op::Folios(FoliosOp::Edit),
592 Op::Folios(FoliosOp::Trash),
593 Op::Folios(FoliosOp::Restore),
594 Op::Folios(FoliosOp::RestoreVersion),
595 Op::Folios(FoliosOp::SetAccess),
596 Op::Folios(FoliosOp::Purge),
597 ],
598 ),
599];
600
601/// The section of the API reference an operation is listed under.
602fn tag(op: Op) -> &'static str {
603 SECTIONS
604 .iter()
605 .find(|(_, _, ops)| ops.contains(&op))
606 .map_or("Repositories", |(name, _, _)| name)
607}
608
609/// What an operation's page is called, as a short sentence.
610fn title(op: Op) -> &'static str {
611 match op {
612 Op::Whoami => "Get the current user",
613 Op::GetWorkspace => "Get a workspace",
614 Op::CreateWorkspace => "Create a workspace",
615 Op::DeleteWorkspace => "Delete a workspace",
616 Op::UpdateWorkspace => "Update a workspace",
617 Op::ListMembers => "List a workspace's members",
618 Op::UpdateMember => "Change a member's role",
619 Op::RemoveMember => "Remove a member",
620 Op::TransferOwnership => "Transfer a workspace's ownership",
621 Op::LeaveWorkspace => "Leave a workspace",
622 Op::ListEmails => "List your email addresses",
623 Op::AddEmail => "Add an email address",
624 Op::ConfirmEmail => "Confirm an email address",
625 Op::RemoveEmail => "Remove an email address",
626 Op::UpdateEmailSettings => "Change your email settings",
627 Op::ListWorkspaceInvites => "List a workspace's invites",
628 Op::InviteMember => "Invite someone to a workspace",
629 Op::ListInvitations => "List your workspace invitations",
630 Op::AcceptInvitation => "Accept a workspace invitation",
631 Op::DeclineInvitation => "Decline a workspace invitation",
632 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
633 Op::TransferRepo => "Transfer a repository",
634 Op::RenameRepo => "Rename a repository",
635 Op::RenameBranch => "Rename a branch",
636 Op::CreateBranch => "Create a branch",
637 Op::DeleteBranch => "Delete a branch",
638 Op::ArchiveRepo => "Archive a repository",
639 Op::UnarchiveRepo => "Unarchive a repository",
640 Op::SetRepoVisibility => "Change a repository's visibility",
641 Op::DeleteRepo => "Delete a repository",
642 Op::ListDeletedRepos => "List recently deleted repositories",
643 Op::RestoreRepo => "Restore a deleted repository",
644 Op::PurgeRepo => "Purge a deleted repository",
645 Op::ListRepos => "List repositories",
646 Op::GetRepo => "Get a repository",
647 Op::CreateRepo => "Create a repository",
648 Op::UpdateRepo => "Update a repository",
649 Op::GetRepoSettings => "Get repository settings",
650 Op::UpdateRepoSettings => "Update repository settings",
651 Op::ListCheckNames => "List check names",
652 Op::GetMergeQueue => "Get the merge queue",
653 Op::Remember => "Remember something",
654 Op::Recall => "Recall memory",
655 Op::Search => "Search g1t",
656 Op::ListIssues => "List issues",
657 Op::GetIssue => "Get an issue",
658 Op::CreateIssue => "Create an issue",
659 Op::UpdateIssue => "Update an issue",
660 Op::CloseIssue => "Close an issue",
661 Op::ReopenIssue => "Reopen an issue",
662 Op::ListLabels => "List labels",
663 Op::CreateLabel => "Create a label",
664 Op::UpdateLabel => "Update a label",
665 Op::DeleteLabel => "Delete a label",
666 Op::AddDefaultLabels => "Add the default labels",
667 Op::ListIssueLabels => "List an issue's labels",
668 Op::AddIssueLabels => "Add labels to an issue",
669 Op::SetIssueLabels => "Set an issue's labels",
670 Op::RemoveIssueLabels => "Remove labels from an issue",
671 Op::ListMilestones => "List milestones",
672 Op::GetMilestone => "Get a milestone",
673 Op::CreateMilestone => "Create a milestone",
674 Op::UpdateMilestone => "Update a milestone",
675 Op::DeleteMilestone => "Delete a milestone",
676 Op::UpdatePullRequest => "Update a pull request",
677 Op::AddComment => "Add a comment",
678 Op::EditComment => "Edit a comment",
679 Op::DeleteComment => "Delete a comment",
680 Op::ReviewPullRequest => "Review a pull request",
681 Op::ListPullRequests => "List pull requests",
682 Op::GetPullRequest => "Get a pull request",
683 Op::CreatePullRequest => "Create a pull request",
684 Op::RecordSession => "Record session entries",
685 Op::ReadSession => "Read a session",
686 Op::RecordDecision => "Record a decision",
687 Op::ListDecisions => "List a pull request's decisions",
688 Op::Why => "Explain a line",
689 Op::MarkPullRequestReady => "Mark a pull request ready",
690 Op::ClosePullRequest => "Close a pull request",
691 Op::ReopenPullRequest => "Reopen a pull request",
692 Op::ConvertPullRequestToDraft => "Convert a pull request to a draft",
693 Op::GetPullRequestChanges => "Get a pull request's changes",
694 Op::MergePullRequest => "Merge a pull request",
695 Op::ListEvents => "List repository events",
696 Op::ListIntegrations => "List integrations",
697 Op::ConnectIntegration => "Connect an integration",
698 Op::UpdateIntegration => "Update an integration",
699 Op::DisconnectIntegration => "Disconnect an integration",
700 Op::TestIntegration => "Test an integration",
701 Op::GetContext => "Look up a ticket",
702 Op::ImportIssue => "Import an issue",
703 Op::ListWebhooks => "List webhooks",
704 Op::CreateWebhook => "Create a webhook",
705 Op::UpdateWebhook => "Update a webhook",
706 Op::DeleteWebhook => "Delete a webhook",
707 Op::PingWebhook => "Ping a webhook",
708 Op::ListWebhookDeliveries => "List webhook deliveries",
709 Op::RedeliverWebhook => "Redeliver a webhook delivery",
710 Op::ListWorkflows => "List workflows",
711 Op::ListWorkflowRuns => "List workflow runs",
712 Op::GetWorkflowRun => "Get a workflow run",
713 Op::GetJobLogs => "Get a job's log",
714 Op::DispatchWorkflow => "Run a workflow",
715 Op::CancelWorkflowRun => "Cancel a workflow run",
716 Op::RerunWorkflowRun => "Re-run a workflow run",
717 Op::UpdateWorkflow => "Turn a workflow on or off",
718 Op::ListActionsSecrets => "List secrets",
719 Op::SetActionsSecret => "Set a secret",
720 Op::DeleteActionsSecret => "Delete a secret",
721 Op::ListActionsVariables => "List variables",
722 Op::SetActionsVariable => "Set a variable",
723 Op::DeleteActionsVariable => "Delete a variable",
724 Op::ListRunners => "List self-hosted runners",
725 Op::ListRunnerGroups => "List runner groups",
726 Op::GetRunnerSettings => "Get runner settings",
727 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
728 Op::RemoveRunner => "Remove a self-hosted runner",
729 Op::CreateRunnerGroup => "Create a runner group",
730 Op::UpdateRunnerGroup => "Change a runner group",
731 Op::DeleteRunnerGroup => "Delete a runner group",
732 Op::UpdateRunnerSettings => "Change runner settings",
733 Op::ListCollaborators => "List who has access",
734 Op::AddCollaborator => "Add a collaborator",
735 Op::UpdateCollaborator => "Change a collaborator's role",
736 Op::RemoveCollaborator => "Remove a collaborator",
737 Op::GetCollaboratorPermission => "Get someone's permission",
738 Op::ListRepoInvitations => "List a repository's invitations",
739 Op::RevokeRepoInvitation => "Revoke a repository invitation",
740 Op::ListMyRepoInvitations => "List your repository invitations",
741 Op::AcceptRepoInvitation => "Accept a repository invitation",
742 Op::DeclineRepoInvitation => "Decline a repository invitation",
743 Op::SetBasePermission => "Set the base permission",
744 Op::ListOutsideCollaborators => "List outside collaborators",
745 Op::ListSecurityAlerts => "List security alerts",
746 Op::DismissSecurityAlert => "Dismiss a security alert",
747 Op::ReopenSecurityAlert => "Reopen a security alert",
748 Op::ListNotifications => "List notifications",
749 Op::MarkNotificationsRead => "Mark notifications read",
750 Op::GetNotificationThread => "Get a thread",
751 Op::MarkThreadRead => "Mark a thread read",
752 Op::MarkThreadDone => "Mark a thread done",
753 Op::SaveThread => "Save a thread",
754 Op::SnoozeThread => "Snooze a thread",
755 Op::GetThreadSubscription => "Get a thread subscription",
756 Op::SetThreadSubscription => "Set a thread subscription",
757 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
758 Op::GetRepoSubscription => "Get how you watch a repository",
759 Op::SetRepoSubscription => "Watch a repository",
760 Op::DeleteRepoSubscription => "Stop watching a repository",
761 Op::ListWatchedRepos => "List repositories you watch",
762 Op::ListPinnedProjects => "List your pinned projects",
763 Op::GetUsage => "Get a workspace's usage",
764 Op::GetBudget => "Get a workspace's budget",
765 Op::SetBudget => "Change a workspace's budget",
766 Op::ListInvoices => "List a workspace's invoices",
767 Op::GetBillingDetails => "Get a workspace's billing details",
768 Op::PinProject => "Pin a project",
769 Op::UnpinProject => "Unpin a project",
770 Op::ReorderPinnedProjects => "Reorder your pinned projects",
771 Op::ListProjects => "List a workspace's projects",
772 Op::GetProject => "Get a project",
773 Op::UpdateProject => "Update a project",
774 Op::ListTeams => "List teams",
775 Op::GetTeam => "Get a team",
776 Op::CreateTeam => "Create a team",
777 Op::UpdateTeam => "Update a team",
778 Op::DeleteTeam => "Delete a team",
779 Op::ListTeamMembers => "List a team's members",
780 Op::SetTeamMember => "Add or change a team member",
781 Op::RemoveTeamMember => "Remove a team member",
782 Op::ListChildTeams => "List child teams",
783 Op::ListTeamRepos => "List a team's repositories",
784 Op::SetTeamRepo => "Give a team a role on a repository",
785 Op::RemoveTeamRepo => "Remove a team from a repository",
786 Op::SetTeamReviewAssignment => "Set a team's review assignment",
787 Op::ListUserTeams => "List someone's teams",
788 Op::RequestReviewers => "Request reviewers",
789 Op::RemoveRequestedReviewers => "Remove requested reviewers",
790 Op::GetCodeownersErrors => "List CODEOWNERS errors",
791 Op::Security(op) => op.title(),
792 Op::Rules(op) => op.title(),
793 Op::Checks(op) => op.title(),
794 Op::About(op) => op.title(),
795 Op::Deployments(op) => op.title(),
796 Op::Telemetry(op) => op.title(),
797 Op::Protection(op) => op.title(),
798 Op::Tokens(op) => op.title(),
799 Op::Artifacts(op) => op.title(),
800 Op::Archives(op) => op.title(),
801 Op::DeployKeys(op) => op.title(),
802 Op::Packages(op) => op.title(),
803 Op::Folios(op) => op.title(),
804 Op::Coordination(op) => op.title(),
805 }
806}
807
808/// Why an operation can be refused with `402 payment_required`, if it
809/// can: the ones that make a repository private in a workspace, when a
810/// free workspace's private storage has no room for it.
811fn may_need_payment(op: Op) -> Option<&'static str> {
812 match op {
813 Op::UpdateRepo | Op::SetRepoVisibility | Op::TransferRepo => Some(
814 "A free workspace's private storage has no room for this private repository.",
815 ),
816 _ => None,
817 }
818}
819
820/// What the reference says beyond each operation's own description, keyed
821/// by operation id, written by hand from what the services return: `notes`
822/// (Markdown, added to the description) and example `params` (path),
823/// `query`, `request` (body) and `response`.
824const REFERENCE: &str = include_str!("reference.json");
825
826fn examples() -> Map<String, Value> {
827 match serde_json::from_str(REFERENCE) {
828 Ok(Value::Object(examples)) => examples,
829 _ => Map::new(),
830 }
831}
832
833/// `/repos/:owner/:name` as OpenAPI writes it: `/repos/{owner}/{name}`.
834fn openapi_path(route: &Route) -> String {
835 route
836 .path
837 .split('/')
838 .map(|segment| match segment.strip_prefix(':') {
839 Some(name) => format!("{{{name}}}"),
840 None => segment.to_owned(),
841 })
842 .collect::<Vec<_>>()
843 .join("/")
844}
845
846fn error_response(description: &str) -> Value {
847 json!({
848 "description": description,
849 "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } },
850 })
851}
852
853/// A parameter in the path or the query, described by the operation's
854/// input schema where it has the same name.
855fn parameter(name: &str, place: &str, required: bool, schema: Option<&Value>) -> Value {
856 let mut schema = schema.cloned().unwrap_or_else(|| json!({ "type": "string" }));
857 let description = match name {
858 "owner" => Some(Value::from("The workspace that owns the repository.")),
859 "name" => Some(Value::from("The repository's name.")),
860 _ => schema.as_object_mut().and_then(|schema| schema.remove("description")),
861 };
862 let mut parameter = json!({
863 "name": name,
864 "in": place,
865 "required": required,
866 "schema": schema,
867 });
868 if let Some(description) = description {
869 parameter["description"] = description;
870 }
871 parameter
872}
873
874/// The operation id of a route. An operation reached at a workspace's
875/// address as well as a repository's is documented once for each, with its
876/// own id; GitHub's alternative addresses for one operation keep GitHub's
877/// names.
878fn operation_id(route: &Route) -> String {
879 let op = route.op;
880 let base = match (route.method, route.path.rsplit('/').next().unwrap_or_default()) {
881 ("PUT", "enable") => "enable_workflow".to_owned(),
882 ("PUT", "disable") => "disable_workflow".to_owned(),
883 ("POST", "rerun-failed-jobs") => "rerun_failed_jobs".to_owned(),
884 ("POST", "rerun") if route.path.contains("/jobs/:job/") => "rerun_job".to_owned(),
885 ("POST", "force-cancel") => "force_cancel_workflow_run".to_owned(),
886 ("GET", ":attempt") => "get_workflow_run_attempt".to_owned(),
887 ("PATCH", ":setting") => "update_actions_variable".to_owned(),
888 ("GET", "runs") if route.path.contains("/workflows/:workflow/") => "list_runs_of_workflow".to_owned(),
889 // One repository's notifications, and an issue's subscription by
890 // its number rather than a thread's id.
891 (_, "notifications") if route.path.starts_with("/repos/") => match op {
892 Op::ListNotifications => "list_repo_notifications".to_owned(),
893 _ => "mark_repo_notifications_read".to_owned(),
894 },
895 (method, "subscription") if route.path.contains("/issues/:number/") => match method {
896 "GET" => "get_issue_subscription".to_owned(),
897 "PUT" => "set_issue_subscription".to_owned(),
898 _ => "delete_issue_subscription".to_owned(),
899 },
900 // One label off an issue, by its name in the path.
901 ("DELETE", ":label") if route.path.contains("/issues/:number/") => "remove_issue_label".to_owned(),
902 ("DELETE", "saved") => "unsave_thread".to_owned(),
903 ("DELETE", "snooze") => "unsnooze_thread".to_owned(),
904 // An issue's decisions, by its number.
905 ("GET", "decisions") if route.path.contains("/issues/:number/") => "list_issue_decisions".to_owned(),
906 _ => op.name().to_owned(),
907 };
908 if route.path.starts_with("/workspaces/") && ROUTES.iter().any(|other| other.op == op && other.path.starts_with("/repos/")) {
909 format!("{base}_for_workspace")
910 } else {
911 base
912 }
913}
914
915/// The summary of a route: its operation's title, or for one of GitHub's
916/// alternative addresses, what that address does.
917fn summary(route: &Route, id: &str) -> String {
918 let base = match id.trim_end_matches("_for_workspace") {
919 "enable_workflow" => "Turn a workflow on",
920 "disable_workflow" => "Turn a workflow off",
921 "rerun_failed_jobs" => "Re-run failed jobs",
922 "rerun_job" => "Re-run a job",
923 "force_cancel_workflow_run" => "Force-cancel a workflow run",
924 "get_workflow_run_attempt" => "Get a workflow run attempt",
925 "update_actions_variable" => "Update a variable",
926 "list_runs_of_workflow" => "List a workflow's runs",
927 "list_repo_notifications" => "List a repository's notifications",
928 "mark_repo_notifications_read" => "Mark a repository's notifications read",
929 "get_issue_subscription" => "Get your subscription to an issue",
930 "set_issue_subscription" => "Subscribe to an issue",
931 "delete_issue_subscription" => "Unsubscribe from an issue",
932 "unsave_thread" => "Unsave a thread",
933 "unsnooze_thread" => "Bring a snoozed thread back",
934 "list_issue_decisions" => "List an issue's decisions",
935 _ => title(route.op),
936 };
937 if id.ends_with("_for_workspace") {
938 format!("{base} for a workspace")
939 } else {
940 base.to_owned()
941 }
942}
943
944fn operation(route: &Route) -> Value {
945 let op = route.op;
946 let path_params: Vec<&str> = route.params().collect();
947 // `owner` and `name` in the path stand for the operation's `repo` input,
948 // so a `name` in the body, such as a check run's, is the body's own.
949 let stands_for_repo =
950 |name: &str| matches!(name, "owner" | "name") && path_params.contains(&"owner") && path_params.contains(&"name");
951 let covered = |name: &str| name == "repo" || (path_params.contains(&name) && !stands_for_repo(name));
952 let all_properties = op.properties();
953 let mut properties = all_properties.clone();
954 properties.retain(|name, _| !covered(name));
955 let required: Vec<String> = op
956 .required()
957 .into_iter()
958 .filter(|name| !covered(name))
959 .collect();
960
961 let mut parameters: Vec<Value> = path_params
962 .iter()
963 .map(|name| parameter(name, "path", true, if stands_for_repo(name) { None } else { all_properties.get(*name) }))
964 .collect();
965 let mut body = Value::Null;
966 if route.method == "GET" {
967 for (name, key) in route.query {
968 parameters.push(parameter(
969 name,
970 "query",
971 required.iter().any(|required| required == key),
972 properties.get(*key),
973 ));
974 }
975 } else if !properties.is_empty() {
976 let mut schema = json!({ "type": "object", "properties": properties });
977 if !required.is_empty() {
978 schema["required"] = json!(required);
979 }
980 body = json!({
981 "required": !required.is_empty(),
982 "content": { "application/json": { "schema": schema } },
983 });
984 }
985
986 let id = operation_id(route);
987 let mut responses = Map::new();
988 if route.no_content() {
989 responses.insert("204".into(), json!({ "description": "Success. There is no body." }));
990 } else {
991 responses.insert(
992 "200".into(),
993 json!({
994 "description": "Success.",
995 "content": { "application/json": { "schema": {} } },
996 }),
997 );
998 }
999 responses.insert(
1000 "401".into(),
1001 error_response("A token is required, or the one sent is not valid."),
1002 );
1003 if let Some(reason) = may_need_payment(op) {
1004 responses.insert("402".into(), error_response(reason));
1005 }
1006 responses.insert(
1007 "403".into(),
1008 error_response("Signed in, but not allowed to do this: the role you have is not enough, or the token lacks the scope it needs, which `needed_scope` names."),
1009 );
1010 if !matches!(op, Op::Whoami | Op::ListRepos | Op::Search) {
1011 responses.insert("404".into(), error_response("It does not exist, or you cannot see it."));
1012 }
1013 if route.method != "GET" {
1014 responses.insert(
1015 "409".into(),
1016 error_response("The request conflicts with the current state."),
1017 );
1018 }
1019 if op != Op::Whoami {
1020 responses.insert("422".into(), error_response("The input is not valid."));
1021 }
1022 // Public data can be read without a token; everything else needs one.
1023 let scope: Vec<&str> = scope_for(op.name()).map(|scope| scope.as_str()).into_iter().collect();
1024 let security = if op.needs_user() {
1025 json!([{ "token": scope }])
1026 } else {
1027 json!([{ "token": scope }, {}])
1028 };
1029 let (tool, action) = crate::tools::TOOLS
1030 .iter()
1031 .find_map(|tool| {
1032 tool.actions
1033 .iter()
1034 .find(|action| action.op == op)
1035 .map(|action| (tool.name, action.name))
1036 })
1037 .unwrap_or_default();
1038 let mut described = json!({
1039 "operationId": id,
1040 "tags": [tag(op)],
1041 "summary": summary(route, &id),
1042 "description": op.description(),
1043 "x-operation": op.name(),
1044 "x-mcp-tool": tool,
1045 "x-mcp-action": action,
1046 "x-scope": scope.first().copied(),
1047 "security": security,
1048 "parameters": parameters,
1049 "responses": responses,
1050 });
1051 if !body.is_null() {
1052 described["requestBody"] = body;
1053 }
1054 described
1055}
1056
1057/// Entries for device sign-in, which is not an operation.
1058fn onboarding() -> Map<String, Value> {
1059 let paths = json!({
1060 "/device/code": {
1061 "post": {
1062 "operationId": "device_code",
1063 "tags": ["Accounts"],
1064 "summary": "Start signing in",
1065 "description": "Begins a device sign-in. Show the person `verification_uri_complete` and have them open it in a browser, where they sign in or register and approve the code. Then poll `/device/token`.",
1066 "security": [],
1067 "requestBody": {
1068 "content": { "application/json": { "schema": {
1069 "type": "object",
1070 "properties": {
1071 "client_name": {
1072 "type": "string",
1073 "description": "What is asking, shown to the person approving. For example, Claude Code.",
1074 },
1075 },
1076 } } },
1077 },
1078 "responses": { "200": {
1079 "description": "The codes for this sign-in.",
1080 "content": { "application/json": { "schema": {
1081 "type": "object",
1082 "properties": {
1083 "device_code": { "type": "string", "description": "Secret. Send it to /device/token." },
1084 "user_code": { "type": "string", "description": "Shown to the person, like WDJB-MJHT." },
1085 "verification_uri": { "type": "string" },
1086 "verification_uri_complete": {
1087 "type": "string",
1088 "description": "The link to give the person; it carries the code.",
1089 },
1090 "expires_in": { "type": "integer", "description": "Seconds until the codes expire." },
1091 "interval": { "type": "integer", "description": "Seconds to wait between polls." },
1092 },
1093 } } },
1094 } },
1095 },
1096 },
1097 "/device/token": {
1098 "post": {
1099 "operationId": "device_token",
1100 "tags": ["Accounts"],
1101 "summary": "Finish signing in",
1102 "description": "Asks whether the person has approved. Poll no faster than the interval. The token is returned once.",
1103 "security": [],
1104 "requestBody": {
1105 "required": true,
1106 "content": { "application/json": { "schema": {
1107 "type": "object",
1108 "required": ["device_code"],
1109 "properties": { "device_code": { "type": "string" } },
1110 } } },
1111 },
1112 "responses": { "200": {
1113 "description": "The state of the sign-in.",
1114 "content": { "application/json": { "schema": {
1115 "type": "object",
1116 "required": ["status"],
1117 "properties": {
1118 "status": { "type": "string", "enum": ["pending", "approved", "denied", "expired"] },
1119 "token": { "type": "string", "description": "Present when approved." },
1120 "username": { "type": "string", "description": "Lowercased: what the account is found and linked by." },
1121 "display_username": { "type": "string", "description": "The username as its owner wrote it; the same as username when they chose no case." },
1122 "verified": {
1123 "type": "boolean",
1124 "description": "Whether the account's email is confirmed.",
1125 },
1126 },
1127 } } },
1128 } },
1129 },
1130 },
1131 });
1132 match paths {
1133 Value::Object(paths) => paths,
1134 _ => Map::new(),
1135 }
1136}
1137
1138
1139/// Puts each operation's examples, where it has them, into its request
1140/// and response. Path and query values go under `x-example-params` and
1141/// `x-example-query`, which tools that build a request can use.
1142fn attach_examples(paths: &mut Map<String, Value>) {
1143 let examples = examples();
1144 for methods in paths.values_mut() {
1145 let Some(methods) = methods.as_object_mut() else { continue };
1146 for operation in methods.values_mut() {
1147 let id = operation["operationId"].as_str().unwrap_or_default().to_owned();
1148 let name = operation["x-operation"].as_str().unwrap_or_default().to_owned();
1149 let Some(example) = examples.get(&id).or_else(|| examples.get(&name)) else {
1150 continue;
1151 };
1152 if let Some(notes) = example.get("notes").and_then(Value::as_str) {
1153 let description = operation["description"].as_str().unwrap_or_default();
1154 operation["description"] = json!(format!("{description}\n\n{notes}"));
1155 }
1156 if let Some(response) = example.get("response") {
1157 let content = &mut operation["responses"]["200"]["content"]["application/json"];
1158 if content.is_object() {
1159 content["example"] = response.clone();
1160 }
1161 }
1162 if let Some(request) = example.get("request") {
1163 let content = &mut operation["requestBody"]["content"]["application/json"];
1164 if content.is_object() {
1165 content["example"] = request.clone();
1166 }
1167 }
1168 for (key, extension) in [("params", "x-example-params"), ("query", "x-example-query")] {
1169 if let Some(values) = example.get(key) {
1170 operation[extension] = values.clone();
1171 }
1172 }
1173 }
1174 }
1175}
1176
1177pub fn document() -> Value {
1178 let mut paths = onboarding();
1179 for route in ROUTES {
1180 let entry = paths
1181 .entry(openapi_path(route))
1182 .or_insert_with(|| json!({}));
1183 entry[route.method.to_lowercase()] = operation(route);
1184 }
1185 attach_examples(&mut paths);
1186 let tags: Vec<Value> = SECTIONS
1187 .iter()
1188 .map(|(name, description, ops)| {
1189 json!({
1190 "name": name,
1191 "description": description,
1192 // The section's operations in reading order, by MCP tool name.
1193 "x-tools": ops.iter().map(|op| op.name()).collect::<Vec<_>>(),
1194 })
1195 })
1196 .collect();
1197 let codes = ["unauthenticated", "payment_required", "forbidden", "not_found", "conflict", "invalid"];
1198 json!({
1199 "openapi": "3.1.0",
1200 "info": {
1201 "title": "g1t API",
1202 "version": "1",
1203 "description": "The REST API for g1t, a git forge built for agents. The same operations are available to agents as MCP tools at https://mcp.g1t.sh. Every name in a request or response body is `snake_case`; names you chose, such as a workflow's inputs or a secret's name, are returned as you wrote them.",
1204 "license": { "name": "MIT", "identifier": "MIT" },
1205 },
1206 "servers": [{ "url": "https://api.g1t.sh" }],
1207 "security": [{ "token": [] }, {}],
1208 "tags": tags,
1209 "paths": paths,
1210 "components": {
1211 "securitySchemes": {
1212 "token": {
1213 "type": "http",
1214 "scheme": "bearer",
1215 "description": "An access token, `g1t_…`. Public data needs none. Each operation names the scope a token needs for it; see https://docs.g1t.sh/guides/authentication/#scopes.",
1216 },
1217 },
1218 "schemas": {
1219 "Error": {
1220 "type": "object",
1221 "required": ["error"],
1222 "properties": {
1223 "error": {
1224 "type": "object",
1225 "required": ["code", "message"],
1226 "properties": {
1227 "code": { "type": "string", "enum": codes },
1228 "message": { "type": "string" },
1229 "needed_scope": {
1230 "type": "string",
1231 "description": "On a 403 for an access token without the scope the call needs: that scope, such as `issues:write`.",
1232 },
1233 },
1234 },
1235 },
1236 },
1237 },
1238 },
1239 })
1240}
1241
1242#[cfg(test)]
1243mod tests {
1244 use super::*;
1245
1246 #[test]
1247 fn every_route_is_documented_once() {
1248 let document = document();
1249 let mut ids = Vec::new();
1250 for (_, methods) in document["paths"].as_object().unwrap() {
1251 for (_, operation) in methods.as_object().unwrap() {
1252 ids.push(operation["operationId"].as_str().unwrap().to_owned());
1253 }
1254 }
1255 for op in Op::ALL {
1256 assert_eq!(
1257 ids.iter().filter(|id| *id == op.name()).count(),
1258 1,
1259 "{}",
1260 op.name()
1261 );
1262 }
1263 let mut unique = ids.clone();
1264 unique.sort();
1265 unique.dedup();
1266 assert_eq!(unique.len(), ids.len(), "operation ids repeat");
1267 }
1268
1269 #[test]
1270 fn path_and_query_inputs_are_not_repeated_in_the_body() {
1271 let document = document();
1272 let merge = &document["paths"]["/repos/{owner}/{name}/pulls/{number}/merge"]["post"];
1273 let body = &merge["requestBody"]["content"]["application/json"]["schema"]["properties"];
1274 assert!(body.get("keep_issue_open").is_some());
1275 assert!(body.get("repo").is_none() && body.get("number").is_none());
1276 let list = &document["paths"]["/repos"]["get"];
1277 assert_eq!(list["parameters"][0]["name"], "q");
1278 assert!(list.get("requestBody").is_none());
1279 }
1280
1281 #[test]
1282 fn every_operation_is_in_one_section() {
1283 for op in Op::ALL {
1284 let sections = SECTIONS
1285 .iter()
1286 .filter(|(_, _, ops)| ops.contains(&op))
1287 .count();
1288 assert_eq!(sections, 1, "{}", op.name());
1289 }
1290 }
1291
1292 #[test]
1293 fn titles_read_as_sentences() {
1294 assert_eq!(title(Op::CreateIssue), "Create an issue");
1295 assert_eq!(title(Op::Whoami), "Get the current user");
1296 }
1297
1298 #[test]
1299 fn every_operation_has_an_example_response() {
1300 let examples = examples();
1301 assert!(!examples.is_empty(), "reference.json does not parse");
1302 let document = document();
1303 let mut known = Vec::new();
1304 for (path, methods) in document["paths"].as_object().unwrap() {
1305 for (method, operation) in methods.as_object().unwrap() {
1306 known.push(operation["operationId"].as_str().unwrap().to_owned());
1307 // Nothing to show for a success without a body.
1308 if operation["responses"]["204"].is_object() {
1309 continue;
1310 }
1311 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1312 assert!(!example.is_null(), "{method} {path} has no example response");
1313 }
1314 }
1315 for id in examples.keys() {
1316 assert!(known.contains(id), "reference.json names {id}, which is not an operation");
1317 }
1318 }
1319
1320 #[test]
1321 fn example_requests_send_only_what_the_body_takes() {
1322 let document = document();
1323 for (path, methods) in document["paths"].as_object().unwrap() {
1324 for (method, operation) in methods.as_object().unwrap() {
1325 let content = &operation["requestBody"]["content"]["application/json"];
1326 let Some(example) = content["example"].as_object() else { continue };
1327 let properties = &content["schema"]["properties"];
1328 for key in example.keys() {
1329 assert!(!properties[key].is_null(), "{method} {path}: {key} is not in the body");
1330 }
1331 }
1332 }
1333 }
1334
1335 /// The docs site's copy of the document. Run with `G1T_WRITE_OPENAPI=1`
1336 /// to rewrite it after changing an operation.
1337 #[test]
1338 fn the_docs_copy_is_current() {
1339 let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/src/data/openapi.json");
1340 let current = serde_json::to_string_pretty(&document()).unwrap() + "\n";
1341 if std::env::var_os("G1T_WRITE_OPENAPI").is_some() {
1342 std::fs::write(path, &current).unwrap();
1343 return;
1344 }
1345 let copy = std::fs::read_to_string(path).unwrap_or_default().replace("\r\n", "\n");
1346 assert!(
1347 copy == current,
1348 "apps/docs/src/data/openapi.json is out of date: run G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi"
1349 );
1350 }
1351
1352 /// The reference shows responses as they are sent: `snake_case`.
1353 #[test]
1354 fn example_responses_are_snake_case() {
1355 let document = document();
1356 for (path, methods) in document["paths"].as_object().unwrap() {
1357 for (method, operation) in methods.as_object().unwrap() {
1358 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1359 let leaked = g1t_kit::wire::camel_case_keys(example);
1360 assert!(leaked.is_empty(), "{method} {path} shows {leaked:?}");
1361 }
1362 }
1363 }
1364
1365 /// Examples never hold anything that reads as a real credential, which
1366 /// secret scanners rightly flag in a public repository: they end in `…`
1367 /// after the prefix, as `whsec_…` and `g1t_…` do.
1368 #[test]
1369 fn examples_hold_no_real_looking_secrets() {
1370 let prefixes = ["whsec_", "g1t_", "g1tr_", "g1trt_", "sk_live_", "sk_test_", "ghp_", "github_pat_", "xoxb-", "AKIA"];
1371 for (line, text) in REFERENCE.lines().enumerate() {
1372 for prefix in prefixes {
1373 let mut rest = text;
1374 while let Some(at) = rest.find(prefix) {
1375 let after = &rest[at + prefix.len()..];
1376 let run = after.chars().take_while(|c| c.is_ascii_alphanumeric()).count();
1377 assert!(
1378 run < 12,
1379 "reference.json line {}: `{prefix}` followed by {run} characters reads as a real secret; write `{prefix}…`",
1380 line + 1
1381 );
1382 rest = after;
1383 }
1384 }
1385 }
1386 }
1387}