Skip to content
Sign up

flagon-io/g1t

public
0

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,426 linesCodeBlameRaw

Pick any line to see why it is the way it is: the commit, the pull request and issue it came from, and what the agent was thinking.

Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1//! 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
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step7use g1t_contracts::scopes::scope_for;
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms8use serde_json::{Map, Value, json};
9
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9710use crate::about::AboutOp;
The artifacts service is services/artifacts, the Worker g1t-artifacts, bound as ARTIFACTS by the API, the site and the agents; its live rooms move to it with a Durable Object transfer from g1t-docs-service, and its database, bucket, indexes and queue keep their names. The git store's binding and settings are GITSTORE, its ops scripts gitstore-*, and workflow run artifacts keep their compatible API under run_artifacts modules. The deploy tool puts a Worker that has never deployed before the Workers in its stage that bind to it, and the deploy guide gives the cutover runbook.11use crate::run_artifacts::ArtifactsOp;
Merge branch 'worktree-agent-a19b06d959c105bf7' into claude/cool-newton-7nm8r912use crate::archives::ArchiveOp;
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r913use crate::customize::CustomizeOp;
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca14use crate::deploy_keys::DeployKeysOp;
Merge branch 'mirroring' into artifacts-mode15use crate::mirrors::MirrorsOp;
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9716use crate::deployments::DeploymentsOp;
Merge packages: roles, Actions access, source label, soft delete, API17use crate::packages::PackagesOp;
Merge main into Artifacts Phase 218use crate::folios::FoliosOp;
Merge branch 'worktree-agent-a3abfcce648e87dca'19use crate::protection::ProtectionOp;
API and MCP for a workspace's personal access token rules, members' tokens and approvals20use crate::token_policy::TokenOp;
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms21use crate::operations::Op;
Merge checks: statuses and check runs on every commit22use crate::checks::ChecksOp;
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge23use crate::rules::RulesOp;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar24use crate::security::SecurityOp;
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms25use 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.",
Merge email confirmation gate: a code and a link, nothing until confirmed (identity 0036)33 &[Op::Whoami, Op::ListEmails, Op::AddEmail, Op::ConfirmEmail, Op::RemoveEmail, Op::UpdateEmailSettings],
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms34 ),
35 (
API: notifications over REST and MCP, with notifications scopes36 "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 (
API: pinned projects over REST and MCP56 "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 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9761 "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 (
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms66 "Workspaces",
67 "A workspace owns repositories and is the first part of their address. People and agents work in workspaces.",
Merge branch 'worktree-agent-ad7c6d88d93adc817'68 &[Op::GetWorkspace, Op::CreateWorkspace, Op::UpdateWorkspace, Op::DeleteWorkspace],
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms69 ),
70 (
API and MCP for a workspace's personal access token rules, members' tokens and approvals71 "Personal access tokens",
One kind of access token; presence and status; usernames keep their case; the tour is a miniature of the real app; icons for password managers72 "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.",
API and MCP for a workspace's personal access token rules, members' tokens and approvals73 &[
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 (
Merge main (membership, two-factor, GitHub repo roles) into tokens83 "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 (
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms88 "Invites",
Merge workspace invitations: nobody joins a workspace without saying yes, people are found by username, your own invites can bring someone in, and nobody is left without a workspace (identity 0040)89 "While g1t is invite-only, every new account needs an invite. Your invites, inviting people into a workspace by username or email, and answering the invitations to workspaces sent to you.",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms90 &[
91 Op::ListInvites,
92 Op::CreateInvite,
93 Op::RevokeInvite,
94 Op::ListWorkspaceInvites,
95 Op::InviteMember,
96 Op::RevokeWorkspaceInvite,
Merge workspace invitations: nobody joins a workspace without saying yes, people are found by username, your own invites can bring someone in, and nobody is left without a workspace (identity 0040)97 Op::ListInvitations,
98 Op::AcceptInvitation,
99 Op::DeclineInvitation,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms100 ],
101 ),
102 (
Usage, Billing settings and prepaid AI credit; fixes from the UX audit103 "Billing",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens104 "A workspace's usage, its budget, its AI credit, its invoices and its AI Gateway requests. Members read them; owners change the budget and buy credit, as people. g1t's agents never change billing.",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit105 &[
106 Op::GetUsage,
107 Op::GetBudget,
108 Op::SetBudget,
109 Op::GetAiCredit,
110 Op::BuyAiCredit,
111 Op::ListInvoices,
112 Op::GetBillingDetails,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens113 Op::ListGatewayRequests,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit114 ],
115 ),
116 (
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms117 "Repositories",
Merge branch 'worktree-agent-a19b06d959c105bf7' into claude/cool-newton-7nm8r9118 "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.",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms119 &[
120 Op::ListRepos,
121 Op::CreateRepo,
122 Op::GetRepo,
Merge branch 'worktree-agent-a19b06d959c105bf7' into claude/cool-newton-7nm8r9123 Op::Archives(ArchiveOp::DownloadTarball),
124 Op::Archives(ArchiveOp::DownloadZipball),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms125 Op::UpdateRepo,
126 Op::RenameRepo,
127 Op::RenameBranch,
128 Op::SetRepoVisibility,
129 Op::ArchiveRepo,
130 Op::UnarchiveRepo,
131 Op::TransferRepo,
132 Op::DeleteRepo,
133 Op::ListDeletedRepos,
134 Op::RestoreRepo,
135 Op::PurgeRepo,
136 Op::GetRepoSettings,
137 Op::UpdateRepoSettings,
Fast pages, required checks on the branch, self-hosted runners, honest incidents138 Op::ListCheckNames,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar139 Op::GetCodeownersErrors,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms140 Op::ListEvents,
141 ],
142 ),
143 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97144 "Repository insights",
145 "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.",
146 &[Op::About(AboutOp::GetLanguages), Op::About(AboutOp::ListContributors), Op::About(AboutOp::GetLicense)],
147 ),
148 (
149 "Stars",
150 "Starring a repository, to keep it and to say you like it: who starred one, and what you starred.",
151 &[
152 Op::About(AboutOp::ListStargazers),
153 Op::About(AboutOp::ListStarred),
154 Op::About(AboutOp::CheckStarred),
155 Op::About(AboutOp::Star),
156 Op::About(AboutOp::Unstar),
157 ],
158 ),
159 (
160 "Releases",
161 "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.",
162 &[
163 Op::About(AboutOp::ListReleases),
164 Op::About(AboutOp::CreateRelease),
165 Op::About(AboutOp::GetLatestRelease),
166 Op::About(AboutOp::GetReleaseByTag),
167 Op::About(AboutOp::GetRelease),
168 Op::About(AboutOp::UpdateRelease),
169 Op::About(AboutOp::DeleteRelease),
170 ],
171 ),
172 (
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms173 "Access",
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca174 "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.",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms175 &[
176 Op::ListCollaborators,
177 Op::AddCollaborator,
178 Op::UpdateCollaborator,
179 Op::RemoveCollaborator,
180 Op::GetCollaboratorPermission,
181 Op::ListRepoInvitations,
182 Op::RevokeRepoInvitation,
183 Op::ListMyRepoInvitations,
184 Op::AcceptRepoInvitation,
185 Op::DeclineRepoInvitation,
186 Op::SetBasePermission,
187 Op::ListOutsideCollaborators,
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca188 Op::DeployKeys(DeployKeysOp::ListDeployKeys),
189 Op::DeployKeys(DeployKeysOp::GetDeployKey),
190 Op::DeployKeys(DeployKeysOp::CreateDeployKey),
191 Op::DeployKeys(DeployKeysOp::DeleteDeployKey),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms192 ],
193 ),
194 (
Merge branch 'mirroring' into artifacts-mode195 "Mirroring",
196 "A repository's links to copies of it on other hosts: a mirror stands by as a read-only copy of a remote that leads, until someone takes over on g1t and later hands back, or moves it to g1t for good. A repository g1t leads can be mirrored to other hosts.",
197 &[
198 Op::Mirrors(MirrorsOp::GetMirror),
199 Op::Mirrors(MirrorsOp::GetHandBackPlan),
200 Op::Mirrors(MirrorsOp::TakeOver),
201 Op::Mirrors(MirrorsOp::SetCiFailover),
202 Op::Mirrors(MirrorsOp::HandBack),
203 Op::Mirrors(MirrorsOp::MoveToG1t),
204 Op::Mirrors(MirrorsOp::SyncMirror),
205 Op::Mirrors(MirrorsOp::AddRemote),
206 Op::Mirrors(MirrorsOp::UpdateRemote),
207 Op::Mirrors(MirrorsOp::RemoveRemote),
208 ],
209 ),
210 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar211 "Teams",
212 "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.",
213 &[
214 Op::ListTeams,
215 Op::CreateTeam,
216 Op::GetTeam,
217 Op::UpdateTeam,
218 Op::DeleteTeam,
219 Op::ListTeamMembers,
220 Op::SetTeamMember,
221 Op::RemoveTeamMember,
222 Op::ListChildTeams,
223 Op::ListTeamRepos,
224 Op::SetTeamRepo,
225 Op::RemoveTeamRepo,
226 Op::SetTeamReviewAssignment,
227 Op::ListUserTeams,
228 ],
229 ),
230 (
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily231 "Security",
232 "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.",
233 &[Op::ListSecurityAlerts, Op::DismissSecurityAlert, Op::ReopenSecurityAlert],
234 ),
235 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar236 "Secret scanning",
237 "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.",
238 &[
239 Op::Security(SecurityOp::ListSecretAlerts),
240 Op::Security(SecurityOp::GetSecretAlert),
241 Op::Security(SecurityOp::UpdateSecretAlert),
242 Op::Security(SecurityOp::ListSecretLocations),
243 Op::Security(SecurityOp::BypassPushProtection),
244 Op::Security(SecurityOp::CheckSecretValidity),
245 Op::Security(SecurityOp::ListBypassRequests),
246 Op::Security(SecurityOp::ReviewBypassRequest),
247 Op::Security(SecurityOp::ListCustomPatterns),
248 Op::Security(SecurityOp::CreateCustomPattern),
249 Op::Security(SecurityOp::UpdateCustomPattern),
250 Op::Security(SecurityOp::DeleteCustomPattern),
251 Op::Security(SecurityOp::DryRunCustomPattern),
252 ],
253 ),
254 (
255 "Code scanning",
256 "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.",
257 &[
258 Op::Security(SecurityOp::ListCodeAlerts),
259 Op::Security(SecurityOp::GetCodeAlert),
260 Op::Security(SecurityOp::UpdateCodeAlert),
261 Op::Security(SecurityOp::ListAnalyses),
262 Op::Security(SecurityOp::UploadSarif),
263 Op::Security(SecurityOp::GetSarifUpload),
264 Op::Security(SecurityOp::FixAlert),
265 ],
266 ),
267 (
268 "Supply chain",
269 "What a repository depends on: vulnerability alerts, the dependency graph, an SPDX SBOM of it, and comparing two commits' dependencies as dependency review does.",
270 &[
271 Op::Security(SecurityOp::ListVulnerabilityAlerts),
272 Op::Security(SecurityOp::GetVulnerabilityAlert),
273 Op::Security(SecurityOp::UpdateVulnerabilityAlert),
274 Op::Security(SecurityOp::GetDependencyGraph),
275 Op::Security(SecurityOp::GetSbom),
276 Op::Security(SecurityOp::CompareDependencies),
277 ],
278 ),
279 (
280 "Security settings",
281 "When pull request checks fail, dependency review's policy, delegated bypass and validity checks, and a workspace's security overview.",
282 &[
283 Op::Security(SecurityOp::GetSettings),
284 Op::Security(SecurityOp::UpdateSettings),
285 Op::Security(SecurityOp::GetWorkspaceSettings),
286 Op::Security(SecurityOp::UpdateWorkspaceSettings),
287 Op::Security(SecurityOp::GetOverview),
288 ],
289 ),
290 (
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9291 "Security advisories",
292 "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.",
293 &[
294 Op::Security(SecurityOp::ListAdvisories),
295 Op::Security(SecurityOp::CreateAdvisory),
296 Op::Security(SecurityOp::GetAdvisory),
297 Op::Security(SecurityOp::UpdateAdvisory),
298 Op::Security(SecurityOp::SetAdvisoryState),
299 Op::Security(SecurityOp::ListReports),
300 Op::Security(SecurityOp::ReportVulnerability),
301 Op::Security(SecurityOp::ReviewReport),
302 ],
303 ),
304 (
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge305 "Rules",
306 "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.",
307 &[
308 Op::Rules(RulesOp::ListRepoRulesets),
309 Op::Rules(RulesOp::CreateRepoRuleset),
310 Op::Rules(RulesOp::GetRepoRuleset),
311 Op::Rules(RulesOp::UpdateRepoRuleset),
312 Op::Rules(RulesOp::DeleteRepoRuleset),
313 Op::Rules(RulesOp::GetBranchRules),
314 Op::Rules(RulesOp::ListRuleEvaluations),
315 Op::Rules(RulesOp::ListWorkspaceRulesets),
316 Op::Rules(RulesOp::CreateWorkspaceRuleset),
317 Op::Rules(RulesOp::GetWorkspaceRuleset),
318 Op::Rules(RulesOp::UpdateWorkspaceRuleset),
319 Op::Rules(RulesOp::DeleteWorkspaceRuleset),
320 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
321 ],
322 ),
323 (
Merge checks: statuses and check runs on every commit324 "Checks",
325 "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.",
326 &[
327 Op::Checks(ChecksOp::CreateCommitStatus),
328 Op::Checks(ChecksOp::ListCommitStatuses),
329 Op::Checks(ChecksOp::GetCombinedStatus),
330 Op::Checks(ChecksOp::CreateCheckRun),
331 Op::Checks(ChecksOp::UpdateCheckRun),
332 Op::Checks(ChecksOp::GetCheckRun),
333 Op::Checks(ChecksOp::ListCheckRunAnnotations),
334 Op::Checks(ChecksOp::RerequestCheckRun),
335 Op::Checks(ChecksOp::ListCheckRunsForRef),
336 Op::Checks(ChecksOp::ListCheckSuitesForRef),
337 Op::Checks(ChecksOp::GetCheckSuite),
338 Op::Checks(ChecksOp::RerequestCheckSuite),
339 ],
340 ),
341 (
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms342 "Issues",
343 "What should change in a repository, with labels and comments. Issues and pull requests share one sequence of numbers.",
344 &[
345 Op::ListIssues,
346 Op::CreateIssue,
347 Op::GetIssue,
348 Op::UpdateIssue,
349 Op::CloseIssue,
350 Op::ReopenIssue,
351 Op::AssignIssue,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step352 Op::Delegate,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms353 Op::AddComment,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts354 Op::EditComment,
355 Op::DeleteComment,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar356 Op::ListIssueLabels,
357 Op::AddIssueLabels,
358 Op::SetIssueLabels,
359 Op::RemoveIssueLabels,
360 ],
361 ),
362 (
363 "Labels and milestones",
364 "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.",
365 &[
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms366 Op::ListLabels,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar367 Op::CreateLabel,
368 Op::UpdateLabel,
369 Op::DeleteLabel,
370 Op::AddDefaultLabels,
371 Op::ListMilestones,
372 Op::CreateMilestone,
373 Op::GetMilestone,
374 Op::UpdateMilestone,
375 Op::DeleteMilestone,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms376 ],
377 ),
378 (
379 "Plans",
380 "An outcome turned into the issues that would get there, with the order they must merge in.",
381 &[Op::PlanWork, Op::GetPlan, Op::ApplyPlan],
382 ),
383 (
384 "Pull requests",
385 "A proposed change in its own fork or on a branch. Several can be made for one issue; the one merged resolves it.",
386 &[
387 Op::ListPullRequests,
388 Op::CreatePullRequest,
389 Op::GetPullRequest,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar390 Op::UpdatePullRequest,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms391 Op::GetPullRequestChanges,
392 Op::MarkPullRequestReady,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts393 Op::ConvertPullRequestToDraft,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar394 Op::RequestReviewers,
395 Op::RemoveRequestedReviewers,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms396 Op::ReviewPullRequest,
397 Op::MergePullRequest,
398 Op::ClosePullRequest,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts399 Op::ReopenPullRequest,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms400 Op::GetMergeQueue,
401 Op::MessageAgent,
402 Op::AnswerMessage,
403 Op::TakeMessages,
404 ],
405 ),
406 (
407 "Sessions",
408 "The record of how a pull request was made: prompts, reasoning and the tools that ran.",
409 &[Op::ReadSession, Op::RecordSession],
410 ),
411 (
412 "Memory",
413 "What agents and people learned that the next agent should know, for one project or across a workspace. Members and g1t's agents only; never a secret.",
414 &[Op::Remember, Op::Recall],
415 ),
416 (
417 "Search",
418 "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.",
419 &[Op::Search],
420 ),
421 (
422 "Context",
423 "A workspace's context hub: a catalog of what it builds and runs, built from its repositories, deployments and integrations, and one search across the catalog, docs, issues, pull requests and memory.",
424 &[Op::SearchContext, Op::GetEntity],
425 ),
426 (
427 "Actions",
428 "GitHub Actions workflows in .g1t/workflows, their runs, and their jobs' logs.",
429 &[
430 Op::ListWorkflows,
431 Op::ListWorkflowRuns,
432 Op::GetWorkflowRun,
433 Op::GetJobLogs,
434 Op::DispatchWorkflow,
435 Op::CancelWorkflowRun,
436 Op::RerunWorkflowRun,
437 Op::UpdateWorkflow,
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2438 Op::Artifacts(ArtifactsOp::ListArtifacts),
439 Op::Artifacts(ArtifactsOp::ListRunArtifacts),
440 Op::Artifacts(ArtifactsOp::GetArtifact),
441 Op::Artifacts(ArtifactsOp::DownloadArtifact),
442 Op::Artifacts(ArtifactsOp::DeleteArtifact),
443 Op::Artifacts(ArtifactsOp::GetArtifactRetention),
444 Op::Artifacts(ArtifactsOp::SetArtifactRetention),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms445 ],
446 ),
447 (
Merge packages: roles, Actions access, source label, soft delete, API448 "Packages",
449 "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.",
450 &[
451 Op::Packages(PackagesOp::ListPackages),
452 Op::Packages(PackagesOp::GetPackage),
453 Op::Packages(PackagesOp::UpdatePackage),
454 Op::Packages(PackagesOp::DeletePackage),
455 Op::Packages(PackagesOp::RestorePackage),
456 Op::Packages(PackagesOp::ListVersions),
457 Op::Packages(PackagesOp::GetVersion),
458 Op::Packages(PackagesOp::DeleteVersion),
459 Op::Packages(PackagesOp::RestoreVersion),
460 Op::Packages(PackagesOp::LinkPackage),
461 Op::Packages(PackagesOp::UnlinkPackage),
462 Op::Packages(PackagesOp::ListAccess),
463 Op::Packages(PackagesOp::SetAccess),
464 Op::Packages(PackagesOp::RemoveAccess),
465 Op::Packages(PackagesOp::ListActionsAccess),
466 Op::Packages(PackagesOp::SetActionsAccess),
467 Op::Packages(PackagesOp::RemoveActionsAccess),
468 ],
469 ),
470 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97471 "Deployments",
472 "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.",
473 &[
474 Op::Deployments(DeploymentsOp::ListDeployments),
475 Op::Deployments(DeploymentsOp::CreateDeployment),
476 Op::Deployments(DeploymentsOp::GetDeployment),
477 Op::Deployments(DeploymentsOp::ListDeploymentStatuses),
478 Op::Deployments(DeploymentsOp::CreateDeploymentStatus),
479 Op::Deployments(DeploymentsOp::ListEnvironments),
480 Op::Deployments(DeploymentsOp::GetEnvironment),
Merge branch 'worktree-agent-a4d35ee70c50683d0' into claude/cool-newton-7nm8r9481 Op::Deployments(DeploymentsOp::StartDeploymentBuild),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97482 ],
483 ),
484 (
Merge branch 'worktree-agent-a3abfcce648e87dca'485 "Run protection",
486 "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.",
487 &[
488 Op::Protection(ProtectionOp::UpdateEnvironment),
489 Op::Protection(ProtectionOp::DeleteEnvironment),
490 Op::Protection(ProtectionOp::GetPendingDeployments),
491 Op::Protection(ProtectionOp::ReviewPendingDeployments),
492 Op::Protection(ProtectionOp::ApproveWorkflowRun),
493 Op::Protection(ProtectionOp::GetWorkflowPermissions),
494 Op::Protection(ProtectionOp::SetWorkflowPermissions),
495 Op::Protection(ProtectionOp::GetForkPrApproval),
496 Op::Protection(ProtectionOp::SetForkPrApproval),
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts497 Op::Protection(ProtectionOp::GetActionsAccess),
498 Op::Protection(ProtectionOp::SetActionsAccess),
Merge branch 'worktree-agent-a3abfcce648e87dca'499 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
500 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
501 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
502 ],
503 ),
504 (
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms505 "Secrets and variables",
506 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
507 &[
508 Op::ListActionsSecrets,
509 Op::SetActionsSecret,
510 Op::DeleteActionsSecret,
511 Op::ListActionsVariables,
512 Op::SetActionsVariable,
513 Op::DeleteActionsVariable,
514 ],
515 ),
516 (
Fast pages, required checks on the branch, self-hosted runners, honest incidents517 "Runners",
518 "Self-hosted runners: your own machines, which run your workflow jobs (and, if you choose, your agents' work) for $0 of g1t compute. They register with a short-lived token and only ever connect out.",
519 &[
520 Op::ListRunners,
521 Op::CreateRunnerRegistrationToken,
522 Op::RemoveRunner,
523 Op::ListRunnerGroups,
524 Op::CreateRunnerGroup,
525 Op::UpdateRunnerGroup,
526 Op::DeleteRunnerGroup,
527 Op::GetRunnerSettings,
528 Op::UpdateRunnerSettings,
529 ],
530 ),
531 (
Every agent can have its own computer. A session that needs one wakes it: a home of its own on g1t cloud, one per agent and never shared, where it runs commands, reads and writes files and keeps what it made, with each session working in its own folder under a shared home; after ten idle minutes it sleeps, its home kept as a snapshot and restored when it wakes, and Reset wipes the home while memory and artifacts stay. Its shell and files are abilities with the usual choices, Alone, Alone when asked, Ask first or Never, offered only inside sessions and never to a chat reply; every command shows on the session with its output, and the agent's new Computer tab shows the state, the disk used of the five gigabytes included, the recent commands, and Wake, Put to sleep and Reset. Machine time counts only while it is awake, on the sandbox lines of the ledger that name the agent and who asked, held to the same spend caps as the session; the disk itself costs nothing in this version. The runner gained a long-lived supervisor that answers the computer's requests inside the container, and the runner service a computer per agent that keeps its snapshot in the agent homes bucket when one is attached, and says so when none is. The REST API and the agent tool can read a computer, wake it, put it to sleep and reset it. The agents, abilities, sessions, runners, billing and deploy guides say how it works and what an operator sets up; pinning a computer to your own runner, its browser and take-over come next.532 "Agents' computers",
533 "Each workspace agent has a computer of its own on g1t cloud: a persistent home its sessions run commands on, which sleeps when idle and is saved as it was. Its state and recent commands, and waking, sleeping and resetting it.",
534 &[
535 Op::GetAgentComputer,
536 Op::WakeAgentComputer,
537 Op::SleepAgentComputer,
538 Op::ResetAgentComputer,
539 Op::ListAgentComputerCommands,
540 ],
541 ),
542 (
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms543 "Webhooks",
544 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
545 &[
546 Op::ListWebhooks,
547 Op::CreateWebhook,
548 Op::UpdateWebhook,
549 Op::DeleteWebhook,
550 Op::PingWebhook,
551 Op::ListWebhookDeliveries,
552 Op::RedeliverWebhook,
553 ],
554 ),
555 (
556 "Integrations",
557 "A workspace's connections to outside systems: model providers, alert sources and issue trackers.",
558 &[
559 Op::ListIntegrations,
560 Op::ConnectIntegration,
AI Gateway: OpenAI's format, open models, and your own providers561 Op::UpdateIntegration,
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms562 Op::DisconnectIntegration,
563 Op::TestIntegration,
564 Op::GetModelRoutes,
565 Op::SetModelRoutes,
566 Op::GetContext,
567 Op::ImportIssue,
568 ],
569 ),
Merge main into Artifacts Phase 2570 (
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9571 "Customize",
572 "What shapes how a workspace's agents work, in the formats Claude Code reads: the marketplaces it reads plugins from, what Discover lists, the plugins it installed (their skills, subagents and remote MCP servers reach g1t's agents; the rest reaches Claude Code on a runner), and its connectors: MCP servers connected once, then given to every agent, a team or one agent. The bundle is what a job's Claude Code loads on a runner.",
573 &[
574 Op::Customize(CustomizeOp::ListMarketplaces),
575 Op::Customize(CustomizeOp::AddMarketplace),
576 Op::Customize(CustomizeOp::RemoveMarketplace),
577 Op::Customize(CustomizeOp::RefreshMarketplace),
578 Op::Customize(CustomizeOp::Discover),
579 Op::Customize(CustomizeOp::ListPlugins),
580 Op::Customize(CustomizeOp::GetPlugin),
581 Op::Customize(CustomizeOp::InstallPlugin),
582 Op::Customize(CustomizeOp::SetPluginEnabled),
583 Op::Customize(CustomizeOp::UninstallPlugin),
584 Op::Customize(CustomizeOp::UpdatePlugin),
585 Op::Customize(CustomizeOp::ListPluginAgents),
586 Op::Customize(CustomizeOp::ListConnectors),
587 Op::Customize(CustomizeOp::GetConnector),
588 Op::Customize(CustomizeOp::AddConnector),
589 Op::Customize(CustomizeOp::SetConnectorKey),
590 Op::Customize(CustomizeOp::RemoveConnector),
591 Op::Customize(CustomizeOp::RefreshConnector),
592 Op::Customize(CustomizeOp::GrantConnector),
593 Op::Customize(CustomizeOp::RevokeConnector),
594 Op::Customize(CustomizeOp::Bundle),
595 ],
596 ),
597 (
Merge main into Artifacts Phase 2598 "Artifacts",
599 "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.",
600 &[
601 Op::Folios(FoliosOp::List),
602 Op::Folios(FoliosOp::Search),
603 Op::Folios(FoliosOp::Get),
604 Op::Folios(FoliosOp::GetContent),
605 Op::Folios(FoliosOp::ListVersions),
606 Op::Folios(FoliosOp::GetAccess),
607 Op::Folios(FoliosOp::ListTemplates),
608 Op::Folios(FoliosOp::ListSpaces),
609 Op::Folios(FoliosOp::QueryDataset),
610 Op::Folios(FoliosOp::Create),
611 Op::Folios(FoliosOp::Update),
612 Op::Folios(FoliosOp::Edit),
613 Op::Folios(FoliosOp::Trash),
614 Op::Folios(FoliosOp::Restore),
615 Op::Folios(FoliosOp::RestoreVersion),
616 Op::Folios(FoliosOp::SetAccess),
617 Op::Folios(FoliosOp::Purge),
618 ],
619 ),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms620];
621
622/// The section of the API reference an operation is listed under.
623fn tag(op: Op) -> &'static str {
624 SECTIONS
625 .iter()
626 .find(|(_, _, ops)| ops.contains(&op))
627 .map_or("Repositories", |(name, _, _)| name)
628}
629
630/// What an operation's page is called, as a short sentence.
631fn title(op: Op) -> &'static str {
632 match op {
633 Op::Whoami => "Get the current user",
Merge branch 'worktree-agent-ad7c6d88d93adc817'634 Op::GetWorkspace => "Get a workspace",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms635 Op::CreateWorkspace => "Create a workspace",
636 Op::DeleteWorkspace => "Delete a workspace",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily637 Op::UpdateWorkspace => "Update a workspace",
Merge main (membership, two-factor, GitHub repo roles) into tokens638 Op::ListMembers => "List a workspace's members",
639 Op::UpdateMember => "Change a member's role",
640 Op::RemoveMember => "Remove a member",
641 Op::TransferOwnership => "Transfer a workspace's ownership",
642 Op::LeaveWorkspace => "Leave a workspace",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms643 Op::ListEmails => "List your email addresses",
644 Op::AddEmail => "Add an email address",
Merge email confirmation gate: a code and a link, nothing until confirmed (identity 0036)645 Op::ConfirmEmail => "Confirm an email address",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms646 Op::RemoveEmail => "Remove an email address",
647 Op::UpdateEmailSettings => "Change your email settings",
648 Op::ListInvites => "List your invites",
649 Op::CreateInvite => "Create an invite",
650 Op::RevokeInvite => "Revoke an invite",
651 Op::ListWorkspaceInvites => "List a workspace's invites",
652 Op::InviteMember => "Invite someone to a workspace",
Merge workspace invitations: nobody joins a workspace without saying yes, people are found by username, your own invites can bring someone in, and nobody is left without a workspace (identity 0040)653 Op::ListInvitations => "List your workspace invitations",
654 Op::AcceptInvitation => "Accept a workspace invitation",
655 Op::DeclineInvitation => "Decline a workspace invitation",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms656 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
657 Op::TransferRepo => "Transfer a repository",
658 Op::RenameRepo => "Rename a repository",
659 Op::RenameBranch => "Rename a branch",
660 Op::ArchiveRepo => "Archive a repository",
661 Op::UnarchiveRepo => "Unarchive a repository",
662 Op::SetRepoVisibility => "Change a repository's visibility",
663 Op::DeleteRepo => "Delete a repository",
664 Op::ListDeletedRepos => "List recently deleted repositories",
665 Op::RestoreRepo => "Restore a deleted repository",
666 Op::PurgeRepo => "Purge a deleted repository",
667 Op::ListRepos => "List repositories",
668 Op::GetRepo => "Get a repository",
669 Op::CreateRepo => "Create a repository",
670 Op::UpdateRepo => "Update a repository",
671 Op::GetRepoSettings => "Get repository settings",
672 Op::UpdateRepoSettings => "Update repository settings",
Fast pages, required checks on the branch, self-hosted runners, honest incidents673 Op::ListCheckNames => "List check names",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms674 Op::GetMergeQueue => "Get the merge queue",
675 Op::MessageAgent => "Message an agent",
676 Op::AnswerMessage => "Answer a message",
677 Op::TakeMessages => "Take new messages",
678 Op::Remember => "Remember something",
679 Op::Recall => "Recall memory",
680 Op::SearchContext => "Search the context hub",
681 Op::GetEntity => "Get a catalog entry",
682 Op::Search => "Search g1t",
683 Op::ListIssues => "List issues",
684 Op::GetIssue => "Get an issue",
685 Op::CreateIssue => "Create an issue",
686 Op::UpdateIssue => "Update an issue",
687 Op::CloseIssue => "Close an issue",
688 Op::ReopenIssue => "Reopen an issue",
g1t is one name: its agent's work, commits and comments show as @g1t, and nobody can claim g1t or g1t-agent689 Op::AssignIssue => "Assign an issue to g1t",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step690 Op::Delegate => "Put an agent on it",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms691 Op::PlanWork => "Plan work",
692 Op::GetPlan => "Get a plan",
693 Op::ApplyPlan => "Apply a plan",
694 Op::ListLabels => "List labels",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar695 Op::CreateLabel => "Create a label",
696 Op::UpdateLabel => "Update a label",
697 Op::DeleteLabel => "Delete a label",
698 Op::AddDefaultLabels => "Add the default labels",
699 Op::ListIssueLabels => "List an issue's labels",
700 Op::AddIssueLabels => "Add labels to an issue",
701 Op::SetIssueLabels => "Set an issue's labels",
702 Op::RemoveIssueLabels => "Remove labels from an issue",
703 Op::ListMilestones => "List milestones",
704 Op::GetMilestone => "Get a milestone",
705 Op::CreateMilestone => "Create a milestone",
706 Op::UpdateMilestone => "Update a milestone",
707 Op::DeleteMilestone => "Delete a milestone",
708 Op::UpdatePullRequest => "Update a pull request",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms709 Op::AddComment => "Add a comment",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts710 Op::EditComment => "Edit a comment",
711 Op::DeleteComment => "Delete a comment",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms712 Op::ReviewPullRequest => "Review a pull request",
713 Op::ListPullRequests => "List pull requests",
714 Op::GetPullRequest => "Get a pull request",
715 Op::CreatePullRequest => "Create a pull request",
716 Op::RecordSession => "Record session entries",
717 Op::ReadSession => "Read a session",
718 Op::MarkPullRequestReady => "Mark a pull request ready",
719 Op::ClosePullRequest => "Close a pull request",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts720 Op::ReopenPullRequest => "Reopen a pull request",
721 Op::ConvertPullRequestToDraft => "Convert a pull request to a draft",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms722 Op::GetPullRequestChanges => "Get a pull request's changes",
723 Op::MergePullRequest => "Merge a pull request",
724 Op::ListEvents => "List repository events",
725 Op::ListIntegrations => "List integrations",
726 Op::ConnectIntegration => "Connect an integration",
AI Gateway: OpenAI's format, open models, and your own providers727 Op::UpdateIntegration => "Update an integration",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms728 Op::DisconnectIntegration => "Disconnect an integration",
729 Op::TestIntegration => "Test an integration",
730 Op::GetContext => "Look up a ticket",
731 Op::ImportIssue => "Import an issue",
732 Op::GetModelRoutes => "Get model routes",
733 Op::SetModelRoutes => "Set model routes",
734 Op::ListWebhooks => "List webhooks",
735 Op::CreateWebhook => "Create a webhook",
736 Op::UpdateWebhook => "Update a webhook",
737 Op::DeleteWebhook => "Delete a webhook",
738 Op::PingWebhook => "Ping a webhook",
739 Op::ListWebhookDeliveries => "List webhook deliveries",
740 Op::RedeliverWebhook => "Redeliver a webhook delivery",
741 Op::ListWorkflows => "List workflows",
742 Op::ListWorkflowRuns => "List workflow runs",
743 Op::GetWorkflowRun => "Get a workflow run",
744 Op::GetJobLogs => "Get a job's log",
745 Op::DispatchWorkflow => "Run a workflow",
746 Op::CancelWorkflowRun => "Cancel a workflow run",
747 Op::RerunWorkflowRun => "Re-run a workflow run",
748 Op::UpdateWorkflow => "Turn a workflow on or off",
749 Op::ListActionsSecrets => "List secrets",
750 Op::SetActionsSecret => "Set a secret",
751 Op::DeleteActionsSecret => "Delete a secret",
752 Op::ListActionsVariables => "List variables",
753 Op::SetActionsVariable => "Set a variable",
754 Op::DeleteActionsVariable => "Delete a variable",
Fast pages, required checks on the branch, self-hosted runners, honest incidents755 Op::ListRunners => "List self-hosted runners",
756 Op::ListRunnerGroups => "List runner groups",
Every agent can have its own computer. A session that needs one wakes it: a home of its own on g1t cloud, one per agent and never shared, where it runs commands, reads and writes files and keeps what it made, with each session working in its own folder under a shared home; after ten idle minutes it sleeps, its home kept as a snapshot and restored when it wakes, and Reset wipes the home while memory and artifacts stay. Its shell and files are abilities with the usual choices, Alone, Alone when asked, Ask first or Never, offered only inside sessions and never to a chat reply; every command shows on the session with its output, and the agent's new Computer tab shows the state, the disk used of the five gigabytes included, the recent commands, and Wake, Put to sleep and Reset. Machine time counts only while it is awake, on the sandbox lines of the ledger that name the agent and who asked, held to the same spend caps as the session; the disk itself costs nothing in this version. The runner gained a long-lived supervisor that answers the computer's requests inside the container, and the runner service a computer per agent that keeps its snapshot in the agent homes bucket when one is attached, and says so when none is. The REST API and the agent tool can read a computer, wake it, put it to sleep and reset it. The agents, abilities, sessions, runners, billing and deploy guides say how it works and what an operator sets up; pinning a computer to your own runner, its browser and take-over come next.757 Op::GetAgentComputer => "Get an agent's computer",
758 Op::WakeAgentComputer => "Wake an agent's computer",
759 Op::SleepAgentComputer => "Put an agent's computer to sleep",
760 Op::ResetAgentComputer => "Reset an agent's computer",
761 Op::ListAgentComputerCommands => "List an agent's computer's commands",
Fast pages, required checks on the branch, self-hosted runners, honest incidents762 Op::GetRunnerSettings => "Get runner settings",
763 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
764 Op::RemoveRunner => "Remove a self-hosted runner",
765 Op::CreateRunnerGroup => "Create a runner group",
766 Op::UpdateRunnerGroup => "Change a runner group",
767 Op::DeleteRunnerGroup => "Delete a runner group",
768 Op::UpdateRunnerSettings => "Change runner settings",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms769 Op::ListCollaborators => "List who has access",
770 Op::AddCollaborator => "Add a collaborator",
771 Op::UpdateCollaborator => "Change a collaborator's role",
772 Op::RemoveCollaborator => "Remove a collaborator",
773 Op::GetCollaboratorPermission => "Get someone's permission",
774 Op::ListRepoInvitations => "List a repository's invitations",
775 Op::RevokeRepoInvitation => "Revoke a repository invitation",
776 Op::ListMyRepoInvitations => "List your repository invitations",
777 Op::AcceptRepoInvitation => "Accept a repository invitation",
778 Op::DeclineRepoInvitation => "Decline a repository invitation",
779 Op::SetBasePermission => "Set the base permission",
780 Op::ListOutsideCollaborators => "List outside collaborators",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily781 Op::ListSecurityAlerts => "List security alerts",
782 Op::DismissSecurityAlert => "Dismiss a security alert",
783 Op::ReopenSecurityAlert => "Reopen a security alert",
API: notifications over REST and MCP, with notifications scopes784 Op::ListNotifications => "List notifications",
785 Op::MarkNotificationsRead => "Mark notifications read",
786 Op::GetNotificationThread => "Get a thread",
787 Op::MarkThreadRead => "Mark a thread read",
788 Op::MarkThreadDone => "Mark a thread done",
789 Op::SaveThread => "Save a thread",
790 Op::SnoozeThread => "Snooze a thread",
791 Op::GetThreadSubscription => "Get a thread subscription",
792 Op::SetThreadSubscription => "Set a thread subscription",
793 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
794 Op::GetRepoSubscription => "Get how you watch a repository",
795 Op::SetRepoSubscription => "Watch a repository",
796 Op::DeleteRepoSubscription => "Stop watching a repository",
797 Op::ListWatchedRepos => "List repositories you watch",
API: pinned projects over REST and MCP798 Op::ListPinnedProjects => "List your pinned projects",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit799 Op::GetUsage => "Get a workspace's usage",
800 Op::GetBudget => "Get a workspace's budget",
801 Op::SetBudget => "Change a workspace's budget",
802 Op::GetAiCredit => "Get a workspace's AI credit",
803 Op::BuyAiCredit => "Buy AI credit",
804 Op::ListInvoices => "List a workspace's invoices",
805 Op::GetBillingDetails => "Get a workspace's billing details",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens806 Op::ListGatewayRequests => "List a workspace's AI Gateway requests",
API: pinned projects over REST and MCP807 Op::PinProject => "Pin a project",
808 Op::UnpinProject => "Unpin a project",
809 Op::ReorderPinnedProjects => "Reorder your pinned projects",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97810 Op::ListProjects => "List a workspace's projects",
811 Op::GetProject => "Get a project",
812 Op::UpdateProject => "Update a project",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar813 Op::ListTeams => "List teams",
814 Op::GetTeam => "Get a team",
815 Op::CreateTeam => "Create a team",
816 Op::UpdateTeam => "Update a team",
817 Op::DeleteTeam => "Delete a team",
818 Op::ListTeamMembers => "List a team's members",
819 Op::SetTeamMember => "Add or change a team member",
820 Op::RemoveTeamMember => "Remove a team member",
821 Op::ListChildTeams => "List child teams",
822 Op::ListTeamRepos => "List a team's repositories",
823 Op::SetTeamRepo => "Give a team a role on a repository",
824 Op::RemoveTeamRepo => "Remove a team from a repository",
825 Op::SetTeamReviewAssignment => "Set a team's review assignment",
826 Op::ListUserTeams => "List someone's teams",
827 Op::RequestReviewers => "Request reviewers",
828 Op::RemoveRequestedReviewers => "Remove requested reviewers",
829 Op::GetCodeownersErrors => "List CODEOWNERS errors",
830 Op::Security(op) => op.title(),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge831 Op::Rules(op) => op.title(),
Merge checks: statuses and check runs on every commit832 Op::Checks(op) => op.title(),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97833 Op::About(op) => op.title(),
834 Op::Deployments(op) => op.title(),
Merge branch 'worktree-agent-a3abfcce648e87dca'835 Op::Protection(op) => op.title(),
API and MCP for a workspace's personal access token rules, members' tokens and approvals836 Op::Tokens(op) => op.title(),
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2837 Op::Artifacts(op) => op.title(),
Merge branch 'worktree-agent-a19b06d959c105bf7' into claude/cool-newton-7nm8r9838 Op::Archives(op) => op.title(),
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca839 Op::DeployKeys(op) => op.title(),
Merge branch 'mirroring' into artifacts-mode840 Op::Mirrors(op) => op.title(),
Merge packages: roles, Actions access, source label, soft delete, API841 Op::Packages(op) => op.title(),
Merge main into Artifacts Phase 2842 Op::Folios(op) => op.title(),
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9843 Op::Customize(op) => op.title(),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms844 }
845}
846
847/// Why an operation can be refused with `402 payment_required`, if it
848/// can: the ones that start an agent, when the workspace has no credit,
849/// and the ones that make a repository private in a workspace, when a free
850/// workspace's private storage has no room for it.
851fn may_need_payment(op: Op) -> Option<&'static str> {
852 match op {
853 Op::AssignIssue | Op::PlanWork | Op::ApplyPlan => Some("The workspace has no agent credit."),
Every agent can have its own computer. A session that needs one wakes it: a home of its own on g1t cloud, one per agent and never shared, where it runs commands, reads and writes files and keeps what it made, with each session working in its own folder under a shared home; after ten idle minutes it sleeps, its home kept as a snapshot and restored when it wakes, and Reset wipes the home while memory and artifacts stay. Its shell and files are abilities with the usual choices, Alone, Alone when asked, Ask first or Never, offered only inside sessions and never to a chat reply; every command shows on the session with its output, and the agent's new Computer tab shows the state, the disk used of the five gigabytes included, the recent commands, and Wake, Put to sleep and Reset. Machine time counts only while it is awake, on the sandbox lines of the ledger that name the agent and who asked, held to the same spend caps as the session; the disk itself costs nothing in this version. The runner gained a long-lived supervisor that answers the computer's requests inside the container, and the runner service a computer per agent that keeps its snapshot in the agent homes bucket when one is attached, and says so when none is. The REST API and the agent tool can read a computer, wake it, put it to sleep and reset it. The agents, abilities, sessions, runners, billing and deploy guides say how it works and what an operator sets up; pinning a computer to your own runner, its browser and take-over come next.854 Op::WakeAgentComputer => Some("The workspace's plan refuses compute: it is paused, or over its limit."),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms855 Op::UpdateRepo | Op::SetRepoVisibility | Op::TransferRepo => Some(
856 "A free workspace's private storage has no room for this private repository.",
857 ),
858 _ => None,
859 }
860}
861
862/// What the reference says beyond each operation's own description, keyed
863/// by operation id, written by hand from what the services return: `notes`
864/// (Markdown, added to the description) and example `params` (path),
865/// `query`, `request` (body) and `response`.
866const REFERENCE: &str = include_str!("reference.json");
867
868fn examples() -> Map<String, Value> {
869 match serde_json::from_str(REFERENCE) {
870 Ok(Value::Object(examples)) => examples,
871 _ => Map::new(),
872 }
873}
874
875/// `/repos/:owner/:name` as OpenAPI writes it: `/repos/{owner}/{name}`.
876fn openapi_path(route: &Route) -> String {
877 route
878 .path
879 .split('/')
880 .map(|segment| match segment.strip_prefix(':') {
881 Some(name) => format!("{{{name}}}"),
882 None => segment.to_owned(),
883 })
884 .collect::<Vec<_>>()
885 .join("/")
886}
887
888fn error_response(description: &str) -> Value {
889 json!({
890 "description": description,
891 "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } },
892 })
893}
894
895/// A parameter in the path or the query, described by the operation's
896/// input schema where it has the same name.
897fn parameter(name: &str, place: &str, required: bool, schema: Option<&Value>) -> Value {
898 let mut schema = schema.cloned().unwrap_or_else(|| json!({ "type": "string" }));
899 let description = match name {
900 "owner" => Some(Value::from("The workspace that owns the repository.")),
901 "name" => Some(Value::from("The repository's name.")),
902 _ => schema.as_object_mut().and_then(|schema| schema.remove("description")),
903 };
904 let mut parameter = json!({
905 "name": name,
906 "in": place,
907 "required": required,
908 "schema": schema,
909 });
910 if let Some(description) = description {
911 parameter["description"] = description;
912 }
913 parameter
914}
915
916/// The operation id of a route. An operation reached at a workspace's
917/// address as well as a repository's is documented once for each, with its
918/// own id; GitHub's alternative addresses for one operation keep GitHub's
919/// names.
920fn operation_id(route: &Route) -> String {
921 let op = route.op;
922 let base = match (route.method, route.path.rsplit('/').next().unwrap_or_default()) {
923 ("PUT", "enable") => "enable_workflow".to_owned(),
924 ("PUT", "disable") => "disable_workflow".to_owned(),
925 ("POST", "rerun-failed-jobs") => "rerun_failed_jobs".to_owned(),
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)926 ("POST", "rerun") if route.path.contains("/jobs/:job/") => "rerun_job".to_owned(),
927 ("POST", "force-cancel") => "force_cancel_workflow_run".to_owned(),
928 ("GET", ":attempt") => "get_workflow_run_attempt".to_owned(),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms929 ("PATCH", ":setting") => "update_actions_variable".to_owned(),
930 ("GET", "runs") if route.path.contains("/workflows/:workflow/") => "list_runs_of_workflow".to_owned(),
API: notifications over REST and MCP, with notifications scopes931 // One repository's notifications, and an issue's subscription by
932 // its number rather than a thread's id.
933 (_, "notifications") if route.path.starts_with("/repos/") => match op {
934 Op::ListNotifications => "list_repo_notifications".to_owned(),
935 _ => "mark_repo_notifications_read".to_owned(),
936 },
937 (method, "subscription") if route.path.contains("/issues/:number/") => match method {
938 "GET" => "get_issue_subscription".to_owned(),
939 "PUT" => "set_issue_subscription".to_owned(),
940 _ => "delete_issue_subscription".to_owned(),
941 },
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar942 // One label off an issue, by its name in the path.
943 ("DELETE", ":label") if route.path.contains("/issues/:number/") => "remove_issue_label".to_owned(),
API: notifications over REST and MCP, with notifications scopes944 ("DELETE", "saved") => "unsave_thread".to_owned(),
945 ("DELETE", "snooze") => "unsnooze_thread".to_owned(),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms946 _ => op.name().to_owned(),
947 };
948 if route.path.starts_with("/workspaces/") && ROUTES.iter().any(|other| other.op == op && other.path.starts_with("/repos/")) {
949 format!("{base}_for_workspace")
950 } else {
951 base
952 }
953}
954
955/// The summary of a route: its operation's title, or for one of GitHub's
956/// alternative addresses, what that address does.
957fn summary(route: &Route, id: &str) -> String {
958 let base = match id.trim_end_matches("_for_workspace") {
959 "enable_workflow" => "Turn a workflow on",
960 "disable_workflow" => "Turn a workflow off",
961 "rerun_failed_jobs" => "Re-run failed jobs",
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)962 "rerun_job" => "Re-run a job",
963 "force_cancel_workflow_run" => "Force-cancel a workflow run",
964 "get_workflow_run_attempt" => "Get a workflow run attempt",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms965 "update_actions_variable" => "Update a variable",
966 "list_runs_of_workflow" => "List a workflow's runs",
API: notifications over REST and MCP, with notifications scopes967 "list_repo_notifications" => "List a repository's notifications",
968 "mark_repo_notifications_read" => "Mark a repository's notifications read",
969 "get_issue_subscription" => "Get your subscription to an issue",
970 "set_issue_subscription" => "Subscribe to an issue",
971 "delete_issue_subscription" => "Unsubscribe from an issue",
972 "unsave_thread" => "Unsave a thread",
973 "unsnooze_thread" => "Bring a snoozed thread back",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms974 _ => title(route.op),
975 };
976 if id.ends_with("_for_workspace") {
977 format!("{base} for a workspace")
978 } else {
979 base.to_owned()
980 }
981}
982
983fn operation(route: &Route) -> Value {
984 let op = route.op;
985 let path_params: Vec<&str> = route.params().collect();
Merge checks: statuses and check runs on every commit986 // `owner` and `name` in the path stand for the operation's `repo` input,
987 // so a `name` in the body, such as a check run's, is the body's own.
988 let stands_for_repo =
989 |name: &str| matches!(name, "owner" | "name") && path_params.contains(&"owner") && path_params.contains(&"name");
990 let covered = |name: &str| name == "repo" || (path_params.contains(&name) && !stands_for_repo(name));
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms991 let all_properties = op.properties();
992 let mut properties = all_properties.clone();
993 properties.retain(|name, _| !covered(name));
994 let required: Vec<String> = op
995 .required()
996 .into_iter()
997 .filter(|name| !covered(name))
998 .collect();
999
1000 let mut parameters: Vec<Value> = path_params
1001 .iter()
Merge checks: statuses and check runs on every commit1002 .map(|name| parameter(name, "path", true, if stands_for_repo(name) { None } else { all_properties.get(*name) }))
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1003 .collect();
1004 let mut body = Value::Null;
1005 if route.method == "GET" {
1006 for (name, key) in route.query {
1007 parameters.push(parameter(
1008 name,
1009 "query",
1010 required.iter().any(|required| required == key),
1011 properties.get(*key),
1012 ));
1013 }
1014 } else if !properties.is_empty() {
1015 let mut schema = json!({ "type": "object", "properties": properties });
1016 if !required.is_empty() {
1017 schema["required"] = json!(required);
1018 }
1019 body = json!({
1020 "required": !required.is_empty(),
1021 "content": { "application/json": { "schema": schema } },
1022 });
1023 }
1024
1025 let id = operation_id(route);
1026 let mut responses = Map::new();
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1027 if route.no_content() {
1028 responses.insert("204".into(), json!({ "description": "Success. There is no body." }));
1029 } else {
1030 responses.insert(
1031 "200".into(),
1032 json!({
1033 "description": "Success.",
1034 "content": { "application/json": { "schema": {} } },
1035 }),
1036 );
1037 }
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1038 responses.insert(
1039 "401".into(),
1040 error_response("A token is required, or the one sent is not valid."),
1041 );
1042 if let Some(reason) = may_need_payment(op) {
1043 responses.insert("402".into(), error_response(reason));
1044 }
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1045 responses.insert(
1046 "403".into(),
1047 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."),
1048 );
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1049 if !matches!(op, Op::Whoami | Op::ListRepos | Op::Search) {
1050 responses.insert("404".into(), error_response("It does not exist, or you cannot see it."));
1051 }
1052 if route.method != "GET" {
1053 responses.insert(
1054 "409".into(),
1055 error_response("The request conflicts with the current state."),
1056 );
1057 }
1058 if op != Op::Whoami {
1059 responses.insert("422".into(), error_response("The input is not valid."));
1060 }
1061 // Public data can be read without a token; everything else needs one.
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1062 let scope: Vec<&str> = scope_for(op.name()).map(|scope| scope.as_str()).into_iter().collect();
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1063 let security = if op.needs_user() {
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1064 json!([{ "token": scope }])
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1065 } else {
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1066 json!([{ "token": scope }, {}])
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1067 };
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1068 let (tool, action) = crate::tools::TOOLS
1069 .iter()
1070 .find_map(|tool| {
1071 tool.actions
1072 .iter()
1073 .find(|action| action.op == op)
1074 .map(|action| (tool.name, action.name))
1075 })
1076 .unwrap_or_default();
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1077 let mut described = json!({
1078 "operationId": id,
1079 "tags": [tag(op)],
1080 "summary": summary(route, &id),
1081 "description": op.description(),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1082 "x-operation": op.name(),
1083 "x-mcp-tool": tool,
1084 "x-mcp-action": action,
1085 "x-scope": scope.first().copied(),
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1086 "security": security,
1087 "parameters": parameters,
1088 "responses": responses,
1089 });
1090 if !body.is_null() {
1091 described["requestBody"] = body;
1092 }
1093 described
1094}
1095
1096/// Entries for device sign-in, which is not an operation.
1097fn onboarding() -> Map<String, Value> {
1098 let paths = json!({
1099 "/device/code": {
1100 "post": {
1101 "operationId": "device_code",
1102 "tags": ["Accounts"],
1103 "summary": "Start signing in",
1104 "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`.",
1105 "security": [],
1106 "requestBody": {
1107 "content": { "application/json": { "schema": {
1108 "type": "object",
1109 "properties": {
1110 "client_name": {
1111 "type": "string",
1112 "description": "What is asking, shown to the person approving. For example, Claude Code.",
1113 },
1114 },
1115 } } },
1116 },
1117 "responses": { "200": {
1118 "description": "The codes for this sign-in.",
1119 "content": { "application/json": { "schema": {
1120 "type": "object",
1121 "properties": {
1122 "device_code": { "type": "string", "description": "Secret. Send it to /device/token." },
1123 "user_code": { "type": "string", "description": "Shown to the person, like WDJB-MJHT." },
1124 "verification_uri": { "type": "string" },
1125 "verification_uri_complete": {
1126 "type": "string",
1127 "description": "The link to give the person; it carries the code.",
1128 },
1129 "expires_in": { "type": "integer", "description": "Seconds until the codes expire." },
1130 "interval": { "type": "integer", "description": "Seconds to wait between polls." },
1131 },
1132 } } },
1133 } },
1134 },
1135 },
1136 "/device/token": {
1137 "post": {
1138 "operationId": "device_token",
1139 "tags": ["Accounts"],
1140 "summary": "Finish signing in",
1141 "description": "Asks whether the person has approved. Poll no faster than the interval. The token is returned once.",
1142 "security": [],
1143 "requestBody": {
1144 "required": true,
1145 "content": { "application/json": { "schema": {
1146 "type": "object",
1147 "required": ["device_code"],
1148 "properties": { "device_code": { "type": "string" } },
1149 } } },
1150 },
1151 "responses": { "200": {
1152 "description": "The state of the sign-in.",
1153 "content": { "application/json": { "schema": {
1154 "type": "object",
1155 "required": ["status"],
1156 "properties": {
1157 "status": { "type": "string", "enum": ["pending", "approved", "denied", "expired"] },
1158 "token": { "type": "string", "description": "Present when approved." },
Cards you act on in chat; agents comment and review as themselves; names shown cleanly; commits on the calendar1159 "username": { "type": "string", "description": "Lowercased: what the account is found and linked by." },
1160 "display_username": { "type": "string", "description": "The username as its owner wrote it; the same as username when they chose no case." },
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1161 "verified": {
1162 "type": "boolean",
1163 "description": "Whether the account's email is confirmed.",
1164 },
1165 },
1166 } } },
1167 } },
1168 },
1169 },
1170 });
1171 match paths {
1172 Value::Object(paths) => paths,
1173 _ => Map::new(),
1174 }
1175}
1176
1177
1178/// Puts each operation's examples, where it has them, into its request
1179/// and response. Path and query values go under `x-example-params` and
1180/// `x-example-query`, which tools that build a request can use.
1181fn attach_examples(paths: &mut Map<String, Value>) {
1182 let examples = examples();
1183 for methods in paths.values_mut() {
1184 let Some(methods) = methods.as_object_mut() else { continue };
1185 for operation in methods.values_mut() {
1186 let id = operation["operationId"].as_str().unwrap_or_default().to_owned();
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1187 let name = operation["x-operation"].as_str().unwrap_or_default().to_owned();
1188 let Some(example) = examples.get(&id).or_else(|| examples.get(&name)) else {
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1189 continue;
1190 };
1191 if let Some(notes) = example.get("notes").and_then(Value::as_str) {
1192 let description = operation["description"].as_str().unwrap_or_default();
1193 operation["description"] = json!(format!("{description}\n\n{notes}"));
1194 }
1195 if let Some(response) = example.get("response") {
1196 let content = &mut operation["responses"]["200"]["content"]["application/json"];
1197 if content.is_object() {
1198 content["example"] = response.clone();
1199 }
1200 }
1201 if let Some(request) = example.get("request") {
1202 let content = &mut operation["requestBody"]["content"]["application/json"];
1203 if content.is_object() {
1204 content["example"] = request.clone();
1205 }
1206 }
1207 for (key, extension) in [("params", "x-example-params"), ("query", "x-example-query")] {
1208 if let Some(values) = example.get(key) {
1209 operation[extension] = values.clone();
1210 }
1211 }
1212 }
1213 }
1214}
1215
1216pub fn document() -> Value {
1217 let mut paths = onboarding();
1218 for route in ROUTES {
1219 let entry = paths
1220 .entry(openapi_path(route))
1221 .or_insert_with(|| json!({}));
1222 entry[route.method.to_lowercase()] = operation(route);
1223 }
1224 attach_examples(&mut paths);
1225 let tags: Vec<Value> = SECTIONS
1226 .iter()
1227 .map(|(name, description, ops)| {
1228 json!({
1229 "name": name,
1230 "description": description,
1231 // The section's operations in reading order, by MCP tool name.
1232 "x-tools": ops.iter().map(|op| op.name()).collect::<Vec<_>>(),
1233 })
1234 })
1235 .collect();
1236 let codes = ["unauthenticated", "payment_required", "forbidden", "not_found", "conflict", "invalid"];
1237 json!({
1238 "openapi": "3.1.0",
1239 "info": {
1240 "title": "g1t API",
1241 "version": "1",
1242 "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.",
1243 "license": { "name": "MIT", "identifier": "MIT" },
1244 },
1245 "servers": [{ "url": "https://api.g1t.sh" }],
1246 "security": [{ "token": [] }, {}],
1247 "tags": tags,
1248 "paths": paths,
1249 "components": {
1250 "securitySchemes": {
1251 "token": {
1252 "type": "http",
1253 "scheme": "bearer",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1254 "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.",
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1255 },
1256 },
1257 "schemas": {
1258 "Error": {
1259 "type": "object",
1260 "required": ["error"],
1261 "properties": {
1262 "error": {
1263 "type": "object",
1264 "required": ["code", "message"],
1265 "properties": {
1266 "code": { "type": "string", "enum": codes },
1267 "message": { "type": "string" },
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1268 "needed_scope": {
1269 "type": "string",
1270 "description": "On a 403 for an access token without the scope the call needs: that scope, such as `issues:write`.",
1271 },
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1272 },
1273 },
1274 },
1275 },
1276 },
1277 },
1278 })
1279}
1280
1281#[cfg(test)]
1282mod tests {
1283 use super::*;
1284
1285 #[test]
1286 fn every_route_is_documented_once() {
1287 let document = document();
1288 let mut ids = Vec::new();
1289 for (_, methods) in document["paths"].as_object().unwrap() {
1290 for (_, operation) in methods.as_object().unwrap() {
1291 ids.push(operation["operationId"].as_str().unwrap().to_owned());
1292 }
1293 }
1294 for op in Op::ALL {
1295 assert_eq!(
1296 ids.iter().filter(|id| *id == op.name()).count(),
1297 1,
1298 "{}",
1299 op.name()
1300 );
1301 }
1302 let mut unique = ids.clone();
1303 unique.sort();
1304 unique.dedup();
1305 assert_eq!(unique.len(), ids.len(), "operation ids repeat");
1306 }
1307
1308 #[test]
1309 fn path_and_query_inputs_are_not_repeated_in_the_body() {
1310 let document = document();
1311 let merge = &document["paths"]["/repos/{owner}/{name}/pulls/{number}/merge"]["post"];
1312 let body = &merge["requestBody"]["content"]["application/json"]["schema"]["properties"];
1313 assert!(body.get("keep_issue_open").is_some());
1314 assert!(body.get("repo").is_none() && body.get("number").is_none());
1315 let list = &document["paths"]["/repos"]["get"];
1316 assert_eq!(list["parameters"][0]["name"], "q");
1317 assert!(list.get("requestBody").is_none());
1318 }
1319
1320 #[test]
1321 fn every_operation_is_in_one_section() {
1322 for op in Op::ALL {
1323 let sections = SECTIONS
1324 .iter()
1325 .filter(|(_, _, ops)| ops.contains(&op))
1326 .count();
1327 assert_eq!(sections, 1, "{}", op.name());
1328 }
1329 }
1330
1331 #[test]
1332 fn titles_read_as_sentences() {
1333 assert_eq!(title(Op::CreateIssue), "Create an issue");
1334 assert_eq!(title(Op::Whoami), "Get the current user");
1335 }
1336
1337 #[test]
1338 fn every_operation_has_an_example_response() {
1339 let examples = examples();
1340 assert!(!examples.is_empty(), "reference.json does not parse");
1341 let document = document();
1342 let mut known = Vec::new();
1343 for (path, methods) in document["paths"].as_object().unwrap() {
1344 for (method, operation) in methods.as_object().unwrap() {
1345 known.push(operation["operationId"].as_str().unwrap().to_owned());
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1346 // Nothing to show for a success without a body.
1347 if operation["responses"]["204"].is_object() {
1348 continue;
1349 }
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1350 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1351 assert!(!example.is_null(), "{method} {path} has no example response");
1352 }
1353 }
1354 for id in examples.keys() {
1355 assert!(known.contains(id), "reference.json names {id}, which is not an operation");
1356 }
1357 }
1358
1359 #[test]
1360 fn example_requests_send_only_what_the_body_takes() {
1361 let document = document();
1362 for (path, methods) in document["paths"].as_object().unwrap() {
1363 for (method, operation) in methods.as_object().unwrap() {
1364 let content = &operation["requestBody"]["content"]["application/json"];
1365 let Some(example) = content["example"].as_object() else { continue };
1366 let properties = &content["schema"]["properties"];
1367 for key in example.keys() {
1368 assert!(!properties[key].is_null(), "{method} {path}: {key} is not in the body");
1369 }
1370 }
1371 }
1372 }
1373
1374 /// The docs site's copy of the document. Run with `G1T_WRITE_OPENAPI=1`
1375 /// to rewrite it after changing an operation.
1376 #[test]
1377 fn the_docs_copy_is_current() {
1378 let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/src/data/openapi.json");
1379 let current = serde_json::to_string_pretty(&document()).unwrap() + "\n";
1380 if std::env::var_os("G1T_WRITE_OPENAPI").is_some() {
1381 std::fs::write(path, &current).unwrap();
1382 return;
1383 }
1384 let copy = std::fs::read_to_string(path).unwrap_or_default().replace("\r\n", "\n");
1385 assert!(
1386 copy == current,
1387 "apps/docs/src/data/openapi.json is out of date: run G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi"
1388 );
1389 }
1390
1391 /// The reference shows responses as they are sent: `snake_case`.
1392 #[test]
1393 fn example_responses_are_snake_case() {
1394 let document = document();
1395 for (path, methods) in document["paths"].as_object().unwrap() {
1396 for (method, operation) in methods.as_object().unwrap() {
1397 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1398 let leaked = g1t_kit::wire::camel_case_keys(example);
1399 assert!(leaked.is_empty(), "{method} {path} shows {leaked:?}");
1400 }
1401 }
1402 }
1403
1404 /// Examples never hold anything that reads as a real credential, which
1405 /// secret scanners rightly flag in a public repository: they end in `…`
1406 /// after the prefix, as `whsec_…` and `g1t_…` do.
1407 #[test]
1408 fn examples_hold_no_real_looking_secrets() {
Fast pages, required checks on the branch, self-hosted runners, honest incidents1409 let prefixes = ["whsec_", "g1t_", "g1tr_", "g1trt_", "sk_live_", "sk_test_", "ghp_", "github_pat_", "xoxb-", "AKIA"];
Mission control shows where you are needed and what agents landed without you; git answers in about 200ms1410 for (line, text) in REFERENCE.lines().enumerate() {
1411 for prefix in prefixes {
1412 let mut rest = text;
1413 while let Some(at) = rest.find(prefix) {
1414 let after = &rest[at + prefix.len()..];
1415 let run = after.chars().take_while(|c| c.is_ascii_alphanumeric()).count();
1416 assert!(
1417 run < 12,
1418 "reference.json line {}: `{prefix}` followed by {run} characters reads as a real secret; write `{prefix}…`",
1419 line + 1
1420 );
1421 rest = after;
1422 }
1423 }
1424 }
1425 }
1426}

This file's history is long; its oldest lines are credited to the oldest commit read.