Skip to content
Sign up

flagon-io/g1t

public
0
1,421 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.

Icons are cached at the edge1//! 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;
Icons are cached at the edge8use 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 'customize' into main: Customize replaces the Marketplace, the Artifacts trash and spaces changes, the Security-free cleanup, with the desktop app's own title bar kept in the shell.12use 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;
Icons are cached at the edge20use 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;
Icons are cached at the edge24use 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],
Icons are cached at the edge33 ),
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 (
Icons are cached at the edge65 "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 ],
Icons are cached at the edge100 ),
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 (
Icons are cached at the edge116 "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.",
Icons are cached at the edge118 &[
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,
Icons are cached at the edge133 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,
Icons are cached at the edge137 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 (
The API carries the advisory and report operations the service gained, with the two new repository security settings (history_alerts, private_vulnerability_reporting) on get_security_settings and update_security_settings, and the docs' OpenAPI copy is regenerated to match.288 "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 (
Icons are cached at the edge339 "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,
Icons are cached at the edge350 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 &[
Icons are cached at the edge363 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,
Icons are cached at the edge373 ],
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,
Icons are cached at the edge388 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,
Icons are cached at the edge393 Op::ReviewPullRequest,
394 Op::MergePullRequest,
395 Op::ClosePullRequest,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts396 Op::ReopenPullRequest,
Icons are cached at the edge397 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 (
Agents and memory, checks and conflicts, profiles, slug renames, custom domains409 "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 (
Search across all of g1t, Explore, and a command palette414 "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 (
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API419 "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 (
Icons are cached at the edge424 "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),
Icons are cached at the edge442 ],
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),
478 ],
479 ),
480 (
Merge branch 'worktree-agent-a3abfcce648e87dca'481 "Run protection",
482 "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.",
483 &[
484 Op::Protection(ProtectionOp::UpdateEnvironment),
485 Op::Protection(ProtectionOp::DeleteEnvironment),
486 Op::Protection(ProtectionOp::GetPendingDeployments),
487 Op::Protection(ProtectionOp::ReviewPendingDeployments),
488 Op::Protection(ProtectionOp::ApproveWorkflowRun),
489 Op::Protection(ProtectionOp::GetWorkflowPermissions),
490 Op::Protection(ProtectionOp::SetWorkflowPermissions),
491 Op::Protection(ProtectionOp::GetForkPrApproval),
492 Op::Protection(ProtectionOp::SetForkPrApproval),
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts493 Op::Protection(ProtectionOp::GetActionsAccess),
494 Op::Protection(ProtectionOp::SetActionsAccess),
Merge branch 'worktree-agent-a3abfcce648e87dca'495 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
496 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
497 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
498 ],
499 ),
500 (
Icons are cached at the edge501 "Secrets and variables",
502 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
503 &[
504 Op::ListActionsSecrets,
505 Op::SetActionsSecret,
506 Op::DeleteActionsSecret,
507 Op::ListActionsVariables,
508 Op::SetActionsVariable,
509 Op::DeleteActionsVariable,
510 ],
511 ),
512 (
Fast pages, required checks on the branch, self-hosted runners, honest incidents513 "Runners",
514 "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.",
515 &[
516 Op::ListRunners,
517 Op::CreateRunnerRegistrationToken,
518 Op::RemoveRunner,
519 Op::ListRunnerGroups,
520 Op::CreateRunnerGroup,
521 Op::UpdateRunnerGroup,
522 Op::DeleteRunnerGroup,
523 Op::GetRunnerSettings,
524 Op::UpdateRunnerSettings,
525 ],
526 ),
527 (
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.528 "Agents' computers",
529 "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.",
530 &[
531 Op::GetAgentComputer,
532 Op::WakeAgentComputer,
533 Op::SleepAgentComputer,
534 Op::ResetAgentComputer,
535 Op::ListAgentComputerCommands,
536 ],
537 ),
538 (
Icons are cached at the edge539 "Webhooks",
540 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
541 &[
542 Op::ListWebhooks,
543 Op::CreateWebhook,
544 Op::UpdateWebhook,
545 Op::DeleteWebhook,
546 Op::PingWebhook,
547 Op::ListWebhookDeliveries,
548 Op::RedeliverWebhook,
549 ],
550 ),
551 (
552 "Integrations",
553 "A workspace's connections to outside systems: model providers, alert sources and issue trackers.",
554 &[
555 Op::ListIntegrations,
556 Op::ConnectIntegration,
AI Gateway: OpenAI's format, open models, and your own providers557 Op::UpdateIntegration,
Icons are cached at the edge558 Op::DisconnectIntegration,
559 Op::TestIntegration,
560 Op::GetModelRoutes,
561 Op::SetModelRoutes,
562 Op::GetContext,
563 Op::ImportIssue,
564 ],
565 ),
Merge main into Artifacts Phase 2566 (
Merge branch 'customize' into main: Customize replaces the Marketplace, the Artifacts trash and spaces changes, the Security-free cleanup, with the desktop app's own title bar kept in the shell.567 "Customize",
568 "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.",
569 &[
570 Op::Customize(CustomizeOp::ListMarketplaces),
571 Op::Customize(CustomizeOp::AddMarketplace),
572 Op::Customize(CustomizeOp::RemoveMarketplace),
573 Op::Customize(CustomizeOp::RefreshMarketplace),
574 Op::Customize(CustomizeOp::Discover),
575 Op::Customize(CustomizeOp::ListPlugins),
576 Op::Customize(CustomizeOp::GetPlugin),
577 Op::Customize(CustomizeOp::InstallPlugin),
578 Op::Customize(CustomizeOp::SetPluginEnabled),
579 Op::Customize(CustomizeOp::UninstallPlugin),
580 Op::Customize(CustomizeOp::UpdatePlugin),
581 Op::Customize(CustomizeOp::ListPluginAgents),
582 Op::Customize(CustomizeOp::ListConnectors),
583 Op::Customize(CustomizeOp::GetConnector),
584 Op::Customize(CustomizeOp::AddConnector),
585 Op::Customize(CustomizeOp::SetConnectorKey),
586 Op::Customize(CustomizeOp::RemoveConnector),
587 Op::Customize(CustomizeOp::RefreshConnector),
588 Op::Customize(CustomizeOp::GrantConnector),
589 Op::Customize(CustomizeOp::RevokeConnector),
590 Op::Customize(CustomizeOp::Bundle),
591 ],
592 ),
593 (
Merge main into Artifacts Phase 2594 "Artifacts",
595 "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.",
596 &[
597 Op::Folios(FoliosOp::List),
598 Op::Folios(FoliosOp::Search),
599 Op::Folios(FoliosOp::Get),
600 Op::Folios(FoliosOp::GetContent),
601 Op::Folios(FoliosOp::ListVersions),
602 Op::Folios(FoliosOp::GetAccess),
603 Op::Folios(FoliosOp::ListTemplates),
604 Op::Folios(FoliosOp::ListSpaces),
605 Op::Folios(FoliosOp::QueryDataset),
606 Op::Folios(FoliosOp::Create),
607 Op::Folios(FoliosOp::Update),
608 Op::Folios(FoliosOp::Edit),
609 Op::Folios(FoliosOp::Trash),
610 Op::Folios(FoliosOp::Restore),
611 Op::Folios(FoliosOp::RestoreVersion),
612 Op::Folios(FoliosOp::SetAccess),
613 Op::Folios(FoliosOp::Purge),
614 ],
615 ),
Icons are cached at the edge616];
617
618/// The section of the API reference an operation is listed under.
619fn tag(op: Op) -> &'static str {
620 SECTIONS
621 .iter()
622 .find(|(_, _, ops)| ops.contains(&op))
623 .map_or("Repositories", |(name, _, _)| name)
624}
625
626/// What an operation's page is called, as a short sentence.
627fn title(op: Op) -> &'static str {
628 match op {
629 Op::Whoami => "Get the current user",
Merge branch 'worktree-agent-ad7c6d88d93adc817'630 Op::GetWorkspace => "Get a workspace",
Icons are cached at the edge631 Op::CreateWorkspace => "Create a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look632 Op::DeleteWorkspace => "Delete a workspace",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily633 Op::UpdateWorkspace => "Update a workspace",
Merge main (membership, two-factor, GitHub repo roles) into tokens634 Op::ListMembers => "List a workspace's members",
635 Op::UpdateMember => "Change a member's role",
636 Op::RemoveMember => "Remove a member",
637 Op::TransferOwnership => "Transfer a workspace's ownership",
638 Op::LeaveWorkspace => "Leave a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look639 Op::ListEmails => "List your email addresses",
640 Op::AddEmail => "Add an email address",
Merge email confirmation gate: a code and a link, nothing until confirmed (identity 0036)641 Op::ConfirmEmail => "Confirm an email address",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look642 Op::RemoveEmail => "Remove an email address",
643 Op::UpdateEmailSettings => "Change your email settings",
644 Op::ListInvites => "List your invites",
645 Op::CreateInvite => "Create an invite",
646 Op::RevokeInvite => "Revoke an invite",
647 Op::ListWorkspaceInvites => "List a workspace's invites",
648 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)649 Op::ListInvitations => "List your workspace invitations",
650 Op::AcceptInvitation => "Accept a workspace invitation",
651 Op::DeclineInvitation => "Decline a workspace invitation",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look652 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
653 Op::TransferRepo => "Transfer a repository",
654 Op::RenameRepo => "Rename a repository",
655 Op::RenameBranch => "Rename a branch",
656 Op::ArchiveRepo => "Archive a repository",
657 Op::UnarchiveRepo => "Unarchive a repository",
658 Op::SetRepoVisibility => "Change a repository's visibility",
659 Op::DeleteRepo => "Delete a repository",
660 Op::ListDeletedRepos => "List recently deleted repositories",
661 Op::RestoreRepo => "Restore a deleted repository",
662 Op::PurgeRepo => "Purge a deleted repository",
Icons are cached at the edge663 Op::ListRepos => "List repositories",
664 Op::GetRepo => "Get a repository",
665 Op::CreateRepo => "Create a repository",
666 Op::UpdateRepo => "Update a repository",
667 Op::GetRepoSettings => "Get repository settings",
668 Op::UpdateRepoSettings => "Update repository settings",
Fast pages, required checks on the branch, self-hosted runners, honest incidents669 Op::ListCheckNames => "List check names",
Icons are cached at the edge670 Op::GetMergeQueue => "Get the merge queue",
671 Op::MessageAgent => "Message an agent",
672 Op::AnswerMessage => "Answer a message",
673 Op::TakeMessages => "Take new messages",
Agents and memory, checks and conflicts, profiles, slug renames, custom domains674 Op::Remember => "Remember something",
675 Op::Recall => "Recall memory",
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API676 Op::SearchContext => "Search the context hub",
677 Op::GetEntity => "Get a catalog entry",
Search across all of g1t, Explore, and a command palette678 Op::Search => "Search g1t",
Icons are cached at the edge679 Op::ListIssues => "List issues",
680 Op::GetIssue => "Get an issue",
681 Op::CreateIssue => "Create an issue",
682 Op::UpdateIssue => "Update an issue",
683 Op::CloseIssue => "Close an issue",
684 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-agent685 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 step686 Op::Delegate => "Put an agent on it",
Icons are cached at the edge687 Op::PlanWork => "Plan work",
688 Op::GetPlan => "Get a plan",
689 Op::ApplyPlan => "Apply a plan",
690 Op::ListLabels => "List labels",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar691 Op::CreateLabel => "Create a label",
692 Op::UpdateLabel => "Update a label",
693 Op::DeleteLabel => "Delete a label",
694 Op::AddDefaultLabels => "Add the default labels",
695 Op::ListIssueLabels => "List an issue's labels",
696 Op::AddIssueLabels => "Add labels to an issue",
697 Op::SetIssueLabels => "Set an issue's labels",
698 Op::RemoveIssueLabels => "Remove labels from an issue",
699 Op::ListMilestones => "List milestones",
700 Op::GetMilestone => "Get a milestone",
701 Op::CreateMilestone => "Create a milestone",
702 Op::UpdateMilestone => "Update a milestone",
703 Op::DeleteMilestone => "Delete a milestone",
704 Op::UpdatePullRequest => "Update a pull request",
Icons are cached at the edge705 Op::AddComment => "Add a comment",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts706 Op::EditComment => "Edit a comment",
707 Op::DeleteComment => "Delete a comment",
Icons are cached at the edge708 Op::ReviewPullRequest => "Review a pull request",
709 Op::ListPullRequests => "List pull requests",
710 Op::GetPullRequest => "Get a pull request",
711 Op::CreatePullRequest => "Create a pull request",
712 Op::RecordSession => "Record session entries",
713 Op::ReadSession => "Read a session",
714 Op::MarkPullRequestReady => "Mark a pull request ready",
715 Op::ClosePullRequest => "Close a pull request",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts716 Op::ReopenPullRequest => "Reopen a pull request",
717 Op::ConvertPullRequestToDraft => "Convert a pull request to a draft",
Icons are cached at the edge718 Op::GetPullRequestChanges => "Get a pull request's changes",
719 Op::MergePullRequest => "Merge a pull request",
720 Op::ListEvents => "List repository events",
721 Op::ListIntegrations => "List integrations",
722 Op::ConnectIntegration => "Connect an integration",
AI Gateway: OpenAI's format, open models, and your own providers723 Op::UpdateIntegration => "Update an integration",
Icons are cached at the edge724 Op::DisconnectIntegration => "Disconnect an integration",
725 Op::TestIntegration => "Test an integration",
726 Op::GetContext => "Look up a ticket",
727 Op::ImportIssue => "Import an issue",
728 Op::GetModelRoutes => "Get model routes",
729 Op::SetModelRoutes => "Set model routes",
730 Op::ListWebhooks => "List webhooks",
731 Op::CreateWebhook => "Create a webhook",
732 Op::UpdateWebhook => "Update a webhook",
733 Op::DeleteWebhook => "Delete a webhook",
734 Op::PingWebhook => "Ping a webhook",
735 Op::ListWebhookDeliveries => "List webhook deliveries",
736 Op::RedeliverWebhook => "Redeliver a webhook delivery",
737 Op::ListWorkflows => "List workflows",
738 Op::ListWorkflowRuns => "List workflow runs",
739 Op::GetWorkflowRun => "Get a workflow run",
740 Op::GetJobLogs => "Get a job's log",
741 Op::DispatchWorkflow => "Run a workflow",
742 Op::CancelWorkflowRun => "Cancel a workflow run",
743 Op::RerunWorkflowRun => "Re-run a workflow run",
744 Op::UpdateWorkflow => "Turn a workflow on or off",
745 Op::ListActionsSecrets => "List secrets",
746 Op::SetActionsSecret => "Set a secret",
747 Op::DeleteActionsSecret => "Delete a secret",
748 Op::ListActionsVariables => "List variables",
749 Op::SetActionsVariable => "Set a variable",
750 Op::DeleteActionsVariable => "Delete a variable",
Fast pages, required checks on the branch, self-hosted runners, honest incidents751 Op::ListRunners => "List self-hosted runners",
752 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.753 Op::GetAgentComputer => "Get an agent's computer",
754 Op::WakeAgentComputer => "Wake an agent's computer",
755 Op::SleepAgentComputer => "Put an agent's computer to sleep",
756 Op::ResetAgentComputer => "Reset an agent's computer",
757 Op::ListAgentComputerCommands => "List an agent's computer's commands",
Fast pages, required checks on the branch, self-hosted runners, honest incidents758 Op::GetRunnerSettings => "Get runner settings",
759 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
760 Op::RemoveRunner => "Remove a self-hosted runner",
761 Op::CreateRunnerGroup => "Create a runner group",
762 Op::UpdateRunnerGroup => "Change a runner group",
763 Op::DeleteRunnerGroup => "Delete a runner group",
764 Op::UpdateRunnerSettings => "Change runner settings",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look765 Op::ListCollaborators => "List who has access",
766 Op::AddCollaborator => "Add a collaborator",
767 Op::UpdateCollaborator => "Change a collaborator's role",
768 Op::RemoveCollaborator => "Remove a collaborator",
769 Op::GetCollaboratorPermission => "Get someone's permission",
770 Op::ListRepoInvitations => "List a repository's invitations",
771 Op::RevokeRepoInvitation => "Revoke a repository invitation",
772 Op::ListMyRepoInvitations => "List your repository invitations",
773 Op::AcceptRepoInvitation => "Accept a repository invitation",
774 Op::DeclineRepoInvitation => "Decline a repository invitation",
775 Op::SetBasePermission => "Set the base permission",
776 Op::ListOutsideCollaborators => "List outside collaborators",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily777 Op::ListSecurityAlerts => "List security alerts",
778 Op::DismissSecurityAlert => "Dismiss a security alert",
779 Op::ReopenSecurityAlert => "Reopen a security alert",
API: notifications over REST and MCP, with notifications scopes780 Op::ListNotifications => "List notifications",
781 Op::MarkNotificationsRead => "Mark notifications read",
782 Op::GetNotificationThread => "Get a thread",
783 Op::MarkThreadRead => "Mark a thread read",
784 Op::MarkThreadDone => "Mark a thread done",
785 Op::SaveThread => "Save a thread",
786 Op::SnoozeThread => "Snooze a thread",
787 Op::GetThreadSubscription => "Get a thread subscription",
788 Op::SetThreadSubscription => "Set a thread subscription",
789 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
790 Op::GetRepoSubscription => "Get how you watch a repository",
791 Op::SetRepoSubscription => "Watch a repository",
792 Op::DeleteRepoSubscription => "Stop watching a repository",
793 Op::ListWatchedRepos => "List repositories you watch",
API: pinned projects over REST and MCP794 Op::ListPinnedProjects => "List your pinned projects",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit795 Op::GetUsage => "Get a workspace's usage",
796 Op::GetBudget => "Get a workspace's budget",
797 Op::SetBudget => "Change a workspace's budget",
798 Op::GetAiCredit => "Get a workspace's AI credit",
799 Op::BuyAiCredit => "Buy AI credit",
800 Op::ListInvoices => "List a workspace's invoices",
801 Op::GetBillingDetails => "Get a workspace's billing details",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens802 Op::ListGatewayRequests => "List a workspace's AI Gateway requests",
API: pinned projects over REST and MCP803 Op::PinProject => "Pin a project",
804 Op::UnpinProject => "Unpin a project",
805 Op::ReorderPinnedProjects => "Reorder your pinned projects",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97806 Op::ListProjects => "List a workspace's projects",
807 Op::GetProject => "Get a project",
808 Op::UpdateProject => "Update a project",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar809 Op::ListTeams => "List teams",
810 Op::GetTeam => "Get a team",
811 Op::CreateTeam => "Create a team",
812 Op::UpdateTeam => "Update a team",
813 Op::DeleteTeam => "Delete a team",
814 Op::ListTeamMembers => "List a team's members",
815 Op::SetTeamMember => "Add or change a team member",
816 Op::RemoveTeamMember => "Remove a team member",
817 Op::ListChildTeams => "List child teams",
818 Op::ListTeamRepos => "List a team's repositories",
819 Op::SetTeamRepo => "Give a team a role on a repository",
820 Op::RemoveTeamRepo => "Remove a team from a repository",
821 Op::SetTeamReviewAssignment => "Set a team's review assignment",
822 Op::ListUserTeams => "List someone's teams",
823 Op::RequestReviewers => "Request reviewers",
824 Op::RemoveRequestedReviewers => "Remove requested reviewers",
825 Op::GetCodeownersErrors => "List CODEOWNERS errors",
826 Op::Security(op) => op.title(),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge827 Op::Rules(op) => op.title(),
Merge checks: statuses and check runs on every commit828 Op::Checks(op) => op.title(),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97829 Op::About(op) => op.title(),
830 Op::Deployments(op) => op.title(),
Merge branch 'worktree-agent-a3abfcce648e87dca'831 Op::Protection(op) => op.title(),
API and MCP for a workspace's personal access token rules, members' tokens and approvals832 Op::Tokens(op) => op.title(),
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2833 Op::Artifacts(op) => op.title(),
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca834 Op::DeployKeys(op) => op.title(),
Merge branch 'mirroring' into artifacts-mode835 Op::Mirrors(op) => op.title(),
Merge packages: roles, Actions access, source label, soft delete, API836 Op::Packages(op) => op.title(),
Merge main into Artifacts Phase 2837 Op::Folios(op) => op.title(),
Merge branch 'customize' into main: Customize replaces the Marketplace, the Artifacts trash and spaces changes, the Security-free cleanup, with the desktop app's own title bar kept in the shell.838 Op::Customize(op) => op.title(),
Icons are cached at the edge839 }
840}
841
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look842/// Why an operation can be refused with `402 payment_required`, if it
843/// can: the ones that start an agent, when the workspace has no credit,
844/// and the ones that make a repository private in a workspace, when a free
845/// workspace's private storage has no room for it.
846fn may_need_payment(op: Op) -> Option<&'static str> {
847 match op {
848 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.849 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 look850 Op::UpdateRepo | Op::SetRepoVisibility | Op::TransferRepo => Some(
851 "A free workspace's private storage has no room for this private repository.",
852 ),
853 _ => None,
854 }
Icons are cached at the edge855}
856
857/// What the reference says beyond each operation's own description, keyed
858/// by operation id, written by hand from what the services return: `notes`
859/// (Markdown, added to the description) and example `params` (path),
860/// `query`, `request` (body) and `response`.
861const REFERENCE: &str = include_str!("reference.json");
862
863fn examples() -> Map<String, Value> {
864 match serde_json::from_str(REFERENCE) {
865 Ok(Value::Object(examples)) => examples,
866 _ => Map::new(),
867 }
868}
869
870/// `/repos/:owner/:name` as OpenAPI writes it: `/repos/{owner}/{name}`.
871fn openapi_path(route: &Route) -> String {
872 route
873 .path
874 .split('/')
875 .map(|segment| match segment.strip_prefix(':') {
876 Some(name) => format!("{{{name}}}"),
877 None => segment.to_owned(),
878 })
879 .collect::<Vec<_>>()
880 .join("/")
881}
882
883fn error_response(description: &str) -> Value {
884 json!({
885 "description": description,
886 "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } },
887 })
888}
889
890/// A parameter in the path or the query, described by the operation's
891/// input schema where it has the same name.
892fn parameter(name: &str, place: &str, required: bool, schema: Option<&Value>) -> Value {
893 let mut schema = schema.cloned().unwrap_or_else(|| json!({ "type": "string" }));
894 let description = match name {
895 "owner" => Some(Value::from("The workspace that owns the repository.")),
896 "name" => Some(Value::from("The repository's name.")),
897 _ => schema.as_object_mut().and_then(|schema| schema.remove("description")),
898 };
899 let mut parameter = json!({
900 "name": name,
901 "in": place,
902 "required": required,
903 "schema": schema,
904 });
905 if let Some(description) = description {
906 parameter["description"] = description;
907 }
908 parameter
909}
910
911/// The operation id of a route. An operation reached at a workspace's
912/// address as well as a repository's is documented once for each, with its
913/// own id; GitHub's alternative addresses for one operation keep GitHub's
914/// names.
915fn operation_id(route: &Route) -> String {
916 let op = route.op;
917 let base = match (route.method, route.path.rsplit('/').next().unwrap_or_default()) {
918 ("PUT", "enable") => "enable_workflow".to_owned(),
919 ("PUT", "disable") => "disable_workflow".to_owned(),
920 ("POST", "rerun-failed-jobs") => "rerun_failed_jobs".to_owned(),
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)921 ("POST", "rerun") if route.path.contains("/jobs/:job/") => "rerun_job".to_owned(),
922 ("POST", "force-cancel") => "force_cancel_workflow_run".to_owned(),
923 ("GET", ":attempt") => "get_workflow_run_attempt".to_owned(),
Icons are cached at the edge924 ("PATCH", ":setting") => "update_actions_variable".to_owned(),
925 ("GET", "runs") if route.path.contains("/workflows/:workflow/") => "list_runs_of_workflow".to_owned(),
API: notifications over REST and MCP, with notifications scopes926 // One repository's notifications, and an issue's subscription by
927 // its number rather than a thread's id.
928 (_, "notifications") if route.path.starts_with("/repos/") => match op {
929 Op::ListNotifications => "list_repo_notifications".to_owned(),
930 _ => "mark_repo_notifications_read".to_owned(),
931 },
932 (method, "subscription") if route.path.contains("/issues/:number/") => match method {
933 "GET" => "get_issue_subscription".to_owned(),
934 "PUT" => "set_issue_subscription".to_owned(),
935 _ => "delete_issue_subscription".to_owned(),
936 },
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar937 // One label off an issue, by its name in the path.
938 ("DELETE", ":label") if route.path.contains("/issues/:number/") => "remove_issue_label".to_owned(),
API: notifications over REST and MCP, with notifications scopes939 ("DELETE", "saved") => "unsave_thread".to_owned(),
940 ("DELETE", "snooze") => "unsnooze_thread".to_owned(),
Icons are cached at the edge941 _ => op.name().to_owned(),
942 };
943 if route.path.starts_with("/workspaces/") && ROUTES.iter().any(|other| other.op == op && other.path.starts_with("/repos/")) {
944 format!("{base}_for_workspace")
945 } else {
946 base
947 }
948}
949
950/// The summary of a route: its operation's title, or for one of GitHub's
951/// alternative addresses, what that address does.
952fn summary(route: &Route, id: &str) -> String {
953 let base = match id.trim_end_matches("_for_workspace") {
954 "enable_workflow" => "Turn a workflow on",
955 "disable_workflow" => "Turn a workflow off",
956 "rerun_failed_jobs" => "Re-run failed jobs",
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)957 "rerun_job" => "Re-run a job",
958 "force_cancel_workflow_run" => "Force-cancel a workflow run",
959 "get_workflow_run_attempt" => "Get a workflow run attempt",
Icons are cached at the edge960 "update_actions_variable" => "Update a variable",
961 "list_runs_of_workflow" => "List a workflow's runs",
API: notifications over REST and MCP, with notifications scopes962 "list_repo_notifications" => "List a repository's notifications",
963 "mark_repo_notifications_read" => "Mark a repository's notifications read",
964 "get_issue_subscription" => "Get your subscription to an issue",
965 "set_issue_subscription" => "Subscribe to an issue",
966 "delete_issue_subscription" => "Unsubscribe from an issue",
967 "unsave_thread" => "Unsave a thread",
968 "unsnooze_thread" => "Bring a snoozed thread back",
Icons are cached at the edge969 _ => title(route.op),
970 };
971 if id.ends_with("_for_workspace") {
972 format!("{base} for a workspace")
973 } else {
974 base.to_owned()
975 }
976}
977
978fn operation(route: &Route) -> Value {
979 let op = route.op;
980 let path_params: Vec<&str> = route.params().collect();
Merge checks: statuses and check runs on every commit981 // `owner` and `name` in the path stand for the operation's `repo` input,
982 // so a `name` in the body, such as a check run's, is the body's own.
983 let stands_for_repo =
984 |name: &str| matches!(name, "owner" | "name") && path_params.contains(&"owner") && path_params.contains(&"name");
985 let covered = |name: &str| name == "repo" || (path_params.contains(&name) && !stands_for_repo(name));
Icons are cached at the edge986 let all_properties = op.properties();
987 let mut properties = all_properties.clone();
988 properties.retain(|name, _| !covered(name));
989 let required: Vec<String> = op
990 .required()
991 .into_iter()
992 .filter(|name| !covered(name))
993 .collect();
994
995 let mut parameters: Vec<Value> = path_params
996 .iter()
Merge checks: statuses and check runs on every commit997 .map(|name| parameter(name, "path", true, if stands_for_repo(name) { None } else { all_properties.get(*name) }))
Icons are cached at the edge998 .collect();
999 let mut body = Value::Null;
1000 if route.method == "GET" {
1001 for (name, key) in route.query {
1002 parameters.push(parameter(
1003 name,
1004 "query",
1005 required.iter().any(|required| required == key),
1006 properties.get(*key),
1007 ));
1008 }
1009 } else if !properties.is_empty() {
1010 let mut schema = json!({ "type": "object", "properties": properties });
1011 if !required.is_empty() {
1012 schema["required"] = json!(required);
1013 }
1014 body = json!({
1015 "required": !required.is_empty(),
1016 "content": { "application/json": { "schema": schema } },
1017 });
1018 }
1019
1020 let id = operation_id(route);
1021 let mut responses = Map::new();
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1022 if route.no_content() {
1023 responses.insert("204".into(), json!({ "description": "Success. There is no body." }));
1024 } else {
1025 responses.insert(
1026 "200".into(),
1027 json!({
1028 "description": "Success.",
1029 "content": { "application/json": { "schema": {} } },
1030 }),
1031 );
1032 }
Icons are cached at the edge1033 responses.insert(
1034 "401".into(),
1035 error_response("A token is required, or the one sent is not valid."),
1036 );
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look1037 if let Some(reason) = may_need_payment(op) {
1038 responses.insert("402".into(), error_response(reason));
Icons are cached at the edge1039 }
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1040 responses.insert(
1041 "403".into(),
1042 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."),
1043 );
Search across all of g1t, Explore, and a command palette1044 if !matches!(op, Op::Whoami | Op::ListRepos | Op::Search) {
Icons are cached at the edge1045 responses.insert("404".into(), error_response("It does not exist, or you cannot see it."));
1046 }
1047 if route.method != "GET" {
1048 responses.insert(
1049 "409".into(),
1050 error_response("The request conflicts with the current state."),
1051 );
1052 }
1053 if op != Op::Whoami {
1054 responses.insert("422".into(), error_response("The input is not valid."));
1055 }
1056 // 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 step1057 let scope: Vec<&str> = scope_for(op.name()).map(|scope| scope.as_str()).into_iter().collect();
Icons are cached at the edge1058 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 step1059 json!([{ "token": scope }])
Icons are cached at the edge1060 } else {
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1061 json!([{ "token": scope }, {}])
Icons are cached at the edge1062 };
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1063 let (tool, action) = crate::tools::TOOLS
1064 .iter()
1065 .find_map(|tool| {
1066 tool.actions
1067 .iter()
1068 .find(|action| action.op == op)
1069 .map(|action| (tool.name, action.name))
1070 })
1071 .unwrap_or_default();
Icons are cached at the edge1072 let mut described = json!({
1073 "operationId": id,
1074 "tags": [tag(op)],
1075 "summary": summary(route, &id),
1076 "description": op.description(),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1077 "x-operation": op.name(),
1078 "x-mcp-tool": tool,
1079 "x-mcp-action": action,
1080 "x-scope": scope.first().copied(),
Icons are cached at the edge1081 "security": security,
1082 "parameters": parameters,
1083 "responses": responses,
1084 });
1085 if !body.is_null() {
1086 described["requestBody"] = body;
1087 }
1088 described
1089}
1090
1091/// Entries for device sign-in, which is not an operation.
1092fn onboarding() -> Map<String, Value> {
1093 let paths = json!({
1094 "/device/code": {
1095 "post": {
1096 "operationId": "device_code",
1097 "tags": ["Accounts"],
1098 "summary": "Start signing in",
1099 "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`.",
1100 "security": [],
1101 "requestBody": {
1102 "content": { "application/json": { "schema": {
1103 "type": "object",
1104 "properties": {
1105 "client_name": {
1106 "type": "string",
1107 "description": "What is asking, shown to the person approving. For example, Claude Code.",
1108 },
1109 },
1110 } } },
1111 },
1112 "responses": { "200": {
1113 "description": "The codes for this sign-in.",
1114 "content": { "application/json": { "schema": {
1115 "type": "object",
1116 "properties": {
1117 "device_code": { "type": "string", "description": "Secret. Send it to /device/token." },
1118 "user_code": { "type": "string", "description": "Shown to the person, like WDJB-MJHT." },
1119 "verification_uri": { "type": "string" },
1120 "verification_uri_complete": {
1121 "type": "string",
1122 "description": "The link to give the person; it carries the code.",
1123 },
1124 "expires_in": { "type": "integer", "description": "Seconds until the codes expire." },
1125 "interval": { "type": "integer", "description": "Seconds to wait between polls." },
1126 },
1127 } } },
1128 } },
1129 },
1130 },
1131 "/device/token": {
1132 "post": {
1133 "operationId": "device_token",
1134 "tags": ["Accounts"],
1135 "summary": "Finish signing in",
1136 "description": "Asks whether the person has approved. Poll no faster than the interval. The token is returned once.",
1137 "security": [],
1138 "requestBody": {
1139 "required": true,
1140 "content": { "application/json": { "schema": {
1141 "type": "object",
1142 "required": ["device_code"],
1143 "properties": { "device_code": { "type": "string" } },
1144 } } },
1145 },
1146 "responses": { "200": {
1147 "description": "The state of the sign-in.",
1148 "content": { "application/json": { "schema": {
1149 "type": "object",
1150 "required": ["status"],
1151 "properties": {
1152 "status": { "type": "string", "enum": ["pending", "approved", "denied", "expired"] },
1153 "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 calendar1154 "username": { "type": "string", "description": "Lowercased: what the account is found and linked by." },
1155 "display_username": { "type": "string", "description": "The username as its owner wrote it; the same as username when they chose no case." },
Icons are cached at the edge1156 "verified": {
1157 "type": "boolean",
1158 "description": "Whether the account's email is confirmed.",
1159 },
1160 },
1161 } } },
1162 } },
1163 },
1164 },
1165 });
1166 match paths {
1167 Value::Object(paths) => paths,
1168 _ => Map::new(),
1169 }
1170}
1171
1172
1173/// Puts each operation's examples, where it has them, into its request
1174/// and response. Path and query values go under `x-example-params` and
1175/// `x-example-query`, which tools that build a request can use.
1176fn attach_examples(paths: &mut Map<String, Value>) {
1177 let examples = examples();
1178 for methods in paths.values_mut() {
1179 let Some(methods) = methods.as_object_mut() else { continue };
1180 for operation in methods.values_mut() {
1181 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 step1182 let name = operation["x-operation"].as_str().unwrap_or_default().to_owned();
1183 let Some(example) = examples.get(&id).or_else(|| examples.get(&name)) else {
Icons are cached at the edge1184 continue;
1185 };
1186 if let Some(notes) = example.get("notes").and_then(Value::as_str) {
1187 let description = operation["description"].as_str().unwrap_or_default();
1188 operation["description"] = json!(format!("{description}\n\n{notes}"));
1189 }
1190 if let Some(response) = example.get("response") {
1191 let content = &mut operation["responses"]["200"]["content"]["application/json"];
1192 if content.is_object() {
1193 content["example"] = response.clone();
1194 }
1195 }
1196 if let Some(request) = example.get("request") {
1197 let content = &mut operation["requestBody"]["content"]["application/json"];
1198 if content.is_object() {
1199 content["example"] = request.clone();
1200 }
1201 }
1202 for (key, extension) in [("params", "x-example-params"), ("query", "x-example-query")] {
1203 if let Some(values) = example.get(key) {
1204 operation[extension] = values.clone();
1205 }
1206 }
1207 }
1208 }
1209}
1210
1211pub fn document() -> Value {
1212 let mut paths = onboarding();
1213 for route in ROUTES {
1214 let entry = paths
1215 .entry(openapi_path(route))
1216 .or_insert_with(|| json!({}));
1217 entry[route.method.to_lowercase()] = operation(route);
1218 }
1219 attach_examples(&mut paths);
1220 let tags: Vec<Value> = SECTIONS
1221 .iter()
1222 .map(|(name, description, ops)| {
1223 json!({
1224 "name": name,
1225 "description": description,
1226 // The section's operations in reading order, by MCP tool name.
1227 "x-tools": ops.iter().map(|op| op.name()).collect::<Vec<_>>(),
1228 })
1229 })
1230 .collect();
1231 let codes = ["unauthenticated", "payment_required", "forbidden", "not_found", "conflict", "invalid"];
1232 json!({
1233 "openapi": "3.1.0",
1234 "info": {
1235 "title": "g1t API",
1236 "version": "1",
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API1237 "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.",
Icons are cached at the edge1238 "license": { "name": "MIT", "identifier": "MIT" },
1239 },
1240 "servers": [{ "url": "https://api.g1t.sh" }],
1241 "security": [{ "token": [] }, {}],
1242 "tags": tags,
1243 "paths": paths,
1244 "components": {
1245 "securitySchemes": {
1246 "token": {
1247 "type": "http",
1248 "scheme": "bearer",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1249 "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.",
Icons are cached at the edge1250 },
1251 },
1252 "schemas": {
1253 "Error": {
1254 "type": "object",
1255 "required": ["error"],
1256 "properties": {
1257 "error": {
1258 "type": "object",
1259 "required": ["code", "message"],
1260 "properties": {
1261 "code": { "type": "string", "enum": codes },
1262 "message": { "type": "string" },
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1263 "needed_scope": {
1264 "type": "string",
1265 "description": "On a 403 for an access token without the scope the call needs: that scope, such as `issues:write`.",
1266 },
Icons are cached at the edge1267 },
1268 },
1269 },
1270 },
1271 },
1272 },
1273 })
1274}
1275
1276#[cfg(test)]
1277mod tests {
1278 use super::*;
1279
1280 #[test]
1281 fn every_route_is_documented_once() {
1282 let document = document();
1283 let mut ids = Vec::new();
1284 for (_, methods) in document["paths"].as_object().unwrap() {
1285 for (_, operation) in methods.as_object().unwrap() {
1286 ids.push(operation["operationId"].as_str().unwrap().to_owned());
1287 }
1288 }
1289 for op in Op::ALL {
1290 assert_eq!(
1291 ids.iter().filter(|id| *id == op.name()).count(),
1292 1,
1293 "{}",
1294 op.name()
1295 );
1296 }
1297 let mut unique = ids.clone();
1298 unique.sort();
1299 unique.dedup();
1300 assert_eq!(unique.len(), ids.len(), "operation ids repeat");
1301 }
1302
1303 #[test]
1304 fn path_and_query_inputs_are_not_repeated_in_the_body() {
1305 let document = document();
1306 let merge = &document["paths"]["/repos/{owner}/{name}/pulls/{number}/merge"]["post"];
1307 let body = &merge["requestBody"]["content"]["application/json"]["schema"]["properties"];
1308 assert!(body.get("keep_issue_open").is_some());
1309 assert!(body.get("repo").is_none() && body.get("number").is_none());
1310 let list = &document["paths"]["/repos"]["get"];
1311 assert_eq!(list["parameters"][0]["name"], "q");
1312 assert!(list.get("requestBody").is_none());
1313 }
1314
1315 #[test]
1316 fn every_operation_is_in_one_section() {
1317 for op in Op::ALL {
1318 let sections = SECTIONS
1319 .iter()
1320 .filter(|(_, _, ops)| ops.contains(&op))
1321 .count();
1322 assert_eq!(sections, 1, "{}", op.name());
1323 }
1324 }
1325
1326 #[test]
1327 fn titles_read_as_sentences() {
1328 assert_eq!(title(Op::CreateIssue), "Create an issue");
1329 assert_eq!(title(Op::Whoami), "Get the current user");
1330 }
1331
1332 #[test]
1333 fn every_operation_has_an_example_response() {
1334 let examples = examples();
1335 assert!(!examples.is_empty(), "reference.json does not parse");
1336 let document = document();
1337 let mut known = Vec::new();
1338 for (path, methods) in document["paths"].as_object().unwrap() {
1339 for (method, operation) in methods.as_object().unwrap() {
1340 known.push(operation["operationId"].as_str().unwrap().to_owned());
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1341 // Nothing to show for a success without a body.
1342 if operation["responses"]["204"].is_object() {
1343 continue;
1344 }
Icons are cached at the edge1345 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1346 assert!(!example.is_null(), "{method} {path} has no example response");
1347 }
1348 }
1349 for id in examples.keys() {
1350 assert!(known.contains(id), "reference.json names {id}, which is not an operation");
1351 }
1352 }
1353
1354 #[test]
1355 fn example_requests_send_only_what_the_body_takes() {
1356 let document = document();
1357 for (path, methods) in document["paths"].as_object().unwrap() {
1358 for (method, operation) in methods.as_object().unwrap() {
1359 let content = &operation["requestBody"]["content"]["application/json"];
1360 let Some(example) = content["example"].as_object() else { continue };
1361 let properties = &content["schema"]["properties"];
1362 for key in example.keys() {
1363 assert!(!properties[key].is_null(), "{method} {path}: {key} is not in the body");
1364 }
1365 }
1366 }
1367 }
1368
1369 /// The docs site's copy of the document. Run with `G1T_WRITE_OPENAPI=1`
1370 /// to rewrite it after changing an operation.
1371 #[test]
1372 fn the_docs_copy_is_current() {
1373 let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/src/data/openapi.json");
1374 let current = serde_json::to_string_pretty(&document()).unwrap() + "\n";
1375 if std::env::var_os("G1T_WRITE_OPENAPI").is_some() {
1376 std::fs::write(path, &current).unwrap();
1377 return;
1378 }
1379 let copy = std::fs::read_to_string(path).unwrap_or_default().replace("\r\n", "\n");
1380 assert!(
1381 copy == current,
1382 "apps/docs/src/data/openapi.json is out of date: run G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi"
1383 );
1384 }
1385
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API1386 /// The reference shows responses as they are sent: `snake_case`.
1387 #[test]
1388 fn example_responses_are_snake_case() {
1389 let document = document();
1390 for (path, methods) in document["paths"].as_object().unwrap() {
1391 for (method, operation) in methods.as_object().unwrap() {
1392 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1393 let leaked = g1t_kit::wire::camel_case_keys(example);
1394 assert!(leaked.is_empty(), "{method} {path} shows {leaked:?}");
1395 }
1396 }
1397 }
1398
Icons are cached at the edge1399 /// Examples never hold anything that reads as a real credential, which
1400 /// secret scanners rightly flag in a public repository: they end in `…`
1401 /// after the prefix, as `whsec_…` and `g1t_…` do.
1402 #[test]
1403 fn examples_hold_no_real_looking_secrets() {
Fast pages, required checks on the branch, self-hosted runners, honest incidents1404 let prefixes = ["whsec_", "g1t_", "g1tr_", "g1trt_", "sk_live_", "sk_test_", "ghp_", "github_pat_", "xoxb-", "AKIA"];
Icons are cached at the edge1405 for (line, text) in REFERENCE.lines().enumerate() {
1406 for prefix in prefixes {
1407 let mut rest = text;
1408 while let Some(at) = rest.find(prefix) {
1409 let after = &rest[at + prefix.len()..];
1410 let run = after.chars().take_while(|c| c.is_ascii_alphanumeric()).count();
1411 assert!(
1412 run < 12,
1413 "reference.json line {}: `{prefix}` followed by {run} characters reads as a real secret; write `{prefix}…`",
1414 line + 1
1415 );
1416 rest = after;
1417 }
1418 }
1419 }
1420 }
1421}

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