Skip to content
Sign up

flagon-io/g1t

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

Projects live: fixes from walking them end to end1//! 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;
Projects live: fixes from walking them end to end8use serde_json::{Map, Value, json};
9
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9710use crate::about::AboutOp;
The artifacts service is services/artifacts, the Worker g1t-artifacts, bound as ARTIFACTS by the API, the site and the agents; its live rooms move to it with a Durable Object transfer from g1t-docs-service, and its database, bucket, indexes and queue keep their names. The git store's binding and settings are GITSTORE, its ops scripts gitstore-*, and workflow run artifacts keep their compatible API under run_artifacts modules. The deploy tool puts a Worker that has never deployed before the Workers in its stage that bind to it, and the deploy guide gives the cutover runbook.11use crate::run_artifacts::ArtifactsOp;
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca12use crate::deploy_keys::DeployKeysOp;
Merge branch 'mirroring' into artifacts-mode13use crate::mirrors::MirrorsOp;
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9714use crate::deployments::DeploymentsOp;
Merge packages: roles, Actions access, source label, soft delete, API15use crate::packages::PackagesOp;
Merge main into Artifacts Phase 216use crate::folios::FoliosOp;
Merge branch 'worktree-agent-a3abfcce648e87dca'17use crate::protection::ProtectionOp;
API and MCP for a workspace's personal access token rules, members' tokens and approvals18use crate::token_policy::TokenOp;
Projects live: fixes from walking them end to end19use crate::operations::Op;
Merge checks: statuses and check runs on every commit20use crate::checks::ChecksOp;
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge21use crate::rules::RulesOp;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar22use crate::security::SecurityOp;
Projects live: fixes from walking them end to end23use crate::rest::{ROUTES, Route};
24
25/// The sections of the API reference: a name, what it covers, and its
26/// operations in the order a reader meets them.
27const SECTIONS: &[(&str, &str, &[Op])] = &[
28 (
29 "Accounts",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look30 "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)31 &[Op::Whoami, Op::ListEmails, Op::AddEmail, Op::ConfirmEmail, Op::RemoveEmail, Op::UpdateEmailSettings],
Projects live: fixes from walking them end to end32 ),
33 (
API: notifications over REST and MCP, with notifications scopes34 "Notifications",
35 "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.",
36 &[
37 Op::ListNotifications,
38 Op::MarkNotificationsRead,
39 Op::GetNotificationThread,
40 Op::MarkThreadRead,
41 Op::MarkThreadDone,
42 Op::SaveThread,
43 Op::SnoozeThread,
44 Op::GetThreadSubscription,
45 Op::SetThreadSubscription,
46 Op::DeleteThreadSubscription,
47 Op::GetRepoSubscription,
48 Op::SetRepoSubscription,
49 Op::DeleteRepoSubscription,
50 Op::ListWatchedRepos,
51 ],
52 ),
53 (
API: pinned projects over REST and MCP54 "Pinned projects",
55 "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.",
56 &[Op::ListPinnedProjects, Op::PinProject, Op::UnpinProject, Op::ReorderPinnedProjects],
57 ),
58 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9759 "Projects",
60 "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.",
61 &[Op::ListProjects, Op::GetProject, Op::UpdateProject],
62 ),
63 (
Projects live: fixes from walking them end to end64 "Workspaces",
65 "A workspace owns repositories and is the first part of their address. People and agents work in workspaces.",
Merge branch 'worktree-agent-ad7c6d88d93adc817'66 &[Op::GetWorkspace, Op::CreateWorkspace, Op::UpdateWorkspace, Op::DeleteWorkspace],
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look67 ),
68 (
API and MCP for a workspace's personal access token rules, members' tokens and approvals69 "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 managers70 "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 approvals71 &[
72 Op::Tokens(TokenOp::GetTokenPolicy),
73 Op::Tokens(TokenOp::SetTokenPolicy),
74 Op::Tokens(TokenOp::ListMemberTokens),
75 Op::Tokens(TokenOp::ListTokenRequests),
76 Op::Tokens(TokenOp::ReviewTokenRequest),
77 Op::Tokens(TokenOp::RevokeMemberToken),
78 ],
79 ),
80 (
Merge main (membership, two-factor, GitHub repo roles) into tokens81 "Members",
82 "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.",
83 &[Op::ListMembers, Op::UpdateMember, Op::RemoveMember, Op::TransferOwnership, Op::LeaveWorkspace],
84 ),
85 (
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look86 "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)87 "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 look88 &[
89 Op::ListInvites,
90 Op::CreateInvite,
91 Op::RevokeInvite,
92 Op::ListWorkspaceInvites,
93 Op::InviteMember,
94 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)95 Op::ListInvitations,
96 Op::AcceptInvitation,
97 Op::DeclineInvitation,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look98 ],
Projects live: fixes from walking them end to end99 ),
100 (
Usage, Billing settings and prepaid AI credit; fixes from the UX audit101 "Billing",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens102 "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 audit103 &[
104 Op::GetUsage,
105 Op::GetBudget,
106 Op::SetBudget,
107 Op::GetAiCredit,
108 Op::BuyAiCredit,
109 Op::ListInvoices,
110 Op::GetBillingDetails,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens111 Op::ListGatewayRequests,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit112 ],
113 ),
114 (
Projects live: fixes from walking them end to end115 "Repositories",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look116 "A repository, how it handles pull requests, and its timeline: renaming, archiving, moving and deleting it.",
Projects live: fixes from walking them end to end117 &[
118 Op::ListRepos,
119 Op::CreateRepo,
120 Op::GetRepo,
121 Op::UpdateRepo,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look122 Op::RenameRepo,
123 Op::RenameBranch,
124 Op::SetRepoVisibility,
125 Op::ArchiveRepo,
126 Op::UnarchiveRepo,
127 Op::TransferRepo,
128 Op::DeleteRepo,
129 Op::ListDeletedRepos,
130 Op::RestoreRepo,
131 Op::PurgeRepo,
Projects live: fixes from walking them end to end132 Op::GetRepoSettings,
133 Op::UpdateRepoSettings,
Fast pages, required checks on the branch, self-hosted runners, honest incidents134 Op::ListCheckNames,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar135 Op::GetCodeownersErrors,
Projects live: fixes from walking them end to end136 Op::ListEvents,
137 ],
138 ),
139 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97140 "Repository insights",
141 "What a repository's default branch says about it, read in the background and kept by commit: the languages it is written in, who made it, and its license.",
142 &[Op::About(AboutOp::GetLanguages), Op::About(AboutOp::ListContributors), Op::About(AboutOp::GetLicense)],
143 ),
144 (
145 "Stars",
146 "Starring a repository, to keep it and to say you like it: who starred one, and what you starred.",
147 &[
148 Op::About(AboutOp::ListStargazers),
149 Op::About(AboutOp::ListStarred),
150 Op::About(AboutOp::CheckStarred),
151 Op::About(AboutOp::Star),
152 Op::About(AboutOp::Unstar),
153 ],
154 ),
155 (
156 "Releases",
157 "A release is a tag published with a title and notes. The latest is the newest published one that is neither a draft nor a prerelease.",
158 &[
159 Op::About(AboutOp::ListReleases),
160 Op::About(AboutOp::CreateRelease),
161 Op::About(AboutOp::GetLatestRelease),
162 Op::About(AboutOp::GetReleaseByTag),
163 Op::About(AboutOp::GetRelease),
164 Op::About(AboutOp::UpdateRelease),
165 Op::About(AboutOp::DeleteRelease),
166 ],
167 ),
168 (
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look169 "Access",
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca170 "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 look171 &[
172 Op::ListCollaborators,
173 Op::AddCollaborator,
174 Op::UpdateCollaborator,
175 Op::RemoveCollaborator,
176 Op::GetCollaboratorPermission,
177 Op::ListRepoInvitations,
178 Op::RevokeRepoInvitation,
179 Op::ListMyRepoInvitations,
180 Op::AcceptRepoInvitation,
181 Op::DeclineRepoInvitation,
182 Op::SetBasePermission,
183 Op::ListOutsideCollaborators,
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca184 Op::DeployKeys(DeployKeysOp::ListDeployKeys),
185 Op::DeployKeys(DeployKeysOp::GetDeployKey),
186 Op::DeployKeys(DeployKeysOp::CreateDeployKey),
187 Op::DeployKeys(DeployKeysOp::DeleteDeployKey),
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look188 ],
189 ),
190 (
Merge branch 'mirroring' into artifacts-mode191 "Mirroring",
192 "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.",
193 &[
194 Op::Mirrors(MirrorsOp::GetMirror),
195 Op::Mirrors(MirrorsOp::GetHandBackPlan),
196 Op::Mirrors(MirrorsOp::TakeOver),
197 Op::Mirrors(MirrorsOp::SetCiFailover),
198 Op::Mirrors(MirrorsOp::HandBack),
199 Op::Mirrors(MirrorsOp::MoveToG1t),
200 Op::Mirrors(MirrorsOp::SyncMirror),
201 Op::Mirrors(MirrorsOp::AddRemote),
202 Op::Mirrors(MirrorsOp::UpdateRemote),
203 Op::Mirrors(MirrorsOp::RemoveRemote),
204 ],
205 ),
206 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar207 "Teams",
208 "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.",
209 &[
210 Op::ListTeams,
211 Op::CreateTeam,
212 Op::GetTeam,
213 Op::UpdateTeam,
214 Op::DeleteTeam,
215 Op::ListTeamMembers,
216 Op::SetTeamMember,
217 Op::RemoveTeamMember,
218 Op::ListChildTeams,
219 Op::ListTeamRepos,
220 Op::SetTeamRepo,
221 Op::RemoveTeamRepo,
222 Op::SetTeamReviewAssignment,
223 Op::ListUserTeams,
224 ],
225 ),
226 (
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily227 "Security",
228 "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.",
229 &[Op::ListSecurityAlerts, Op::DismissSecurityAlert, Op::ReopenSecurityAlert],
230 ),
231 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar232 "Secret scanning",
233 "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.",
234 &[
235 Op::Security(SecurityOp::ListSecretAlerts),
236 Op::Security(SecurityOp::GetSecretAlert),
237 Op::Security(SecurityOp::UpdateSecretAlert),
238 Op::Security(SecurityOp::ListSecretLocations),
239 Op::Security(SecurityOp::BypassPushProtection),
240 Op::Security(SecurityOp::CheckSecretValidity),
241 Op::Security(SecurityOp::ListBypassRequests),
242 Op::Security(SecurityOp::ReviewBypassRequest),
243 Op::Security(SecurityOp::ListCustomPatterns),
244 Op::Security(SecurityOp::CreateCustomPattern),
245 Op::Security(SecurityOp::UpdateCustomPattern),
246 Op::Security(SecurityOp::DeleteCustomPattern),
247 Op::Security(SecurityOp::DryRunCustomPattern),
248 ],
249 ),
250 (
251 "Code scanning",
252 "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.",
253 &[
254 Op::Security(SecurityOp::ListCodeAlerts),
255 Op::Security(SecurityOp::GetCodeAlert),
256 Op::Security(SecurityOp::UpdateCodeAlert),
257 Op::Security(SecurityOp::ListAnalyses),
258 Op::Security(SecurityOp::UploadSarif),
259 Op::Security(SecurityOp::GetSarifUpload),
260 Op::Security(SecurityOp::FixAlert),
261 ],
262 ),
263 (
264 "Supply chain",
265 "What a repository depends on: vulnerability alerts, the dependency graph, an SPDX SBOM of it, and comparing two commits' dependencies as dependency review does.",
266 &[
267 Op::Security(SecurityOp::ListVulnerabilityAlerts),
268 Op::Security(SecurityOp::GetVulnerabilityAlert),
269 Op::Security(SecurityOp::UpdateVulnerabilityAlert),
270 Op::Security(SecurityOp::GetDependencyGraph),
271 Op::Security(SecurityOp::GetSbom),
272 Op::Security(SecurityOp::CompareDependencies),
273 ],
274 ),
275 (
276 "Security settings",
277 "When pull request checks fail, dependency review's policy, delegated bypass and validity checks, and a workspace's security overview.",
278 &[
279 Op::Security(SecurityOp::GetSettings),
280 Op::Security(SecurityOp::UpdateSettings),
281 Op::Security(SecurityOp::GetWorkspaceSettings),
282 Op::Security(SecurityOp::UpdateWorkspaceSettings),
283 Op::Security(SecurityOp::GetOverview),
284 ],
285 ),
286 (
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge287 "Rules",
288 "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.",
289 &[
290 Op::Rules(RulesOp::ListRepoRulesets),
291 Op::Rules(RulesOp::CreateRepoRuleset),
292 Op::Rules(RulesOp::GetRepoRuleset),
293 Op::Rules(RulesOp::UpdateRepoRuleset),
294 Op::Rules(RulesOp::DeleteRepoRuleset),
295 Op::Rules(RulesOp::GetBranchRules),
296 Op::Rules(RulesOp::ListRuleEvaluations),
297 Op::Rules(RulesOp::ListWorkspaceRulesets),
298 Op::Rules(RulesOp::CreateWorkspaceRuleset),
299 Op::Rules(RulesOp::GetWorkspaceRuleset),
300 Op::Rules(RulesOp::UpdateWorkspaceRuleset),
301 Op::Rules(RulesOp::DeleteWorkspaceRuleset),
302 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
303 ],
304 ),
305 (
Merge checks: statuses and check runs on every commit306 "Checks",
307 "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.",
308 &[
309 Op::Checks(ChecksOp::CreateCommitStatus),
310 Op::Checks(ChecksOp::ListCommitStatuses),
311 Op::Checks(ChecksOp::GetCombinedStatus),
312 Op::Checks(ChecksOp::CreateCheckRun),
313 Op::Checks(ChecksOp::UpdateCheckRun),
314 Op::Checks(ChecksOp::GetCheckRun),
315 Op::Checks(ChecksOp::ListCheckRunAnnotations),
316 Op::Checks(ChecksOp::RerequestCheckRun),
317 Op::Checks(ChecksOp::ListCheckRunsForRef),
318 Op::Checks(ChecksOp::ListCheckSuitesForRef),
319 Op::Checks(ChecksOp::GetCheckSuite),
320 Op::Checks(ChecksOp::RerequestCheckSuite),
321 ],
322 ),
323 (
Projects live: fixes from walking them end to end324 "Issues",
325 "What should change in a repository, with labels and comments. Issues and pull requests share one sequence of numbers.",
326 &[
327 Op::ListIssues,
328 Op::CreateIssue,
329 Op::GetIssue,
330 Op::UpdateIssue,
331 Op::CloseIssue,
332 Op::ReopenIssue,
333 Op::AssignIssue,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step334 Op::Delegate,
Projects live: fixes from walking them end to end335 Op::AddComment,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts336 Op::EditComment,
337 Op::DeleteComment,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar338 Op::ListIssueLabels,
339 Op::AddIssueLabels,
340 Op::SetIssueLabels,
341 Op::RemoveIssueLabels,
342 ],
343 ),
344 (
345 "Labels and milestones",
346 "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.",
347 &[
Projects live: fixes from walking them end to end348 Op::ListLabels,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar349 Op::CreateLabel,
350 Op::UpdateLabel,
351 Op::DeleteLabel,
352 Op::AddDefaultLabels,
353 Op::ListMilestones,
354 Op::CreateMilestone,
355 Op::GetMilestone,
356 Op::UpdateMilestone,
357 Op::DeleteMilestone,
Projects live: fixes from walking them end to end358 ],
359 ),
360 (
361 "Plans",
362 "An outcome turned into the issues that would get there, with the order they must merge in.",
363 &[Op::PlanWork, Op::GetPlan, Op::ApplyPlan],
364 ),
365 (
366 "Pull requests",
367 "A proposed change in its own fork or on a branch. Several can be made for one issue; the one merged resolves it.",
368 &[
369 Op::ListPullRequests,
370 Op::CreatePullRequest,
371 Op::GetPullRequest,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar372 Op::UpdatePullRequest,
Projects live: fixes from walking them end to end373 Op::GetPullRequestChanges,
374 Op::MarkPullRequestReady,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts375 Op::ConvertPullRequestToDraft,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar376 Op::RequestReviewers,
377 Op::RemoveRequestedReviewers,
Projects live: fixes from walking them end to end378 Op::ReviewPullRequest,
379 Op::MergePullRequest,
380 Op::ClosePullRequest,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts381 Op::ReopenPullRequest,
Projects live: fixes from walking them end to end382 Op::GetMergeQueue,
383 Op::MessageAgent,
384 Op::AnswerMessage,
385 Op::TakeMessages,
386 ],
387 ),
388 (
389 "Sessions",
390 "The record of how a pull request was made: prompts, reasoning and the tools that ran.",
391 &[Op::ReadSession, Op::RecordSession],
392 ),
393 (
Agents and memory, checks and conflicts, profiles, slug renames, custom domains394 "Memory",
395 "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.",
396 &[Op::Remember, Op::Recall],
397 ),
398 (
Search across all of g1t, Explore, and a command palette399 "Search",
400 "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.",
401 &[Op::Search],
402 ),
403 (
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API404 "Context",
405 "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.",
406 &[Op::SearchContext, Op::GetEntity],
407 ),
408 (
Projects live: fixes from walking them end to end409 "Actions",
410 "GitHub Actions workflows in .g1t/workflows, their runs, and their jobs' logs.",
411 &[
412 Op::ListWorkflows,
413 Op::ListWorkflowRuns,
414 Op::GetWorkflowRun,
415 Op::GetJobLogs,
416 Op::DispatchWorkflow,
417 Op::CancelWorkflowRun,
418 Op::RerunWorkflowRun,
419 Op::UpdateWorkflow,
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2420 Op::Artifacts(ArtifactsOp::ListArtifacts),
421 Op::Artifacts(ArtifactsOp::ListRunArtifacts),
422 Op::Artifacts(ArtifactsOp::GetArtifact),
423 Op::Artifacts(ArtifactsOp::DownloadArtifact),
424 Op::Artifacts(ArtifactsOp::DeleteArtifact),
425 Op::Artifacts(ArtifactsOp::GetArtifactRetention),
426 Op::Artifacts(ArtifactsOp::SetArtifactRetention),
Projects live: fixes from walking them end to end427 ],
428 ),
429 (
Merge packages: roles, Actions access, source label, soft delete, API430 "Packages",
431 "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.",
432 &[
433 Op::Packages(PackagesOp::ListPackages),
434 Op::Packages(PackagesOp::GetPackage),
435 Op::Packages(PackagesOp::UpdatePackage),
436 Op::Packages(PackagesOp::DeletePackage),
437 Op::Packages(PackagesOp::RestorePackage),
438 Op::Packages(PackagesOp::ListVersions),
439 Op::Packages(PackagesOp::GetVersion),
440 Op::Packages(PackagesOp::DeleteVersion),
441 Op::Packages(PackagesOp::RestoreVersion),
442 Op::Packages(PackagesOp::LinkPackage),
443 Op::Packages(PackagesOp::UnlinkPackage),
444 Op::Packages(PackagesOp::ListAccess),
445 Op::Packages(PackagesOp::SetAccess),
446 Op::Packages(PackagesOp::RemoveAccess),
447 Op::Packages(PackagesOp::ListActionsAccess),
448 Op::Packages(PackagesOp::SetActionsAccess),
449 Op::Packages(PackagesOp::RemoveActionsAccess),
450 ],
451 ),
452 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97453 "Deployments",
454 "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.",
455 &[
456 Op::Deployments(DeploymentsOp::ListDeployments),
457 Op::Deployments(DeploymentsOp::CreateDeployment),
458 Op::Deployments(DeploymentsOp::GetDeployment),
459 Op::Deployments(DeploymentsOp::ListDeploymentStatuses),
460 Op::Deployments(DeploymentsOp::CreateDeploymentStatus),
461 Op::Deployments(DeploymentsOp::ListEnvironments),
462 Op::Deployments(DeploymentsOp::GetEnvironment),
463 ],
464 ),
465 (
Merge branch 'worktree-agent-a3abfcce648e87dca'466 "Run protection",
467 "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.",
468 &[
469 Op::Protection(ProtectionOp::UpdateEnvironment),
470 Op::Protection(ProtectionOp::DeleteEnvironment),
471 Op::Protection(ProtectionOp::GetPendingDeployments),
472 Op::Protection(ProtectionOp::ReviewPendingDeployments),
473 Op::Protection(ProtectionOp::ApproveWorkflowRun),
474 Op::Protection(ProtectionOp::GetWorkflowPermissions),
475 Op::Protection(ProtectionOp::SetWorkflowPermissions),
476 Op::Protection(ProtectionOp::GetForkPrApproval),
477 Op::Protection(ProtectionOp::SetForkPrApproval),
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts478 Op::Protection(ProtectionOp::GetActionsAccess),
479 Op::Protection(ProtectionOp::SetActionsAccess),
Merge branch 'worktree-agent-a3abfcce648e87dca'480 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
481 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
482 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
483 ],
484 ),
485 (
Projects live: fixes from walking them end to end486 "Secrets and variables",
487 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
488 &[
489 Op::ListActionsSecrets,
490 Op::SetActionsSecret,
491 Op::DeleteActionsSecret,
492 Op::ListActionsVariables,
493 Op::SetActionsVariable,
494 Op::DeleteActionsVariable,
495 ],
496 ),
497 (
Fast pages, required checks on the branch, self-hosted runners, honest incidents498 "Runners",
499 "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.",
500 &[
501 Op::ListRunners,
502 Op::CreateRunnerRegistrationToken,
503 Op::RemoveRunner,
504 Op::ListRunnerGroups,
505 Op::CreateRunnerGroup,
506 Op::UpdateRunnerGroup,
507 Op::DeleteRunnerGroup,
508 Op::GetRunnerSettings,
509 Op::UpdateRunnerSettings,
510 ],
511 ),
512 (
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.513 "Agents' computers",
514 "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.",
515 &[
516 Op::GetAgentComputer,
517 Op::WakeAgentComputer,
518 Op::SleepAgentComputer,
519 Op::ResetAgentComputer,
520 Op::ListAgentComputerCommands,
521 ],
522 ),
523 (
Projects live: fixes from walking them end to end524 "Webhooks",
525 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
526 &[
527 Op::ListWebhooks,
528 Op::CreateWebhook,
529 Op::UpdateWebhook,
530 Op::DeleteWebhook,
531 Op::PingWebhook,
532 Op::ListWebhookDeliveries,
533 Op::RedeliverWebhook,
534 ],
535 ),
536 (
537 "Integrations",
538 "A workspace's connections to outside systems: model providers, alert sources and issue trackers.",
539 &[
540 Op::ListIntegrations,
541 Op::ConnectIntegration,
AI Gateway: OpenAI's format, open models, and your own providers542 Op::UpdateIntegration,
Projects live: fixes from walking them end to end543 Op::DisconnectIntegration,
544 Op::TestIntegration,
545 Op::GetModelRoutes,
546 Op::SetModelRoutes,
547 Op::GetContext,
548 Op::ImportIssue,
549 ],
550 ),
Merge main into Artifacts Phase 2551 (
552 "Artifacts",
553 "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.",
554 &[
555 Op::Folios(FoliosOp::List),
556 Op::Folios(FoliosOp::Search),
557 Op::Folios(FoliosOp::Get),
558 Op::Folios(FoliosOp::GetContent),
559 Op::Folios(FoliosOp::ListVersions),
560 Op::Folios(FoliosOp::GetAccess),
561 Op::Folios(FoliosOp::ListTemplates),
562 Op::Folios(FoliosOp::ListSpaces),
563 Op::Folios(FoliosOp::QueryDataset),
564 Op::Folios(FoliosOp::Create),
565 Op::Folios(FoliosOp::Update),
566 Op::Folios(FoliosOp::Edit),
567 Op::Folios(FoliosOp::Trash),
568 Op::Folios(FoliosOp::Restore),
569 Op::Folios(FoliosOp::RestoreVersion),
570 Op::Folios(FoliosOp::SetAccess),
571 Op::Folios(FoliosOp::Purge),
572 ],
573 ),
Projects live: fixes from walking them end to end574];
575
576/// The section of the API reference an operation is listed under.
577fn tag(op: Op) -> &'static str {
578 SECTIONS
579 .iter()
580 .find(|(_, _, ops)| ops.contains(&op))
581 .map_or("Repositories", |(name, _, _)| name)
582}
583
584/// What an operation's page is called, as a short sentence.
585fn title(op: Op) -> &'static str {
586 match op {
587 Op::Whoami => "Get the current user",
Merge branch 'worktree-agent-ad7c6d88d93adc817'588 Op::GetWorkspace => "Get a workspace",
Projects live: fixes from walking them end to end589 Op::CreateWorkspace => "Create a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look590 Op::DeleteWorkspace => "Delete a workspace",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily591 Op::UpdateWorkspace => "Update a workspace",
Merge main (membership, two-factor, GitHub repo roles) into tokens592 Op::ListMembers => "List a workspace's members",
593 Op::UpdateMember => "Change a member's role",
594 Op::RemoveMember => "Remove a member",
595 Op::TransferOwnership => "Transfer a workspace's ownership",
596 Op::LeaveWorkspace => "Leave a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look597 Op::ListEmails => "List your email addresses",
598 Op::AddEmail => "Add an email address",
Merge email confirmation gate: a code and a link, nothing until confirmed (identity 0036)599 Op::ConfirmEmail => "Confirm an email address",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look600 Op::RemoveEmail => "Remove an email address",
601 Op::UpdateEmailSettings => "Change your email settings",
602 Op::ListInvites => "List your invites",
603 Op::CreateInvite => "Create an invite",
604 Op::RevokeInvite => "Revoke an invite",
605 Op::ListWorkspaceInvites => "List a workspace's invites",
606 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)607 Op::ListInvitations => "List your workspace invitations",
608 Op::AcceptInvitation => "Accept a workspace invitation",
609 Op::DeclineInvitation => "Decline a workspace invitation",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look610 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
611 Op::TransferRepo => "Transfer a repository",
612 Op::RenameRepo => "Rename a repository",
613 Op::RenameBranch => "Rename a branch",
614 Op::ArchiveRepo => "Archive a repository",
615 Op::UnarchiveRepo => "Unarchive a repository",
616 Op::SetRepoVisibility => "Change a repository's visibility",
617 Op::DeleteRepo => "Delete a repository",
618 Op::ListDeletedRepos => "List recently deleted repositories",
619 Op::RestoreRepo => "Restore a deleted repository",
620 Op::PurgeRepo => "Purge a deleted repository",
Projects live: fixes from walking them end to end621 Op::ListRepos => "List repositories",
622 Op::GetRepo => "Get a repository",
623 Op::CreateRepo => "Create a repository",
624 Op::UpdateRepo => "Update a repository",
625 Op::GetRepoSettings => "Get repository settings",
626 Op::UpdateRepoSettings => "Update repository settings",
Fast pages, required checks on the branch, self-hosted runners, honest incidents627 Op::ListCheckNames => "List check names",
Projects live: fixes from walking them end to end628 Op::GetMergeQueue => "Get the merge queue",
629 Op::MessageAgent => "Message an agent",
630 Op::AnswerMessage => "Answer a message",
631 Op::TakeMessages => "Take new messages",
Agents and memory, checks and conflicts, profiles, slug renames, custom domains632 Op::Remember => "Remember something",
633 Op::Recall => "Recall memory",
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API634 Op::SearchContext => "Search the context hub",
635 Op::GetEntity => "Get a catalog entry",
Search across all of g1t, Explore, and a command palette636 Op::Search => "Search g1t",
Projects live: fixes from walking them end to end637 Op::ListIssues => "List issues",
638 Op::GetIssue => "Get an issue",
639 Op::CreateIssue => "Create an issue",
640 Op::UpdateIssue => "Update an issue",
641 Op::CloseIssue => "Close an issue",
642 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-agent643 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 step644 Op::Delegate => "Put an agent on it",
Projects live: fixes from walking them end to end645 Op::PlanWork => "Plan work",
646 Op::GetPlan => "Get a plan",
647 Op::ApplyPlan => "Apply a plan",
648 Op::ListLabels => "List labels",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar649 Op::CreateLabel => "Create a label",
650 Op::UpdateLabel => "Update a label",
651 Op::DeleteLabel => "Delete a label",
652 Op::AddDefaultLabels => "Add the default labels",
653 Op::ListIssueLabels => "List an issue's labels",
654 Op::AddIssueLabels => "Add labels to an issue",
655 Op::SetIssueLabels => "Set an issue's labels",
656 Op::RemoveIssueLabels => "Remove labels from an issue",
657 Op::ListMilestones => "List milestones",
658 Op::GetMilestone => "Get a milestone",
659 Op::CreateMilestone => "Create a milestone",
660 Op::UpdateMilestone => "Update a milestone",
661 Op::DeleteMilestone => "Delete a milestone",
662 Op::UpdatePullRequest => "Update a pull request",
Projects live: fixes from walking them end to end663 Op::AddComment => "Add a comment",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts664 Op::EditComment => "Edit a comment",
665 Op::DeleteComment => "Delete a comment",
Projects live: fixes from walking them end to end666 Op::ReviewPullRequest => "Review a pull request",
667 Op::ListPullRequests => "List pull requests",
668 Op::GetPullRequest => "Get a pull request",
669 Op::CreatePullRequest => "Create a pull request",
670 Op::RecordSession => "Record session entries",
671 Op::ReadSession => "Read a session",
672 Op::MarkPullRequestReady => "Mark a pull request ready",
673 Op::ClosePullRequest => "Close a pull request",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts674 Op::ReopenPullRequest => "Reopen a pull request",
675 Op::ConvertPullRequestToDraft => "Convert a pull request to a draft",
Projects live: fixes from walking them end to end676 Op::GetPullRequestChanges => "Get a pull request's changes",
677 Op::MergePullRequest => "Merge a pull request",
678 Op::ListEvents => "List repository events",
679 Op::ListIntegrations => "List integrations",
680 Op::ConnectIntegration => "Connect an integration",
AI Gateway: OpenAI's format, open models, and your own providers681 Op::UpdateIntegration => "Update an integration",
Projects live: fixes from walking them end to end682 Op::DisconnectIntegration => "Disconnect an integration",
683 Op::TestIntegration => "Test an integration",
684 Op::GetContext => "Look up a ticket",
685 Op::ImportIssue => "Import an issue",
686 Op::GetModelRoutes => "Get model routes",
687 Op::SetModelRoutes => "Set model routes",
688 Op::ListWebhooks => "List webhooks",
689 Op::CreateWebhook => "Create a webhook",
690 Op::UpdateWebhook => "Update a webhook",
691 Op::DeleteWebhook => "Delete a webhook",
692 Op::PingWebhook => "Ping a webhook",
693 Op::ListWebhookDeliveries => "List webhook deliveries",
694 Op::RedeliverWebhook => "Redeliver a webhook delivery",
695 Op::ListWorkflows => "List workflows",
696 Op::ListWorkflowRuns => "List workflow runs",
697 Op::GetWorkflowRun => "Get a workflow run",
698 Op::GetJobLogs => "Get a job's log",
699 Op::DispatchWorkflow => "Run a workflow",
700 Op::CancelWorkflowRun => "Cancel a workflow run",
701 Op::RerunWorkflowRun => "Re-run a workflow run",
702 Op::UpdateWorkflow => "Turn a workflow on or off",
703 Op::ListActionsSecrets => "List secrets",
704 Op::SetActionsSecret => "Set a secret",
705 Op::DeleteActionsSecret => "Delete a secret",
706 Op::ListActionsVariables => "List variables",
707 Op::SetActionsVariable => "Set a variable",
708 Op::DeleteActionsVariable => "Delete a variable",
Fast pages, required checks on the branch, self-hosted runners, honest incidents709 Op::ListRunners => "List self-hosted runners",
710 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.711 Op::GetAgentComputer => "Get an agent's computer",
712 Op::WakeAgentComputer => "Wake an agent's computer",
713 Op::SleepAgentComputer => "Put an agent's computer to sleep",
714 Op::ResetAgentComputer => "Reset an agent's computer",
715 Op::ListAgentComputerCommands => "List an agent's computer's commands",
Fast pages, required checks on the branch, self-hosted runners, honest incidents716 Op::GetRunnerSettings => "Get runner settings",
717 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
718 Op::RemoveRunner => "Remove a self-hosted runner",
719 Op::CreateRunnerGroup => "Create a runner group",
720 Op::UpdateRunnerGroup => "Change a runner group",
721 Op::DeleteRunnerGroup => "Delete a runner group",
722 Op::UpdateRunnerSettings => "Change runner settings",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look723 Op::ListCollaborators => "List who has access",
724 Op::AddCollaborator => "Add a collaborator",
725 Op::UpdateCollaborator => "Change a collaborator's role",
726 Op::RemoveCollaborator => "Remove a collaborator",
727 Op::GetCollaboratorPermission => "Get someone's permission",
728 Op::ListRepoInvitations => "List a repository's invitations",
729 Op::RevokeRepoInvitation => "Revoke a repository invitation",
730 Op::ListMyRepoInvitations => "List your repository invitations",
731 Op::AcceptRepoInvitation => "Accept a repository invitation",
732 Op::DeclineRepoInvitation => "Decline a repository invitation",
733 Op::SetBasePermission => "Set the base permission",
734 Op::ListOutsideCollaborators => "List outside collaborators",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily735 Op::ListSecurityAlerts => "List security alerts",
736 Op::DismissSecurityAlert => "Dismiss a security alert",
737 Op::ReopenSecurityAlert => "Reopen a security alert",
API: notifications over REST and MCP, with notifications scopes738 Op::ListNotifications => "List notifications",
739 Op::MarkNotificationsRead => "Mark notifications read",
740 Op::GetNotificationThread => "Get a thread",
741 Op::MarkThreadRead => "Mark a thread read",
742 Op::MarkThreadDone => "Mark a thread done",
743 Op::SaveThread => "Save a thread",
744 Op::SnoozeThread => "Snooze a thread",
745 Op::GetThreadSubscription => "Get a thread subscription",
746 Op::SetThreadSubscription => "Set a thread subscription",
747 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
748 Op::GetRepoSubscription => "Get how you watch a repository",
749 Op::SetRepoSubscription => "Watch a repository",
750 Op::DeleteRepoSubscription => "Stop watching a repository",
751 Op::ListWatchedRepos => "List repositories you watch",
API: pinned projects over REST and MCP752 Op::ListPinnedProjects => "List your pinned projects",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit753 Op::GetUsage => "Get a workspace's usage",
754 Op::GetBudget => "Get a workspace's budget",
755 Op::SetBudget => "Change a workspace's budget",
756 Op::GetAiCredit => "Get a workspace's AI credit",
757 Op::BuyAiCredit => "Buy AI credit",
758 Op::ListInvoices => "List a workspace's invoices",
759 Op::GetBillingDetails => "Get a workspace's billing details",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens760 Op::ListGatewayRequests => "List a workspace's AI Gateway requests",
API: pinned projects over REST and MCP761 Op::PinProject => "Pin a project",
762 Op::UnpinProject => "Unpin a project",
763 Op::ReorderPinnedProjects => "Reorder your pinned projects",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97764 Op::ListProjects => "List a workspace's projects",
765 Op::GetProject => "Get a project",
766 Op::UpdateProject => "Update a project",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar767 Op::ListTeams => "List teams",
768 Op::GetTeam => "Get a team",
769 Op::CreateTeam => "Create a team",
770 Op::UpdateTeam => "Update a team",
771 Op::DeleteTeam => "Delete a team",
772 Op::ListTeamMembers => "List a team's members",
773 Op::SetTeamMember => "Add or change a team member",
774 Op::RemoveTeamMember => "Remove a team member",
775 Op::ListChildTeams => "List child teams",
776 Op::ListTeamRepos => "List a team's repositories",
777 Op::SetTeamRepo => "Give a team a role on a repository",
778 Op::RemoveTeamRepo => "Remove a team from a repository",
779 Op::SetTeamReviewAssignment => "Set a team's review assignment",
780 Op::ListUserTeams => "List someone's teams",
781 Op::RequestReviewers => "Request reviewers",
782 Op::RemoveRequestedReviewers => "Remove requested reviewers",
783 Op::GetCodeownersErrors => "List CODEOWNERS errors",
784 Op::Security(op) => op.title(),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge785 Op::Rules(op) => op.title(),
Merge checks: statuses and check runs on every commit786 Op::Checks(op) => op.title(),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97787 Op::About(op) => op.title(),
788 Op::Deployments(op) => op.title(),
Merge branch 'worktree-agent-a3abfcce648e87dca'789 Op::Protection(op) => op.title(),
API and MCP for a workspace's personal access token rules, members' tokens and approvals790 Op::Tokens(op) => op.title(),
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2791 Op::Artifacts(op) => op.title(),
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca792 Op::DeployKeys(op) => op.title(),
Merge branch 'mirroring' into artifacts-mode793 Op::Mirrors(op) => op.title(),
Merge packages: roles, Actions access, source label, soft delete, API794 Op::Packages(op) => op.title(),
Merge main into Artifacts Phase 2795 Op::Folios(op) => op.title(),
Projects live: fixes from walking them end to end796 }
797}
798
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look799/// Why an operation can be refused with `402 payment_required`, if it
800/// can: the ones that start an agent, when the workspace has no credit,
801/// and the ones that make a repository private in a workspace, when a free
802/// workspace's private storage has no room for it.
803fn may_need_payment(op: Op) -> Option<&'static str> {
804 match op {
805 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.806 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 look807 Op::UpdateRepo | Op::SetRepoVisibility | Op::TransferRepo => Some(
808 "A free workspace's private storage has no room for this private repository.",
809 ),
810 _ => None,
811 }
Projects live: fixes from walking them end to end812}
813
814/// What the reference says beyond each operation's own description, keyed
815/// by operation id, written by hand from what the services return: `notes`
816/// (Markdown, added to the description) and example `params` (path),
817/// `query`, `request` (body) and `response`.
818const REFERENCE: &str = include_str!("reference.json");
819
820fn examples() -> Map<String, Value> {
821 match serde_json::from_str(REFERENCE) {
822 Ok(Value::Object(examples)) => examples,
823 _ => Map::new(),
824 }
825}
826
827/// `/repos/:owner/:name` as OpenAPI writes it: `/repos/{owner}/{name}`.
828fn openapi_path(route: &Route) -> String {
829 route
830 .path
831 .split('/')
832 .map(|segment| match segment.strip_prefix(':') {
833 Some(name) => format!("{{{name}}}"),
834 None => segment.to_owned(),
835 })
836 .collect::<Vec<_>>()
837 .join("/")
838}
839
840fn error_response(description: &str) -> Value {
841 json!({
842 "description": description,
843 "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } },
844 })
845}
846
847/// A parameter in the path or the query, described by the operation's
848/// input schema where it has the same name.
849fn parameter(name: &str, place: &str, required: bool, schema: Option<&Value>) -> Value {
850 let mut schema = schema.cloned().unwrap_or_else(|| json!({ "type": "string" }));
851 let description = match name {
852 "owner" => Some(Value::from("The workspace that owns the repository.")),
853 "name" => Some(Value::from("The repository's name.")),
854 _ => schema.as_object_mut().and_then(|schema| schema.remove("description")),
855 };
856 let mut parameter = json!({
857 "name": name,
858 "in": place,
859 "required": required,
860 "schema": schema,
861 });
862 if let Some(description) = description {
863 parameter["description"] = description;
864 }
865 parameter
866}
867
868/// The operation id of a route. An operation reached at a workspace's
869/// address as well as a repository's is documented once for each, with its
870/// own id; GitHub's alternative addresses for one operation keep GitHub's
871/// names.
872fn operation_id(route: &Route) -> String {
873 let op = route.op;
874 let base = match (route.method, route.path.rsplit('/').next().unwrap_or_default()) {
875 ("PUT", "enable") => "enable_workflow".to_owned(),
876 ("PUT", "disable") => "disable_workflow".to_owned(),
877 ("POST", "rerun-failed-jobs") => "rerun_failed_jobs".to_owned(),
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)878 ("POST", "rerun") if route.path.contains("/jobs/:job/") => "rerun_job".to_owned(),
879 ("POST", "force-cancel") => "force_cancel_workflow_run".to_owned(),
880 ("GET", ":attempt") => "get_workflow_run_attempt".to_owned(),
Projects live: fixes from walking them end to end881 ("PATCH", ":setting") => "update_actions_variable".to_owned(),
882 ("GET", "runs") if route.path.contains("/workflows/:workflow/") => "list_runs_of_workflow".to_owned(),
API: notifications over REST and MCP, with notifications scopes883 // One repository's notifications, and an issue's subscription by
884 // its number rather than a thread's id.
885 (_, "notifications") if route.path.starts_with("/repos/") => match op {
886 Op::ListNotifications => "list_repo_notifications".to_owned(),
887 _ => "mark_repo_notifications_read".to_owned(),
888 },
889 (method, "subscription") if route.path.contains("/issues/:number/") => match method {
890 "GET" => "get_issue_subscription".to_owned(),
891 "PUT" => "set_issue_subscription".to_owned(),
892 _ => "delete_issue_subscription".to_owned(),
893 },
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar894 // One label off an issue, by its name in the path.
895 ("DELETE", ":label") if route.path.contains("/issues/:number/") => "remove_issue_label".to_owned(),
API: notifications over REST and MCP, with notifications scopes896 ("DELETE", "saved") => "unsave_thread".to_owned(),
897 ("DELETE", "snooze") => "unsnooze_thread".to_owned(),
Projects live: fixes from walking them end to end898 _ => op.name().to_owned(),
899 };
900 if route.path.starts_with("/workspaces/") && ROUTES.iter().any(|other| other.op == op && other.path.starts_with("/repos/")) {
901 format!("{base}_for_workspace")
902 } else {
903 base
904 }
905}
906
907/// The summary of a route: its operation's title, or for one of GitHub's
908/// alternative addresses, what that address does.
909fn summary(route: &Route, id: &str) -> String {
910 let base = match id.trim_end_matches("_for_workspace") {
911 "enable_workflow" => "Turn a workflow on",
912 "disable_workflow" => "Turn a workflow off",
913 "rerun_failed_jobs" => "Re-run failed jobs",
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)914 "rerun_job" => "Re-run a job",
915 "force_cancel_workflow_run" => "Force-cancel a workflow run",
916 "get_workflow_run_attempt" => "Get a workflow run attempt",
Projects live: fixes from walking them end to end917 "update_actions_variable" => "Update a variable",
918 "list_runs_of_workflow" => "List a workflow's runs",
API: notifications over REST and MCP, with notifications scopes919 "list_repo_notifications" => "List a repository's notifications",
920 "mark_repo_notifications_read" => "Mark a repository's notifications read",
921 "get_issue_subscription" => "Get your subscription to an issue",
922 "set_issue_subscription" => "Subscribe to an issue",
923 "delete_issue_subscription" => "Unsubscribe from an issue",
924 "unsave_thread" => "Unsave a thread",
925 "unsnooze_thread" => "Bring a snoozed thread back",
Projects live: fixes from walking them end to end926 _ => title(route.op),
927 };
928 if id.ends_with("_for_workspace") {
929 format!("{base} for a workspace")
930 } else {
931 base.to_owned()
932 }
933}
934
935fn operation(route: &Route) -> Value {
936 let op = route.op;
937 let path_params: Vec<&str> = route.params().collect();
Merge checks: statuses and check runs on every commit938 // `owner` and `name` in the path stand for the operation's `repo` input,
939 // so a `name` in the body, such as a check run's, is the body's own.
940 let stands_for_repo =
941 |name: &str| matches!(name, "owner" | "name") && path_params.contains(&"owner") && path_params.contains(&"name");
942 let covered = |name: &str| name == "repo" || (path_params.contains(&name) && !stands_for_repo(name));
Projects live: fixes from walking them end to end943 let all_properties = op.properties();
944 let mut properties = all_properties.clone();
945 properties.retain(|name, _| !covered(name));
946 let required: Vec<String> = op
947 .required()
948 .into_iter()
949 .filter(|name| !covered(name))
950 .collect();
951
952 let mut parameters: Vec<Value> = path_params
953 .iter()
Merge checks: statuses and check runs on every commit954 .map(|name| parameter(name, "path", true, if stands_for_repo(name) { None } else { all_properties.get(*name) }))
Projects live: fixes from walking them end to end955 .collect();
956 let mut body = Value::Null;
957 if route.method == "GET" {
958 for (name, key) in route.query {
959 parameters.push(parameter(
960 name,
961 "query",
962 required.iter().any(|required| required == key),
963 properties.get(*key),
964 ));
965 }
966 } else if !properties.is_empty() {
967 let mut schema = json!({ "type": "object", "properties": properties });
968 if !required.is_empty() {
969 schema["required"] = json!(required);
970 }
971 body = json!({
972 "required": !required.is_empty(),
973 "content": { "application/json": { "schema": schema } },
974 });
975 }
976
977 let id = operation_id(route);
978 let mut responses = Map::new();
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts979 if route.no_content() {
980 responses.insert("204".into(), json!({ "description": "Success. There is no body." }));
981 } else {
982 responses.insert(
983 "200".into(),
984 json!({
985 "description": "Success.",
986 "content": { "application/json": { "schema": {} } },
987 }),
988 );
989 }
Projects live: fixes from walking them end to end990 responses.insert(
991 "401".into(),
992 error_response("A token is required, or the one sent is not valid."),
993 );
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look994 if let Some(reason) = may_need_payment(op) {
995 responses.insert("402".into(), error_response(reason));
Projects live: fixes from walking them end to end996 }
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step997 responses.insert(
998 "403".into(),
999 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."),
1000 );
Search across all of g1t, Explore, and a command palette1001 if !matches!(op, Op::Whoami | Op::ListRepos | Op::Search) {
Projects live: fixes from walking them end to end1002 responses.insert("404".into(), error_response("It does not exist, or you cannot see it."));
1003 }
1004 if route.method != "GET" {
1005 responses.insert(
1006 "409".into(),
1007 error_response("The request conflicts with the current state."),
1008 );
1009 }
1010 if op != Op::Whoami {
1011 responses.insert("422".into(), error_response("The input is not valid."));
1012 }
1013 // 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 step1014 let scope: Vec<&str> = scope_for(op.name()).map(|scope| scope.as_str()).into_iter().collect();
Projects live: fixes from walking them end to end1015 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 step1016 json!([{ "token": scope }])
Projects live: fixes from walking them end to end1017 } else {
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1018 json!([{ "token": scope }, {}])
Projects live: fixes from walking them end to end1019 };
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1020 let (tool, action) = crate::tools::TOOLS
1021 .iter()
1022 .find_map(|tool| {
1023 tool.actions
1024 .iter()
1025 .find(|action| action.op == op)
1026 .map(|action| (tool.name, action.name))
1027 })
1028 .unwrap_or_default();
Projects live: fixes from walking them end to end1029 let mut described = json!({
1030 "operationId": id,
1031 "tags": [tag(op)],
1032 "summary": summary(route, &id),
1033 "description": op.description(),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1034 "x-operation": op.name(),
1035 "x-mcp-tool": tool,
1036 "x-mcp-action": action,
1037 "x-scope": scope.first().copied(),
Projects live: fixes from walking them end to end1038 "security": security,
1039 "parameters": parameters,
1040 "responses": responses,
1041 });
1042 if !body.is_null() {
1043 described["requestBody"] = body;
1044 }
1045 described
1046}
1047
1048/// Entries for device sign-in, which is not an operation.
1049fn onboarding() -> Map<String, Value> {
1050 let paths = json!({
1051 "/device/code": {
1052 "post": {
1053 "operationId": "device_code",
1054 "tags": ["Accounts"],
1055 "summary": "Start signing in",
1056 "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`.",
1057 "security": [],
1058 "requestBody": {
1059 "content": { "application/json": { "schema": {
1060 "type": "object",
1061 "properties": {
1062 "client_name": {
1063 "type": "string",
1064 "description": "What is asking, shown to the person approving. For example, Claude Code.",
1065 },
1066 },
1067 } } },
1068 },
1069 "responses": { "200": {
1070 "description": "The codes for this sign-in.",
1071 "content": { "application/json": { "schema": {
1072 "type": "object",
1073 "properties": {
1074 "device_code": { "type": "string", "description": "Secret. Send it to /device/token." },
1075 "user_code": { "type": "string", "description": "Shown to the person, like WDJB-MJHT." },
1076 "verification_uri": { "type": "string" },
1077 "verification_uri_complete": {
1078 "type": "string",
1079 "description": "The link to give the person; it carries the code.",
1080 },
1081 "expires_in": { "type": "integer", "description": "Seconds until the codes expire." },
1082 "interval": { "type": "integer", "description": "Seconds to wait between polls." },
1083 },
1084 } } },
1085 } },
1086 },
1087 },
1088 "/device/token": {
1089 "post": {
1090 "operationId": "device_token",
1091 "tags": ["Accounts"],
1092 "summary": "Finish signing in",
1093 "description": "Asks whether the person has approved. Poll no faster than the interval. The token is returned once.",
1094 "security": [],
1095 "requestBody": {
1096 "required": true,
1097 "content": { "application/json": { "schema": {
1098 "type": "object",
1099 "required": ["device_code"],
1100 "properties": { "device_code": { "type": "string" } },
1101 } } },
1102 },
1103 "responses": { "200": {
1104 "description": "The state of the sign-in.",
1105 "content": { "application/json": { "schema": {
1106 "type": "object",
1107 "required": ["status"],
1108 "properties": {
1109 "status": { "type": "string", "enum": ["pending", "approved", "denied", "expired"] },
1110 "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 calendar1111 "username": { "type": "string", "description": "Lowercased: what the account is found and linked by." },
1112 "display_username": { "type": "string", "description": "The username as its owner wrote it; the same as username when they chose no case." },
Projects live: fixes from walking them end to end1113 "verified": {
1114 "type": "boolean",
1115 "description": "Whether the account's email is confirmed.",
1116 },
1117 },
1118 } } },
1119 } },
1120 },
1121 },
1122 });
1123 match paths {
1124 Value::Object(paths) => paths,
1125 _ => Map::new(),
1126 }
1127}
1128
1129
1130/// Puts each operation's examples, where it has them, into its request
1131/// and response. Path and query values go under `x-example-params` and
1132/// `x-example-query`, which tools that build a request can use.
1133fn attach_examples(paths: &mut Map<String, Value>) {
1134 let examples = examples();
1135 for methods in paths.values_mut() {
1136 let Some(methods) = methods.as_object_mut() else { continue };
1137 for operation in methods.values_mut() {
1138 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 step1139 let name = operation["x-operation"].as_str().unwrap_or_default().to_owned();
1140 let Some(example) = examples.get(&id).or_else(|| examples.get(&name)) else {
Projects live: fixes from walking them end to end1141 continue;
1142 };
1143 if let Some(notes) = example.get("notes").and_then(Value::as_str) {
1144 let description = operation["description"].as_str().unwrap_or_default();
1145 operation["description"] = json!(format!("{description}\n\n{notes}"));
1146 }
1147 if let Some(response) = example.get("response") {
1148 let content = &mut operation["responses"]["200"]["content"]["application/json"];
1149 if content.is_object() {
1150 content["example"] = response.clone();
1151 }
1152 }
1153 if let Some(request) = example.get("request") {
1154 let content = &mut operation["requestBody"]["content"]["application/json"];
1155 if content.is_object() {
1156 content["example"] = request.clone();
1157 }
1158 }
1159 for (key, extension) in [("params", "x-example-params"), ("query", "x-example-query")] {
1160 if let Some(values) = example.get(key) {
1161 operation[extension] = values.clone();
1162 }
1163 }
1164 }
1165 }
1166}
1167
1168pub fn document() -> Value {
1169 let mut paths = onboarding();
1170 for route in ROUTES {
1171 let entry = paths
1172 .entry(openapi_path(route))
1173 .or_insert_with(|| json!({}));
1174 entry[route.method.to_lowercase()] = operation(route);
1175 }
1176 attach_examples(&mut paths);
1177 let tags: Vec<Value> = SECTIONS
1178 .iter()
1179 .map(|(name, description, ops)| {
1180 json!({
1181 "name": name,
1182 "description": description,
1183 // The section's operations in reading order, by MCP tool name.
1184 "x-tools": ops.iter().map(|op| op.name()).collect::<Vec<_>>(),
1185 })
1186 })
1187 .collect();
1188 let codes = ["unauthenticated", "payment_required", "forbidden", "not_found", "conflict", "invalid"];
1189 json!({
1190 "openapi": "3.1.0",
1191 "info": {
1192 "title": "g1t API",
1193 "version": "1",
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API1194 "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.",
Projects live: fixes from walking them end to end1195 "license": { "name": "MIT", "identifier": "MIT" },
1196 },
1197 "servers": [{ "url": "https://api.g1t.sh" }],
1198 "security": [{ "token": [] }, {}],
1199 "tags": tags,
1200 "paths": paths,
1201 "components": {
1202 "securitySchemes": {
1203 "token": {
1204 "type": "http",
1205 "scheme": "bearer",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1206 "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.",
Projects live: fixes from walking them end to end1207 },
1208 },
1209 "schemas": {
1210 "Error": {
1211 "type": "object",
1212 "required": ["error"],
1213 "properties": {
1214 "error": {
1215 "type": "object",
1216 "required": ["code", "message"],
1217 "properties": {
1218 "code": { "type": "string", "enum": codes },
1219 "message": { "type": "string" },
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1220 "needed_scope": {
1221 "type": "string",
1222 "description": "On a 403 for an access token without the scope the call needs: that scope, such as `issues:write`.",
1223 },
Projects live: fixes from walking them end to end1224 },
1225 },
1226 },
1227 },
1228 },
1229 },
1230 })
1231}
1232
1233#[cfg(test)]
1234mod tests {
1235 use super::*;
1236
1237 #[test]
1238 fn every_route_is_documented_once() {
1239 let document = document();
1240 let mut ids = Vec::new();
1241 for (_, methods) in document["paths"].as_object().unwrap() {
1242 for (_, operation) in methods.as_object().unwrap() {
1243 ids.push(operation["operationId"].as_str().unwrap().to_owned());
1244 }
1245 }
1246 for op in Op::ALL {
1247 assert_eq!(
1248 ids.iter().filter(|id| *id == op.name()).count(),
1249 1,
1250 "{}",
1251 op.name()
1252 );
1253 }
1254 let mut unique = ids.clone();
1255 unique.sort();
1256 unique.dedup();
1257 assert_eq!(unique.len(), ids.len(), "operation ids repeat");
1258 }
1259
1260 #[test]
1261 fn path_and_query_inputs_are_not_repeated_in_the_body() {
1262 let document = document();
1263 let merge = &document["paths"]["/repos/{owner}/{name}/pulls/{number}/merge"]["post"];
1264 let body = &merge["requestBody"]["content"]["application/json"]["schema"]["properties"];
1265 assert!(body.get("keep_issue_open").is_some());
1266 assert!(body.get("repo").is_none() && body.get("number").is_none());
1267 let list = &document["paths"]["/repos"]["get"];
1268 assert_eq!(list["parameters"][0]["name"], "q");
1269 assert!(list.get("requestBody").is_none());
1270 }
1271
1272 #[test]
1273 fn every_operation_is_in_one_section() {
1274 for op in Op::ALL {
1275 let sections = SECTIONS
1276 .iter()
1277 .filter(|(_, _, ops)| ops.contains(&op))
1278 .count();
1279 assert_eq!(sections, 1, "{}", op.name());
1280 }
1281 }
1282
1283 #[test]
1284 fn titles_read_as_sentences() {
1285 assert_eq!(title(Op::CreateIssue), "Create an issue");
1286 assert_eq!(title(Op::Whoami), "Get the current user");
1287 }
1288
1289 #[test]
1290 fn every_operation_has_an_example_response() {
1291 let examples = examples();
1292 assert!(!examples.is_empty(), "reference.json does not parse");
1293 let document = document();
1294 let mut known = Vec::new();
1295 for (path, methods) in document["paths"].as_object().unwrap() {
1296 for (method, operation) in methods.as_object().unwrap() {
1297 known.push(operation["operationId"].as_str().unwrap().to_owned());
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1298 // Nothing to show for a success without a body.
1299 if operation["responses"]["204"].is_object() {
1300 continue;
1301 }
Projects live: fixes from walking them end to end1302 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1303 assert!(!example.is_null(), "{method} {path} has no example response");
1304 }
1305 }
1306 for id in examples.keys() {
1307 assert!(known.contains(id), "reference.json names {id}, which is not an operation");
1308 }
1309 }
1310
1311 #[test]
1312 fn example_requests_send_only_what_the_body_takes() {
1313 let document = document();
1314 for (path, methods) in document["paths"].as_object().unwrap() {
1315 for (method, operation) in methods.as_object().unwrap() {
1316 let content = &operation["requestBody"]["content"]["application/json"];
1317 let Some(example) = content["example"].as_object() else { continue };
1318 let properties = &content["schema"]["properties"];
1319 for key in example.keys() {
1320 assert!(!properties[key].is_null(), "{method} {path}: {key} is not in the body");
1321 }
1322 }
1323 }
1324 }
1325
1326 /// The docs site's copy of the document. Run with `G1T_WRITE_OPENAPI=1`
1327 /// to rewrite it after changing an operation.
1328 #[test]
1329 fn the_docs_copy_is_current() {
1330 let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/src/data/openapi.json");
1331 let current = serde_json::to_string_pretty(&document()).unwrap() + "\n";
1332 if std::env::var_os("G1T_WRITE_OPENAPI").is_some() {
1333 std::fs::write(path, &current).unwrap();
1334 return;
1335 }
1336 let copy = std::fs::read_to_string(path).unwrap_or_default().replace("\r\n", "\n");
1337 assert!(
1338 copy == current,
1339 "apps/docs/src/data/openapi.json is out of date: run G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi"
1340 );
1341 }
1342
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API1343 /// The reference shows responses as they are sent: `snake_case`.
1344 #[test]
1345 fn example_responses_are_snake_case() {
1346 let document = document();
1347 for (path, methods) in document["paths"].as_object().unwrap() {
1348 for (method, operation) in methods.as_object().unwrap() {
1349 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1350 let leaked = g1t_kit::wire::camel_case_keys(example);
1351 assert!(leaked.is_empty(), "{method} {path} shows {leaked:?}");
1352 }
1353 }
1354 }
1355
Projects live: fixes from walking them end to end1356 /// Examples never hold anything that reads as a real credential, which
1357 /// secret scanners rightly flag in a public repository: they end in `…`
1358 /// after the prefix, as `whsec_…` and `g1t_…` do.
1359 #[test]
1360 fn examples_hold_no_real_looking_secrets() {
Fast pages, required checks on the branch, self-hosted runners, honest incidents1361 let prefixes = ["whsec_", "g1t_", "g1tr_", "g1trt_", "sk_live_", "sk_test_", "ghp_", "github_pat_", "xoxb-", "AKIA"];
Projects live: fixes from walking them end to end1362 for (line, text) in REFERENCE.lines().enumerate() {
1363 for prefix in prefixes {
1364 let mut rest = text;
1365 while let Some(at) = rest.find(prefix) {
1366 let after = &rest[at + prefix.len()..];
1367 let run = after.chars().take_while(|c| c.is_ascii_alphanumeric()).count();
1368 assert!(
1369 run < 12,
1370 "reference.json line {}: `{prefix}` followed by {run} characters reads as a real secret; write `{prefix}…`",
1371 line + 1
1372 );
1373 rest = after;
1374 }
1375 }
1376 }
1377 }
1378}

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