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.

Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1//! 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;
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put8use 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 remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r912use crate::customize::CustomizeOp;
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca13use crate::deploy_keys::DeployKeysOp;
Merge branch 'mirroring' into artifacts-mode14use crate::mirrors::MirrorsOp;
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9715use crate::deployments::DeploymentsOp;
Merge packages: roles, Actions access, source label, soft delete, API16use crate::packages::PackagesOp;
Merge main into Artifacts Phase 217use crate::folios::FoliosOp;
Merge branch 'worktree-agent-a3abfcce648e87dca'18use crate::protection::ProtectionOp;
API and MCP for a workspace's personal access token rules, members' tokens and approvals19use crate::token_policy::TokenOp;
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put20use crate::operations::Op;
Merge checks: statuses and check runs on every commit21use crate::checks::ChecksOp;
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge22use crate::rules::RulesOp;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar23use crate::security::SecurityOp;
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put24use crate::rest::{ROUTES, Route};
25
26/// The sections of the API reference: a name, what it covers, and its
27/// operations in the order a reader meets them.
28const SECTIONS: &[(&str, &str, &[Op])] = &[
29 (
30 "Accounts",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look31 "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)32 &[Op::Whoami, Op::ListEmails, Op::AddEmail, Op::ConfirmEmail, Op::RemoveEmail, Op::UpdateEmailSettings],
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put33 ),
34 (
API: notifications over REST and MCP, with notifications scopes35 "Notifications",
36 "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.",
37 &[
38 Op::ListNotifications,
39 Op::MarkNotificationsRead,
40 Op::GetNotificationThread,
41 Op::MarkThreadRead,
42 Op::MarkThreadDone,
43 Op::SaveThread,
44 Op::SnoozeThread,
45 Op::GetThreadSubscription,
46 Op::SetThreadSubscription,
47 Op::DeleteThreadSubscription,
48 Op::GetRepoSubscription,
49 Op::SetRepoSubscription,
50 Op::DeleteRepoSubscription,
51 Op::ListWatchedRepos,
52 ],
53 ),
54 (
API: pinned projects over REST and MCP55 "Pinned projects",
56 "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.",
57 &[Op::ListPinnedProjects, Op::PinProject, Op::UnpinProject, Op::ReorderPinnedProjects],
58 ),
59 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9760 "Projects",
61 "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.",
62 &[Op::ListProjects, Op::GetProject, Op::UpdateProject],
63 ),
64 (
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put65 "Workspaces",
66 "A workspace owns repositories and is the first part of their address. People and agents work in workspaces.",
Merge branch 'worktree-agent-ad7c6d88d93adc817'67 &[Op::GetWorkspace, Op::CreateWorkspace, Op::UpdateWorkspace, Op::DeleteWorkspace],
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look68 ),
69 (
API and MCP for a workspace's personal access token rules, members' tokens and approvals70 "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 managers71 "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 approvals72 &[
73 Op::Tokens(TokenOp::GetTokenPolicy),
74 Op::Tokens(TokenOp::SetTokenPolicy),
75 Op::Tokens(TokenOp::ListMemberTokens),
76 Op::Tokens(TokenOp::ListTokenRequests),
77 Op::Tokens(TokenOp::ReviewTokenRequest),
78 Op::Tokens(TokenOp::RevokeMemberToken),
79 ],
80 ),
81 (
Merge main (membership, two-factor, GitHub repo roles) into tokens82 "Members",
83 "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.",
84 &[Op::ListMembers, Op::UpdateMember, Op::RemoveMember, Op::TransferOwnership, Op::LeaveWorkspace],
85 ),
86 (
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look87 "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)88 "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.",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look89 &[
90 Op::ListInvites,
91 Op::CreateInvite,
92 Op::RevokeInvite,
93 Op::ListWorkspaceInvites,
94 Op::InviteMember,
95 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)96 Op::ListInvitations,
97 Op::AcceptInvitation,
98 Op::DeclineInvitation,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look99 ],
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put100 ),
101 (
Usage, Billing settings and prepaid AI credit; fixes from the UX audit102 "Billing",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens103 "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 audit104 &[
105 Op::GetUsage,
106 Op::GetBudget,
107 Op::SetBudget,
108 Op::GetAiCredit,
109 Op::BuyAiCredit,
110 Op::ListInvoices,
111 Op::GetBillingDetails,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens112 Op::ListGatewayRequests,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit113 ],
114 ),
115 (
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put116 "Repositories",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look117 "A repository, how it handles pull requests, and its timeline: renaming, archiving, moving and deleting it.",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put118 &[
119 Op::ListRepos,
120 Op::CreateRepo,
121 Op::GetRepo,
122 Op::UpdateRepo,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look123 Op::RenameRepo,
124 Op::RenameBranch,
125 Op::SetRepoVisibility,
126 Op::ArchiveRepo,
127 Op::UnarchiveRepo,
128 Op::TransferRepo,
129 Op::DeleteRepo,
130 Op::ListDeletedRepos,
131 Op::RestoreRepo,
132 Op::PurgeRepo,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put133 Op::GetRepoSettings,
134 Op::UpdateRepoSettings,
Fast pages, required checks on the branch, self-hosted runners, honest incidents135 Op::ListCheckNames,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar136 Op::GetCodeownersErrors,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put137 Op::ListEvents,
138 ],
139 ),
140 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97141 "Repository insights",
142 "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.",
143 &[Op::About(AboutOp::GetLanguages), Op::About(AboutOp::ListContributors), Op::About(AboutOp::GetLicense)],
144 ),
145 (
146 "Stars",
147 "Starring a repository, to keep it and to say you like it: who starred one, and what you starred.",
148 &[
149 Op::About(AboutOp::ListStargazers),
150 Op::About(AboutOp::ListStarred),
151 Op::About(AboutOp::CheckStarred),
152 Op::About(AboutOp::Star),
153 Op::About(AboutOp::Unstar),
154 ],
155 ),
156 (
157 "Releases",
158 "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.",
159 &[
160 Op::About(AboutOp::ListReleases),
161 Op::About(AboutOp::CreateRelease),
162 Op::About(AboutOp::GetLatestRelease),
163 Op::About(AboutOp::GetReleaseByTag),
164 Op::About(AboutOp::GetRelease),
165 Op::About(AboutOp::UpdateRelease),
166 Op::About(AboutOp::DeleteRelease),
167 ],
168 ),
169 (
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look170 "Access",
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca171 "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.",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look172 &[
173 Op::ListCollaborators,
174 Op::AddCollaborator,
175 Op::UpdateCollaborator,
176 Op::RemoveCollaborator,
177 Op::GetCollaboratorPermission,
178 Op::ListRepoInvitations,
179 Op::RevokeRepoInvitation,
180 Op::ListMyRepoInvitations,
181 Op::AcceptRepoInvitation,
182 Op::DeclineRepoInvitation,
183 Op::SetBasePermission,
184 Op::ListOutsideCollaborators,
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca185 Op::DeployKeys(DeployKeysOp::ListDeployKeys),
186 Op::DeployKeys(DeployKeysOp::GetDeployKey),
187 Op::DeployKeys(DeployKeysOp::CreateDeployKey),
188 Op::DeployKeys(DeployKeysOp::DeleteDeployKey),
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look189 ],
190 ),
191 (
Merge branch 'mirroring' into artifacts-mode192 "Mirroring",
193 "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.",
194 &[
195 Op::Mirrors(MirrorsOp::GetMirror),
196 Op::Mirrors(MirrorsOp::GetHandBackPlan),
197 Op::Mirrors(MirrorsOp::TakeOver),
198 Op::Mirrors(MirrorsOp::SetCiFailover),
199 Op::Mirrors(MirrorsOp::HandBack),
200 Op::Mirrors(MirrorsOp::MoveToG1t),
201 Op::Mirrors(MirrorsOp::SyncMirror),
202 Op::Mirrors(MirrorsOp::AddRemote),
203 Op::Mirrors(MirrorsOp::UpdateRemote),
204 Op::Mirrors(MirrorsOp::RemoveRemote),
205 ],
206 ),
207 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar208 "Teams",
209 "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.",
210 &[
211 Op::ListTeams,
212 Op::CreateTeam,
213 Op::GetTeam,
214 Op::UpdateTeam,
215 Op::DeleteTeam,
216 Op::ListTeamMembers,
217 Op::SetTeamMember,
218 Op::RemoveTeamMember,
219 Op::ListChildTeams,
220 Op::ListTeamRepos,
221 Op::SetTeamRepo,
222 Op::RemoveTeamRepo,
223 Op::SetTeamReviewAssignment,
224 Op::ListUserTeams,
225 ],
226 ),
227 (
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily228 "Security",
229 "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.",
230 &[Op::ListSecurityAlerts, Op::DismissSecurityAlert, Op::ReopenSecurityAlert],
231 ),
232 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar233 "Secret scanning",
234 "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.",
235 &[
236 Op::Security(SecurityOp::ListSecretAlerts),
237 Op::Security(SecurityOp::GetSecretAlert),
238 Op::Security(SecurityOp::UpdateSecretAlert),
239 Op::Security(SecurityOp::ListSecretLocations),
240 Op::Security(SecurityOp::BypassPushProtection),
241 Op::Security(SecurityOp::CheckSecretValidity),
242 Op::Security(SecurityOp::ListBypassRequests),
243 Op::Security(SecurityOp::ReviewBypassRequest),
244 Op::Security(SecurityOp::ListCustomPatterns),
245 Op::Security(SecurityOp::CreateCustomPattern),
246 Op::Security(SecurityOp::UpdateCustomPattern),
247 Op::Security(SecurityOp::DeleteCustomPattern),
248 Op::Security(SecurityOp::DryRunCustomPattern),
249 ],
250 ),
251 (
252 "Code scanning",
253 "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.",
254 &[
255 Op::Security(SecurityOp::ListCodeAlerts),
256 Op::Security(SecurityOp::GetCodeAlert),
257 Op::Security(SecurityOp::UpdateCodeAlert),
258 Op::Security(SecurityOp::ListAnalyses),
259 Op::Security(SecurityOp::UploadSarif),
260 Op::Security(SecurityOp::GetSarifUpload),
261 Op::Security(SecurityOp::FixAlert),
262 ],
263 ),
264 (
265 "Supply chain",
266 "What a repository depends on: vulnerability alerts, the dependency graph, an SPDX SBOM of it, and comparing two commits' dependencies as dependency review does.",
267 &[
268 Op::Security(SecurityOp::ListVulnerabilityAlerts),
269 Op::Security(SecurityOp::GetVulnerabilityAlert),
270 Op::Security(SecurityOp::UpdateVulnerabilityAlert),
271 Op::Security(SecurityOp::GetDependencyGraph),
272 Op::Security(SecurityOp::GetSbom),
273 Op::Security(SecurityOp::CompareDependencies),
274 ],
275 ),
276 (
277 "Security settings",
278 "When pull request checks fail, dependency review's policy, delegated bypass and validity checks, and a workspace's security overview.",
279 &[
280 Op::Security(SecurityOp::GetSettings),
281 Op::Security(SecurityOp::UpdateSettings),
282 Op::Security(SecurityOp::GetWorkspaceSettings),
283 Op::Security(SecurityOp::UpdateWorkspaceSettings),
284 Op::Security(SecurityOp::GetOverview),
285 ],
286 ),
287 (
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9288 "Security advisories",
289 "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.",
290 &[
291 Op::Security(SecurityOp::ListAdvisories),
292 Op::Security(SecurityOp::CreateAdvisory),
293 Op::Security(SecurityOp::GetAdvisory),
294 Op::Security(SecurityOp::UpdateAdvisory),
295 Op::Security(SecurityOp::SetAdvisoryState),
296 Op::Security(SecurityOp::ListReports),
297 Op::Security(SecurityOp::ReportVulnerability),
298 Op::Security(SecurityOp::ReviewReport),
299 ],
300 ),
301 (
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge302 "Rules",
303 "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.",
304 &[
305 Op::Rules(RulesOp::ListRepoRulesets),
306 Op::Rules(RulesOp::CreateRepoRuleset),
307 Op::Rules(RulesOp::GetRepoRuleset),
308 Op::Rules(RulesOp::UpdateRepoRuleset),
309 Op::Rules(RulesOp::DeleteRepoRuleset),
310 Op::Rules(RulesOp::GetBranchRules),
311 Op::Rules(RulesOp::ListRuleEvaluations),
312 Op::Rules(RulesOp::ListWorkspaceRulesets),
313 Op::Rules(RulesOp::CreateWorkspaceRuleset),
314 Op::Rules(RulesOp::GetWorkspaceRuleset),
315 Op::Rules(RulesOp::UpdateWorkspaceRuleset),
316 Op::Rules(RulesOp::DeleteWorkspaceRuleset),
317 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
318 ],
319 ),
320 (
Merge checks: statuses and check runs on every commit321 "Checks",
322 "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.",
323 &[
324 Op::Checks(ChecksOp::CreateCommitStatus),
325 Op::Checks(ChecksOp::ListCommitStatuses),
326 Op::Checks(ChecksOp::GetCombinedStatus),
327 Op::Checks(ChecksOp::CreateCheckRun),
328 Op::Checks(ChecksOp::UpdateCheckRun),
329 Op::Checks(ChecksOp::GetCheckRun),
330 Op::Checks(ChecksOp::ListCheckRunAnnotations),
331 Op::Checks(ChecksOp::RerequestCheckRun),
332 Op::Checks(ChecksOp::ListCheckRunsForRef),
333 Op::Checks(ChecksOp::ListCheckSuitesForRef),
334 Op::Checks(ChecksOp::GetCheckSuite),
335 Op::Checks(ChecksOp::RerequestCheckSuite),
336 ],
337 ),
338 (
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put339 "Issues",
340 "What should change in a repository, with labels and comments. Issues and pull requests share one sequence of numbers.",
341 &[
342 Op::ListIssues,
343 Op::CreateIssue,
344 Op::GetIssue,
345 Op::UpdateIssue,
346 Op::CloseIssue,
347 Op::ReopenIssue,
348 Op::AssignIssue,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step349 Op::Delegate,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put350 Op::AddComment,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts351 Op::EditComment,
352 Op::DeleteComment,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar353 Op::ListIssueLabels,
354 Op::AddIssueLabels,
355 Op::SetIssueLabels,
356 Op::RemoveIssueLabels,
357 ],
358 ),
359 (
360 "Labels and milestones",
361 "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.",
362 &[
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put363 Op::ListLabels,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar364 Op::CreateLabel,
365 Op::UpdateLabel,
366 Op::DeleteLabel,
367 Op::AddDefaultLabels,
368 Op::ListMilestones,
369 Op::CreateMilestone,
370 Op::GetMilestone,
371 Op::UpdateMilestone,
372 Op::DeleteMilestone,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put373 ],
374 ),
375 (
376 "Plans",
377 "An outcome turned into the issues that would get there, with the order they must merge in.",
378 &[Op::PlanWork, Op::GetPlan, Op::ApplyPlan],
379 ),
380 (
381 "Pull requests",
382 "A proposed change in its own fork or on a branch. Several can be made for one issue; the one merged resolves it.",
383 &[
384 Op::ListPullRequests,
385 Op::CreatePullRequest,
386 Op::GetPullRequest,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar387 Op::UpdatePullRequest,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put388 Op::GetPullRequestChanges,
389 Op::MarkPullRequestReady,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts390 Op::ConvertPullRequestToDraft,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar391 Op::RequestReviewers,
392 Op::RemoveRequestedReviewers,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put393 Op::ReviewPullRequest,
394 Op::MergePullRequest,
395 Op::ClosePullRequest,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts396 Op::ReopenPullRequest,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put397 Op::GetMergeQueue,
398 Op::MessageAgent,
399 Op::AnswerMessage,
400 Op::TakeMessages,
401 ],
402 ),
403 (
404 "Sessions",
405 "The record of how a pull request was made: prompts, reasoning and the tools that ran.",
406 &[Op::ReadSession, Op::RecordSession],
407 ),
408 (
409 "Memory",
410 "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.",
411 &[Op::Remember, Op::Recall],
412 ),
413 (
414 "Search",
415 "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.",
416 &[Op::Search],
417 ),
418 (
419 "Context",
420 "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.",
421 &[Op::SearchContext, Op::GetEntity],
422 ),
423 (
424 "Actions",
425 "GitHub Actions workflows in .g1t/workflows, their runs, and their jobs' logs.",
426 &[
427 Op::ListWorkflows,
428 Op::ListWorkflowRuns,
429 Op::GetWorkflowRun,
430 Op::GetJobLogs,
431 Op::DispatchWorkflow,
432 Op::CancelWorkflowRun,
433 Op::RerunWorkflowRun,
434 Op::UpdateWorkflow,
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2435 Op::Artifacts(ArtifactsOp::ListArtifacts),
436 Op::Artifacts(ArtifactsOp::ListRunArtifacts),
437 Op::Artifacts(ArtifactsOp::GetArtifact),
438 Op::Artifacts(ArtifactsOp::DownloadArtifact),
439 Op::Artifacts(ArtifactsOp::DeleteArtifact),
440 Op::Artifacts(ArtifactsOp::GetArtifactRetention),
441 Op::Artifacts(ArtifactsOp::SetArtifactRetention),
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put442 ],
443 ),
444 (
Merge packages: roles, Actions access, source label, soft delete, API445 "Packages",
446 "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.",
447 &[
448 Op::Packages(PackagesOp::ListPackages),
449 Op::Packages(PackagesOp::GetPackage),
450 Op::Packages(PackagesOp::UpdatePackage),
451 Op::Packages(PackagesOp::DeletePackage),
452 Op::Packages(PackagesOp::RestorePackage),
453 Op::Packages(PackagesOp::ListVersions),
454 Op::Packages(PackagesOp::GetVersion),
455 Op::Packages(PackagesOp::DeleteVersion),
456 Op::Packages(PackagesOp::RestoreVersion),
457 Op::Packages(PackagesOp::LinkPackage),
458 Op::Packages(PackagesOp::UnlinkPackage),
459 Op::Packages(PackagesOp::ListAccess),
460 Op::Packages(PackagesOp::SetAccess),
461 Op::Packages(PackagesOp::RemoveAccess),
462 Op::Packages(PackagesOp::ListActionsAccess),
463 Op::Packages(PackagesOp::SetActionsAccess),
464 Op::Packages(PackagesOp::RemoveActionsAccess),
465 ],
466 ),
467 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97468 "Deployments",
469 "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.",
470 &[
471 Op::Deployments(DeploymentsOp::ListDeployments),
472 Op::Deployments(DeploymentsOp::CreateDeployment),
473 Op::Deployments(DeploymentsOp::GetDeployment),
474 Op::Deployments(DeploymentsOp::ListDeploymentStatuses),
475 Op::Deployments(DeploymentsOp::CreateDeploymentStatus),
476 Op::Deployments(DeploymentsOp::ListEnvironments),
477 Op::Deployments(DeploymentsOp::GetEnvironment),
Merge branch 'worktree-agent-a4d35ee70c50683d0' into claude/cool-newton-7nm8r9478 Op::Deployments(DeploymentsOp::StartDeploymentBuild),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97479 ],
480 ),
481 (
Merge branch 'worktree-agent-a3abfcce648e87dca'482 "Run protection",
483 "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.",
484 &[
485 Op::Protection(ProtectionOp::UpdateEnvironment),
486 Op::Protection(ProtectionOp::DeleteEnvironment),
487 Op::Protection(ProtectionOp::GetPendingDeployments),
488 Op::Protection(ProtectionOp::ReviewPendingDeployments),
489 Op::Protection(ProtectionOp::ApproveWorkflowRun),
490 Op::Protection(ProtectionOp::GetWorkflowPermissions),
491 Op::Protection(ProtectionOp::SetWorkflowPermissions),
492 Op::Protection(ProtectionOp::GetForkPrApproval),
493 Op::Protection(ProtectionOp::SetForkPrApproval),
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts494 Op::Protection(ProtectionOp::GetActionsAccess),
495 Op::Protection(ProtectionOp::SetActionsAccess),
Merge branch 'worktree-agent-a3abfcce648e87dca'496 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
497 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
498 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
A workspace can manage workflows in its repositories, as GitHub's required workflows do, through g1t's managed mechanism. An owner adds a workflow file from one of the workspace's own repositories (`owner/repo/.g1t/workflows/file.yml@ref`) with a name, a mode and a target, kept in the actions service's new `workspace_managed_workflows` table (migration 0017): the file is copied at the commit its ref names when it is saved, so only an owner changes what runs with every repository's secrets, and copying it again takes up a change. The target is repository names and patterns (`*`, `!` to leave one out, the last match deciding; empty is every repository) and a visibility, and a source in a private repository runs in private repositories only, as reach.rs keeps a public repository from using a private one's workflows. Wherever a repository's workflows are read, a fork's pull request and the merge queue included, `g1t_actions::managed::arrange` puts its files and the managed workflows together: a required workflow runs as `managed/<name>.yml` and sets aside a file of its `name:`, so nothing else reports its check and a ruleset can require it, and can't be turned off in the repository; a default one gives way to a file of its name, as the workflows g1t's services install do, and a repository admin can turn it off. It runs as the repository's own workflow, with its token and secrets. A change syncs the first 20 repositories it reaches at once and leaves the rest to be synced when their workflows are listed or by the minute's sweep, a few a minute, their managed schedules waiting until then; it is recorded in the audit log. A workflow's view says what manages it (`managedBy`), and the Actions list now includes managed workflows, which it had left out. The API has `GET` and `POST /workspaces/{workspace}/actions/managed-workflows` and `PATCH` and `DELETE /workspaces/{workspace}/actions/managed-workflows/{workflow}`, owners only, and the `workflow` MCP tool `list_managed_workflows`, `add_managed_workflow`, `update_managed_workflow` and `remove_managed_workflow`; the reference and the OpenAPI copy say so.499 Op::Protection(ProtectionOp::ListWorkspaceManagedWorkflows),
500 Op::Protection(ProtectionOp::CreateWorkspaceManagedWorkflow),
501 Op::Protection(ProtectionOp::UpdateWorkspaceManagedWorkflow),
502 Op::Protection(ProtectionOp::DeleteWorkspaceManagedWorkflow),
Merge branch 'worktree-agent-a3abfcce648e87dca'503 ],
504 ),
505 (
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put506 "Secrets and variables",
507 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
508 &[
509 Op::ListActionsSecrets,
510 Op::SetActionsSecret,
511 Op::DeleteActionsSecret,
512 Op::ListActionsVariables,
513 Op::SetActionsVariable,
514 Op::DeleteActionsVariable,
515 ],
516 ),
517 (
Fast pages, required checks on the branch, self-hosted runners, honest incidents518 "Runners",
519 "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.",
520 &[
521 Op::ListRunners,
522 Op::CreateRunnerRegistrationToken,
523 Op::RemoveRunner,
524 Op::ListRunnerGroups,
525 Op::CreateRunnerGroup,
526 Op::UpdateRunnerGroup,
527 Op::DeleteRunnerGroup,
528 Op::GetRunnerSettings,
529 Op::UpdateRunnerSettings,
530 ],
531 ),
532 (
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.533 "Agents' computers",
534 "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.",
535 &[
536 Op::GetAgentComputer,
537 Op::WakeAgentComputer,
538 Op::SleepAgentComputer,
539 Op::ResetAgentComputer,
540 Op::ListAgentComputerCommands,
541 ],
542 ),
543 (
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put544 "Webhooks",
545 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
546 &[
547 Op::ListWebhooks,
548 Op::CreateWebhook,
549 Op::UpdateWebhook,
550 Op::DeleteWebhook,
551 Op::PingWebhook,
552 Op::ListWebhookDeliveries,
553 Op::RedeliverWebhook,
554 ],
555 ),
556 (
557 "Integrations",
558 "A workspace's connections to outside systems: model providers, alert sources and issue trackers.",
559 &[
560 Op::ListIntegrations,
561 Op::ConnectIntegration,
AI Gateway: OpenAI's format, open models, and your own providers562 Op::UpdateIntegration,
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put563 Op::DisconnectIntegration,
564 Op::TestIntegration,
565 Op::GetModelRoutes,
566 Op::SetModelRoutes,
567 Op::GetContext,
568 Op::ImportIssue,
569 ],
570 ),
Merge main into Artifacts Phase 2571 (
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9572 "Customize",
573 "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.",
574 &[
575 Op::Customize(CustomizeOp::ListMarketplaces),
576 Op::Customize(CustomizeOp::AddMarketplace),
577 Op::Customize(CustomizeOp::RemoveMarketplace),
578 Op::Customize(CustomizeOp::RefreshMarketplace),
579 Op::Customize(CustomizeOp::Discover),
580 Op::Customize(CustomizeOp::ListPlugins),
581 Op::Customize(CustomizeOp::GetPlugin),
582 Op::Customize(CustomizeOp::InstallPlugin),
583 Op::Customize(CustomizeOp::SetPluginEnabled),
584 Op::Customize(CustomizeOp::UninstallPlugin),
585 Op::Customize(CustomizeOp::UpdatePlugin),
586 Op::Customize(CustomizeOp::ListPluginAgents),
587 Op::Customize(CustomizeOp::ListConnectors),
588 Op::Customize(CustomizeOp::GetConnector),
589 Op::Customize(CustomizeOp::AddConnector),
590 Op::Customize(CustomizeOp::SetConnectorKey),
591 Op::Customize(CustomizeOp::RemoveConnector),
592 Op::Customize(CustomizeOp::RefreshConnector),
593 Op::Customize(CustomizeOp::GrantConnector),
594 Op::Customize(CustomizeOp::RevokeConnector),
595 Op::Customize(CustomizeOp::Bundle),
596 ],
597 ),
598 (
Merge main into Artifacts Phase 2599 "Artifacts",
600 "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.",
601 &[
602 Op::Folios(FoliosOp::List),
603 Op::Folios(FoliosOp::Search),
604 Op::Folios(FoliosOp::Get),
605 Op::Folios(FoliosOp::GetContent),
606 Op::Folios(FoliosOp::ListVersions),
607 Op::Folios(FoliosOp::GetAccess),
608 Op::Folios(FoliosOp::ListTemplates),
609 Op::Folios(FoliosOp::ListSpaces),
610 Op::Folios(FoliosOp::QueryDataset),
611 Op::Folios(FoliosOp::Create),
612 Op::Folios(FoliosOp::Update),
613 Op::Folios(FoliosOp::Edit),
614 Op::Folios(FoliosOp::Trash),
615 Op::Folios(FoliosOp::Restore),
616 Op::Folios(FoliosOp::RestoreVersion),
617 Op::Folios(FoliosOp::SetAccess),
618 Op::Folios(FoliosOp::Purge),
619 ],
620 ),
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put621];
622
623/// The section of the API reference an operation is listed under.
624fn tag(op: Op) -> &'static str {
625 SECTIONS
626 .iter()
627 .find(|(_, _, ops)| ops.contains(&op))
628 .map_or("Repositories", |(name, _, _)| name)
629}
630
631/// What an operation's page is called, as a short sentence.
632fn title(op: Op) -> &'static str {
633 match op {
634 Op::Whoami => "Get the current user",
Merge branch 'worktree-agent-ad7c6d88d93adc817'635 Op::GetWorkspace => "Get a workspace",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put636 Op::CreateWorkspace => "Create a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look637 Op::DeleteWorkspace => "Delete a workspace",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily638 Op::UpdateWorkspace => "Update a workspace",
Merge main (membership, two-factor, GitHub repo roles) into tokens639 Op::ListMembers => "List a workspace's members",
640 Op::UpdateMember => "Change a member's role",
641 Op::RemoveMember => "Remove a member",
642 Op::TransferOwnership => "Transfer a workspace's ownership",
643 Op::LeaveWorkspace => "Leave a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look644 Op::ListEmails => "List your email addresses",
645 Op::AddEmail => "Add an email address",
Merge email confirmation gate: a code and a link, nothing until confirmed (identity 0036)646 Op::ConfirmEmail => "Confirm an email address",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look647 Op::RemoveEmail => "Remove an email address",
648 Op::UpdateEmailSettings => "Change your email settings",
649 Op::ListInvites => "List your invites",
650 Op::CreateInvite => "Create an invite",
651 Op::RevokeInvite => "Revoke an invite",
652 Op::ListWorkspaceInvites => "List a workspace's invites",
653 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)654 Op::ListInvitations => "List your workspace invitations",
655 Op::AcceptInvitation => "Accept a workspace invitation",
656 Op::DeclineInvitation => "Decline a workspace invitation",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look657 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
658 Op::TransferRepo => "Transfer a repository",
659 Op::RenameRepo => "Rename a repository",
660 Op::RenameBranch => "Rename a branch",
661 Op::ArchiveRepo => "Archive a repository",
662 Op::UnarchiveRepo => "Unarchive a repository",
663 Op::SetRepoVisibility => "Change a repository's visibility",
664 Op::DeleteRepo => "Delete a repository",
665 Op::ListDeletedRepos => "List recently deleted repositories",
666 Op::RestoreRepo => "Restore a deleted repository",
667 Op::PurgeRepo => "Purge a deleted repository",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put668 Op::ListRepos => "List repositories",
669 Op::GetRepo => "Get a repository",
670 Op::CreateRepo => "Create a repository",
671 Op::UpdateRepo => "Update a repository",
672 Op::GetRepoSettings => "Get repository settings",
673 Op::UpdateRepoSettings => "Update repository settings",
Fast pages, required checks on the branch, self-hosted runners, honest incidents674 Op::ListCheckNames => "List check names",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put675 Op::GetMergeQueue => "Get the merge queue",
676 Op::MessageAgent => "Message an agent",
677 Op::AnswerMessage => "Answer a message",
678 Op::TakeMessages => "Take new messages",
679 Op::Remember => "Remember something",
680 Op::Recall => "Recall memory",
681 Op::SearchContext => "Search the context hub",
682 Op::GetEntity => "Get a catalog entry",
683 Op::Search => "Search g1t",
684 Op::ListIssues => "List issues",
685 Op::GetIssue => "Get an issue",
686 Op::CreateIssue => "Create an issue",
687 Op::UpdateIssue => "Update an issue",
688 Op::CloseIssue => "Close an issue",
689 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-agent690 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 step691 Op::Delegate => "Put an agent on it",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put692 Op::PlanWork => "Plan work",
693 Op::GetPlan => "Get a plan",
694 Op::ApplyPlan => "Apply a plan",
695 Op::ListLabels => "List labels",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar696 Op::CreateLabel => "Create a label",
697 Op::UpdateLabel => "Update a label",
698 Op::DeleteLabel => "Delete a label",
699 Op::AddDefaultLabels => "Add the default labels",
700 Op::ListIssueLabels => "List an issue's labels",
701 Op::AddIssueLabels => "Add labels to an issue",
702 Op::SetIssueLabels => "Set an issue's labels",
703 Op::RemoveIssueLabels => "Remove labels from an issue",
704 Op::ListMilestones => "List milestones",
705 Op::GetMilestone => "Get a milestone",
706 Op::CreateMilestone => "Create a milestone",
707 Op::UpdateMilestone => "Update a milestone",
708 Op::DeleteMilestone => "Delete a milestone",
709 Op::UpdatePullRequest => "Update a pull request",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put710 Op::AddComment => "Add a comment",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts711 Op::EditComment => "Edit a comment",
712 Op::DeleteComment => "Delete a comment",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put713 Op::ReviewPullRequest => "Review a pull request",
714 Op::ListPullRequests => "List pull requests",
715 Op::GetPullRequest => "Get a pull request",
716 Op::CreatePullRequest => "Create a pull request",
717 Op::RecordSession => "Record session entries",
718 Op::ReadSession => "Read a session",
719 Op::MarkPullRequestReady => "Mark a pull request ready",
720 Op::ClosePullRequest => "Close a pull request",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts721 Op::ReopenPullRequest => "Reopen a pull request",
722 Op::ConvertPullRequestToDraft => "Convert a pull request to a draft",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put723 Op::GetPullRequestChanges => "Get a pull request's changes",
724 Op::MergePullRequest => "Merge a pull request",
725 Op::ListEvents => "List repository events",
726 Op::ListIntegrations => "List integrations",
727 Op::ConnectIntegration => "Connect an integration",
AI Gateway: OpenAI's format, open models, and your own providers728 Op::UpdateIntegration => "Update an integration",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put729 Op::DisconnectIntegration => "Disconnect an integration",
730 Op::TestIntegration => "Test an integration",
731 Op::GetContext => "Look up a ticket",
732 Op::ImportIssue => "Import an issue",
733 Op::GetModelRoutes => "Get model routes",
734 Op::SetModelRoutes => "Set model routes",
735 Op::ListWebhooks => "List webhooks",
736 Op::CreateWebhook => "Create a webhook",
737 Op::UpdateWebhook => "Update a webhook",
738 Op::DeleteWebhook => "Delete a webhook",
739 Op::PingWebhook => "Ping a webhook",
740 Op::ListWebhookDeliveries => "List webhook deliveries",
741 Op::RedeliverWebhook => "Redeliver a webhook delivery",
742 Op::ListWorkflows => "List workflows",
743 Op::ListWorkflowRuns => "List workflow runs",
744 Op::GetWorkflowRun => "Get a workflow run",
745 Op::GetJobLogs => "Get a job's log",
746 Op::DispatchWorkflow => "Run a workflow",
747 Op::CancelWorkflowRun => "Cancel a workflow run",
748 Op::RerunWorkflowRun => "Re-run a workflow run",
749 Op::UpdateWorkflow => "Turn a workflow on or off",
750 Op::ListActionsSecrets => "List secrets",
751 Op::SetActionsSecret => "Set a secret",
752 Op::DeleteActionsSecret => "Delete a secret",
753 Op::ListActionsVariables => "List variables",
754 Op::SetActionsVariable => "Set a variable",
755 Op::DeleteActionsVariable => "Delete a variable",
Fast pages, required checks on the branch, self-hosted runners, honest incidents756 Op::ListRunners => "List self-hosted runners",
757 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.758 Op::GetAgentComputer => "Get an agent's computer",
759 Op::WakeAgentComputer => "Wake an agent's computer",
760 Op::SleepAgentComputer => "Put an agent's computer to sleep",
761 Op::ResetAgentComputer => "Reset an agent's computer",
762 Op::ListAgentComputerCommands => "List an agent's computer's commands",
Fast pages, required checks on the branch, self-hosted runners, honest incidents763 Op::GetRunnerSettings => "Get runner settings",
764 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
765 Op::RemoveRunner => "Remove a self-hosted runner",
766 Op::CreateRunnerGroup => "Create a runner group",
767 Op::UpdateRunnerGroup => "Change a runner group",
768 Op::DeleteRunnerGroup => "Delete a runner group",
769 Op::UpdateRunnerSettings => "Change runner settings",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look770 Op::ListCollaborators => "List who has access",
771 Op::AddCollaborator => "Add a collaborator",
772 Op::UpdateCollaborator => "Change a collaborator's role",
773 Op::RemoveCollaborator => "Remove a collaborator",
774 Op::GetCollaboratorPermission => "Get someone's permission",
775 Op::ListRepoInvitations => "List a repository's invitations",
776 Op::RevokeRepoInvitation => "Revoke a repository invitation",
777 Op::ListMyRepoInvitations => "List your repository invitations",
778 Op::AcceptRepoInvitation => "Accept a repository invitation",
779 Op::DeclineRepoInvitation => "Decline a repository invitation",
780 Op::SetBasePermission => "Set the base permission",
781 Op::ListOutsideCollaborators => "List outside collaborators",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily782 Op::ListSecurityAlerts => "List security alerts",
783 Op::DismissSecurityAlert => "Dismiss a security alert",
784 Op::ReopenSecurityAlert => "Reopen a security alert",
API: notifications over REST and MCP, with notifications scopes785 Op::ListNotifications => "List notifications",
786 Op::MarkNotificationsRead => "Mark notifications read",
787 Op::GetNotificationThread => "Get a thread",
788 Op::MarkThreadRead => "Mark a thread read",
789 Op::MarkThreadDone => "Mark a thread done",
790 Op::SaveThread => "Save a thread",
791 Op::SnoozeThread => "Snooze a thread",
792 Op::GetThreadSubscription => "Get a thread subscription",
793 Op::SetThreadSubscription => "Set a thread subscription",
794 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
795 Op::GetRepoSubscription => "Get how you watch a repository",
796 Op::SetRepoSubscription => "Watch a repository",
797 Op::DeleteRepoSubscription => "Stop watching a repository",
798 Op::ListWatchedRepos => "List repositories you watch",
API: pinned projects over REST and MCP799 Op::ListPinnedProjects => "List your pinned projects",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit800 Op::GetUsage => "Get a workspace's usage",
801 Op::GetBudget => "Get a workspace's budget",
802 Op::SetBudget => "Change a workspace's budget",
803 Op::GetAiCredit => "Get a workspace's AI credit",
804 Op::BuyAiCredit => "Buy AI credit",
805 Op::ListInvoices => "List a workspace's invoices",
806 Op::GetBillingDetails => "Get a workspace's billing details",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens807 Op::ListGatewayRequests => "List a workspace's AI Gateway requests",
API: pinned projects over REST and MCP808 Op::PinProject => "Pin a project",
809 Op::UnpinProject => "Unpin a project",
810 Op::ReorderPinnedProjects => "Reorder your pinned projects",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97811 Op::ListProjects => "List a workspace's projects",
812 Op::GetProject => "Get a project",
813 Op::UpdateProject => "Update a project",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar814 Op::ListTeams => "List teams",
815 Op::GetTeam => "Get a team",
816 Op::CreateTeam => "Create a team",
817 Op::UpdateTeam => "Update a team",
818 Op::DeleteTeam => "Delete a team",
819 Op::ListTeamMembers => "List a team's members",
820 Op::SetTeamMember => "Add or change a team member",
821 Op::RemoveTeamMember => "Remove a team member",
822 Op::ListChildTeams => "List child teams",
823 Op::ListTeamRepos => "List a team's repositories",
824 Op::SetTeamRepo => "Give a team a role on a repository",
825 Op::RemoveTeamRepo => "Remove a team from a repository",
826 Op::SetTeamReviewAssignment => "Set a team's review assignment",
827 Op::ListUserTeams => "List someone's teams",
828 Op::RequestReviewers => "Request reviewers",
829 Op::RemoveRequestedReviewers => "Remove requested reviewers",
830 Op::GetCodeownersErrors => "List CODEOWNERS errors",
831 Op::Security(op) => op.title(),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge832 Op::Rules(op) => op.title(),
Merge checks: statuses and check runs on every commit833 Op::Checks(op) => op.title(),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97834 Op::About(op) => op.title(),
835 Op::Deployments(op) => op.title(),
Merge branch 'worktree-agent-a3abfcce648e87dca'836 Op::Protection(op) => op.title(),
API and MCP for a workspace's personal access token rules, members' tokens and approvals837 Op::Tokens(op) => op.title(),
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2838 Op::Artifacts(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(),
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put844 }
845}
846
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look847/// 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."),
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look855 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 }
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put860}
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(),
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put929 ("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(),
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put946 _ => 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",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put965 "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",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put974 _ => 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));
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put991 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) }))
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1003 .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 }
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1038 responses.insert(
1039 "401".into(),
1040 error_response("A token is required, or the one sent is not valid."),
1041 );
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look1042 if let Some(reason) = may_need_payment(op) {
1043 responses.insert("402".into(), error_response(reason));
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1044 }
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 );
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1049 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();
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1063 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 }])
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1065 } 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 }, {}])
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1067 };
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();
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1077 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(),
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1086 "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." },
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1161 "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 {
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1189 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.",
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1255 },
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 },
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1272 },
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 }
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1350 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"];
Team plan, an open-source pool, monthly trials and honest metering; the sidebar for everyone; a workspace that stays put1410 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.