Skip to content
Sign up

flagon-io/g1t

public
00

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

g1t.sh
gitagentscloudflarerustforgemcp
1,405 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.

Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP1//! The OpenAPI document, generated from the same list the routes are.
2//!
3//! The docs site builds its API reference from a copy of this document,
4//! `apps/docs/src/data/openapi.json`. A test keeps the copy current: run
5//! `G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi` to rewrite it.
6
7use g1t_contracts::scopes::scope_for;
8use serde_json::{Map, Value, json};
9
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-a3b9b1f730f55b5bf'12use crate::caches::CachesOp;
Merge GitHub pull request #8 (claude/cool-newton-7nm8r9): Docker deployments on g1t.page behind a switch that stays off until Cloudflare's container APIs are checked live, workflows a workspace manages in its repositories, tarball and zipball downloads, refs/pull/* kept to g1t alone, framework detection for g1t.page builds, and a workflow's event payload matching GitHub's.13use crate::archives::ArchiveOp;
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca14use crate::deploy_keys::DeployKeysOp;
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9715use crate::deployments::DeploymentsOp;
Projects have Observability: their requests, logs, traces, metrics and errors, from apps on g1t.page with nothing to set up, and from software anywhere else over OpenTelemetry.16use crate::telemetry::TelemetryOp;
Merge packages: roles, Actions access, source label, soft delete, API17use crate::packages::PackagesOp;
Merge main into Artifacts Phase 218use crate::folios::FoliosOp;
Merge branch 'worktree-agent-a6ec0a89d7fe7a9ae'19use crate::coordination::CoordinationOp;
Merge branch 'worktree-agent-a3abfcce648e87dca'20use crate::protection::ProtectionOp;
API and MCP for a workspace's personal access token rules, members' tokens and approvals21use crate::token_policy::TokenOp;
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP22use crate::operations::Op;
Merge checks: statuses and check runs on every commit23use crate::checks::ChecksOp;
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge24use crate::rules::RulesOp;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar25use crate::security::SecurityOp;
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP26use crate::rest::{ROUTES, Route};
27
28/// The sections of the API reference: a name, what it covers, and its
29/// operations in the order a reader meets them.
30const SECTIONS: &[(&str, &str, &[Op])] = &[
31 (
32 "Accounts",
33 "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)34 &[Op::Whoami, Op::ListEmails, Op::AddEmail, Op::ConfirmEmail, Op::RemoveEmail, Op::UpdateEmailSettings],
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP35 ),
36 (
37 "Notifications",
38 "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.",
39 &[
40 Op::ListNotifications,
41 Op::MarkNotificationsRead,
42 Op::GetNotificationThread,
43 Op::MarkThreadRead,
44 Op::MarkThreadDone,
45 Op::SaveThread,
46 Op::SnoozeThread,
47 Op::GetThreadSubscription,
48 Op::SetThreadSubscription,
49 Op::DeleteThreadSubscription,
50 Op::GetRepoSubscription,
51 Op::SetRepoSubscription,
52 Op::DeleteRepoSubscription,
53 Op::ListWatchedRepos,
54 ],
55 ),
56 (
API: pinned projects over REST and MCP57 "Pinned projects",
58 "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.",
59 &[Op::ListPinnedProjects, Op::PinProject, Op::UnpinProject, Op::ReorderPinnedProjects],
60 ),
61 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9762 "Projects",
63 "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.",
64 &[Op::ListProjects, Op::GetProject, Op::UpdateProject],
65 ),
66 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP67 "Workspaces",
68 "A workspace owns repositories and is the first part of their address. People and agents work in workspaces.",
g1t coordinates the work and the person's own sessions do it: Ask g1t reads g1t with the same tools any agent gets, answers in one conversation shared with the @g1t direct message in Chat, and hands work to sessions in the person's own harness, whose subagents g1t records, ties to issues and pull requests, and lets see each other.69 &[Op::GetWorkspace, Op::CreateWorkspace, Op::UpdateWorkspace, Op::DeleteWorkspace, Op::GetWorkspaceActivity],
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP70 ),
71 (
API and MCP for a workspace's personal access token rules, members' tokens and approvals72 "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 managers73 "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 approvals74 &[
75 Op::Tokens(TokenOp::GetTokenPolicy),
76 Op::Tokens(TokenOp::SetTokenPolicy),
77 Op::Tokens(TokenOp::ListMemberTokens),
78 Op::Tokens(TokenOp::ListTokenRequests),
79 Op::Tokens(TokenOp::ReviewTokenRequest),
80 Op::Tokens(TokenOp::RevokeMemberToken),
81 ],
82 ),
83 (
Merge main (membership, two-factor, GitHub repo roles) into tokens84 "Members",
85 "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.",
86 &[Op::ListMembers, Op::UpdateMember, Op::RemoveMember, Op::TransferOwnership, Op::LeaveWorkspace],
87 ),
88 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP89 "Invites",
Merge branch 'worktree-agent-a6da31375506fc440'90 "Inviting a friend to g1t by email, inviting people into a workspace by username or email, and answering the invitations to workspaces sent to you. Anyone can sign up for g1t without an invite.",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP91 &[
Merge branch 'worktree-agent-a6da31375506fc440'92 Op::ListInvites,
93 Op::CreateInvite,
94 Op::RevokeInvite,
95 Op::ResendInvite,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP96 Op::ListWorkspaceInvites,
97 Op::InviteMember,
98 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)99 Op::ListInvitations,
100 Op::AcceptInvitation,
101 Op::DeclineInvitation,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP102 ],
103 ),
104 (
Usage, Billing settings and prepaid AI credit; fixes from the UX audit105 "Billing",
Billing, integrations, security and identity no longer serve g1t's own agents. Billing stops metering agent runs, model tokens and AI Gateway requests, drops its model catalogue and price-keeper model prices, and stops selling AI credit, which only ever paid for those; credit bought earlier still pays toward what is owed. A usage report, statement or invoice that holds an old agent or model meter shows it as "Other usage" rather than failing, and the get_ai_credit and buy_ai_credit API operations and MCP billing actions go. Integrations no longer connects model providers or routes models, and no longer assigns imported issues or alerts to g1t; a model provider already connected can still be disconnected. Security drops "Fix with g1t". Identity no longer creates agent tokens or puts agents on teams, a team's lead is a person, and run credentials are issued only for checks, the merge queue, merge checks, deployments and bumps; tokens and credentials already issued keep working until they expire. The reserved names g1t and g1t-agent stay reserved. No tables are dropped.106 "A workspace's usage, its budget and its invoices. Members read them; owners change the budget, as people. A run's token never changes billing.",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit107 &[
108 Op::GetUsage,
109 Op::GetBudget,
110 Op::SetBudget,
111 Op::ListInvoices,
112 Op::GetBillingDetails,
113 ],
114 ),
115 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP116 "Repositories",
Merge GitHub pull request #8 (claude/cool-newton-7nm8r9): Docker deployments on g1t.page behind a switch that stays off until Cloudflare's container APIs are checked live, workflows a workspace manages in its repositories, tarball and zipball downloads, refs/pull/* kept to g1t alone, framework detection for g1t.page builds, and a workflow's event payload matching GitHub's.117 "A repository, how it handles pull requests, and its timeline: renaming, archiving, moving and deleting it; and its files at a branch, tag or commit as a tarball or zipball.",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP118 &[
119 Op::ListRepos,
120 Op::CreateRepo,
121 Op::GetRepo,
g1t coordinates the work and the person's own sessions do it: Ask g1t reads g1t with the same tools any agent gets, answers in one conversation shared with the @g1t direct message in Chat, and hands work to sessions in the person's own harness, whose subagents g1t records, ties to issues and pull requests, and lets see each other.122 Op::GetContents,
123 Op::ListCommits,
Merge GitHub pull request #8 (claude/cool-newton-7nm8r9): Docker deployments on g1t.page behind a switch that stays off until Cloudflare's container APIs are checked live, workflows a workspace manages in its repositories, tarball and zipball downloads, refs/pull/* kept to g1t alone, framework detection for g1t.page builds, and a workflow's event payload matching GitHub's.124 Op::Archives(ArchiveOp::DownloadTarball),
125 Op::Archives(ArchiveOp::DownloadZipball),
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP126 Op::UpdateRepo,
127 Op::RenameRepo,
128 Op::RenameBranch,
The Branches page does things to branches now. It has tabs (Overview, Yours, Active, Stale, All, kept in the address as ?tab=) and search; Overview shows the default branch, then the first five of your branches, the active ones and the stale ones, each linking to the rest. Each branch is a row with its name in a code chip with a copy button, who made its latest commit and when, that commit's checks, behind and ahead counts with bars drawn against the largest shown, and its pull request (the open one, else the newest merged or closed) with its state; on a phone the columns fold under the name. Yours is branches whose latest commit is the viewer's; stale is no commit in 90 days.129 Op::CreateBranch,
130 Op::DeleteBranch,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP131 Op::SetRepoVisibility,
132 Op::ArchiveRepo,
133 Op::UnarchiveRepo,
134 Op::TransferRepo,
135 Op::DeleteRepo,
136 Op::ListDeletedRepos,
137 Op::RestoreRepo,
138 Op::PurgeRepo,
139 Op::GetRepoSettings,
140 Op::UpdateRepoSettings,
141 Op::ListCheckNames,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar142 Op::GetCodeownersErrors,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP143 Op::ListEvents,
144 ],
145 ),
146 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97147 "Repository insights",
148 "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.",
149 &[Op::About(AboutOp::GetLanguages), Op::About(AboutOp::ListContributors), Op::About(AboutOp::GetLicense)],
150 ),
151 (
152 "Stars",
153 "Starring a repository, to keep it and to say you like it: who starred one, and what you starred.",
154 &[
155 Op::About(AboutOp::ListStargazers),
156 Op::About(AboutOp::ListStarred),
157 Op::About(AboutOp::CheckStarred),
158 Op::About(AboutOp::Star),
159 Op::About(AboutOp::Unstar),
160 ],
161 ),
162 (
163 "Releases",
164 "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.",
165 &[
166 Op::About(AboutOp::ListReleases),
167 Op::About(AboutOp::CreateRelease),
168 Op::About(AboutOp::GetLatestRelease),
169 Op::About(AboutOp::GetReleaseByTag),
170 Op::About(AboutOp::GetRelease),
171 Op::About(AboutOp::UpdateRelease),
172 Op::About(AboutOp::DeleteRelease),
173 ],
174 ),
175 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP176 "Access",
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca177 "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.",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP178 &[
179 Op::ListCollaborators,
180 Op::AddCollaborator,
181 Op::UpdateCollaborator,
182 Op::RemoveCollaborator,
183 Op::GetCollaboratorPermission,
184 Op::ListRepoInvitations,
185 Op::RevokeRepoInvitation,
186 Op::ListMyRepoInvitations,
187 Op::AcceptRepoInvitation,
188 Op::DeclineRepoInvitation,
189 Op::SetBasePermission,
190 Op::ListOutsideCollaborators,
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca191 Op::DeployKeys(DeployKeysOp::ListDeployKeys),
192 Op::DeployKeys(DeployKeysOp::GetDeployKey),
193 Op::DeployKeys(DeployKeysOp::CreateDeployKey),
194 Op::DeployKeys(DeployKeysOp::DeleteDeployKey),
Merge branch 'mirroring' into artifacts-mode195 ],
196 ),
197 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar198 "Teams",
199 "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.",
200 &[
201 Op::ListTeams,
202 Op::CreateTeam,
203 Op::GetTeam,
204 Op::UpdateTeam,
205 Op::DeleteTeam,
206 Op::ListTeamMembers,
207 Op::SetTeamMember,
208 Op::RemoveTeamMember,
209 Op::ListChildTeams,
210 Op::ListTeamRepos,
211 Op::SetTeamRepo,
212 Op::RemoveTeamRepo,
213 Op::SetTeamReviewAssignment,
214 Op::ListUserTeams,
215 ],
216 ),
217 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP218 "Security",
219 "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.",
220 &[Op::ListSecurityAlerts, Op::DismissSecurityAlert, Op::ReopenSecurityAlert],
221 ),
222 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar223 "Secret scanning",
224 "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.",
225 &[
226 Op::Security(SecurityOp::ListSecretAlerts),
227 Op::Security(SecurityOp::GetSecretAlert),
228 Op::Security(SecurityOp::UpdateSecretAlert),
229 Op::Security(SecurityOp::ListSecretLocations),
230 Op::Security(SecurityOp::BypassPushProtection),
231 Op::Security(SecurityOp::CheckSecretValidity),
232 Op::Security(SecurityOp::ListBypassRequests),
233 Op::Security(SecurityOp::ReviewBypassRequest),
234 Op::Security(SecurityOp::ListCustomPatterns),
235 Op::Security(SecurityOp::CreateCustomPattern),
236 Op::Security(SecurityOp::UpdateCustomPattern),
237 Op::Security(SecurityOp::DeleteCustomPattern),
238 Op::Security(SecurityOp::DryRunCustomPattern),
239 ],
240 ),
241 (
242 "Code scanning",
243 "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.",
244 &[
245 Op::Security(SecurityOp::ListCodeAlerts),
246 Op::Security(SecurityOp::GetCodeAlert),
247 Op::Security(SecurityOp::UpdateCodeAlert),
248 Op::Security(SecurityOp::ListAnalyses),
249 Op::Security(SecurityOp::UploadSarif),
250 Op::Security(SecurityOp::GetSarifUpload),
251 ],
252 ),
253 (
254 "Supply chain",
255 "What a repository depends on: vulnerability alerts, the dependency graph, an SPDX SBOM of it, and comparing two commits' dependencies as dependency review does.",
256 &[
257 Op::Security(SecurityOp::ListVulnerabilityAlerts),
258 Op::Security(SecurityOp::GetVulnerabilityAlert),
259 Op::Security(SecurityOp::UpdateVulnerabilityAlert),
260 Op::Security(SecurityOp::GetDependencyGraph),
261 Op::Security(SecurityOp::GetSbom),
262 Op::Security(SecurityOp::CompareDependencies),
263 ],
264 ),
265 (
266 "Security settings",
267 "When pull request checks fail, dependency review's policy, delegated bypass and validity checks, and a workspace's security overview.",
268 &[
269 Op::Security(SecurityOp::GetSettings),
270 Op::Security(SecurityOp::UpdateSettings),
271 Op::Security(SecurityOp::GetWorkspaceSettings),
272 Op::Security(SecurityOp::UpdateWorkspaceSettings),
273 Op::Security(SecurityOp::GetOverview),
274 ],
275 ),
276 (
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9277 "Security advisories",
278 "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.",
279 &[
280 Op::Security(SecurityOp::ListAdvisories),
281 Op::Security(SecurityOp::CreateAdvisory),
282 Op::Security(SecurityOp::GetAdvisory),
283 Op::Security(SecurityOp::UpdateAdvisory),
284 Op::Security(SecurityOp::SetAdvisoryState),
285 Op::Security(SecurityOp::ListReports),
286 Op::Security(SecurityOp::ReportVulnerability),
287 Op::Security(SecurityOp::ReviewReport),
288 ],
289 ),
290 (
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge291 "Rules",
292 "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.",
293 &[
294 Op::Rules(RulesOp::ListRepoRulesets),
295 Op::Rules(RulesOp::CreateRepoRuleset),
296 Op::Rules(RulesOp::GetRepoRuleset),
297 Op::Rules(RulesOp::UpdateRepoRuleset),
298 Op::Rules(RulesOp::DeleteRepoRuleset),
299 Op::Rules(RulesOp::GetBranchRules),
300 Op::Rules(RulesOp::ListRuleEvaluations),
301 Op::Rules(RulesOp::ListWorkspaceRulesets),
302 Op::Rules(RulesOp::CreateWorkspaceRuleset),
303 Op::Rules(RulesOp::GetWorkspaceRuleset),
304 Op::Rules(RulesOp::UpdateWorkspaceRuleset),
305 Op::Rules(RulesOp::DeleteWorkspaceRuleset),
306 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
307 ],
308 ),
309 (
Merge checks: statuses and check runs on every commit310 "Checks",
311 "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.",
312 &[
313 Op::Checks(ChecksOp::CreateCommitStatus),
314 Op::Checks(ChecksOp::ListCommitStatuses),
315 Op::Checks(ChecksOp::GetCombinedStatus),
316 Op::Checks(ChecksOp::CreateCheckRun),
317 Op::Checks(ChecksOp::UpdateCheckRun),
318 Op::Checks(ChecksOp::GetCheckRun),
319 Op::Checks(ChecksOp::ListCheckRunAnnotations),
320 Op::Checks(ChecksOp::RerequestCheckRun),
321 Op::Checks(ChecksOp::ListCheckRunsForRef),
322 Op::Checks(ChecksOp::ListCheckSuitesForRef),
323 Op::Checks(ChecksOp::GetCheckSuite),
324 Op::Checks(ChecksOp::RerequestCheckSuite),
325 ],
326 ),
327 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP328 "Issues",
329 "What should change in a repository, with labels and comments. Issues and pull requests share one sequence of numbers.",
330 &[
331 Op::ListIssues,
332 Op::CreateIssue,
333 Op::GetIssue,
334 Op::UpdateIssue,
335 Op::CloseIssue,
336 Op::ReopenIssue,
337 Op::AddComment,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts338 Op::EditComment,
339 Op::DeleteComment,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar340 Op::ListIssueLabels,
341 Op::AddIssueLabels,
342 Op::SetIssueLabels,
343 Op::RemoveIssueLabels,
344 ],
345 ),
346 (
Merge branch 'worktree-agent-a6ec0a89d7fe7a9ae'347 "Claims and work",
348 "Coordinating work on issues: an advisory, expiring claim that says you are on one (never a lock), handing it off with a note, and everything an agent needs before starting on an issue in one call. What an issue is blocked by is set with update_issue.",
349 &[
350 Op::Coordination(CoordinationOp::GetWork),
351 Op::Coordination(CoordinationOp::ClaimIssue),
352 Op::Coordination(CoordinationOp::ReleaseClaim),
353 Op::Coordination(CoordinationOp::HandOffIssue),
354 Op::Coordination(CoordinationOp::ListClaims),
355 ],
356 ),
357 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar358 "Labels and milestones",
359 "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.",
360 &[
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP361 Op::ListLabels,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar362 Op::CreateLabel,
363 Op::UpdateLabel,
364 Op::DeleteLabel,
365 Op::AddDefaultLabels,
366 Op::ListMilestones,
367 Op::CreateMilestone,
368 Op::GetMilestone,
369 Op::UpdateMilestone,
370 Op::DeleteMilestone,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP371 ],
372 ),
373 (
374 "Pull requests",
375 "A proposed change in its own fork or on a branch. Several can be made for one issue; the one merged resolves it.",
376 &[
377 Op::ListPullRequests,
378 Op::CreatePullRequest,
379 Op::GetPullRequest,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar380 Op::UpdatePullRequest,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP381 Op::GetPullRequestChanges,
382 Op::MarkPullRequestReady,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts383 Op::ConvertPullRequestToDraft,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar384 Op::RequestReviewers,
385 Op::RemoveRequestedReviewers,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP386 Op::ReviewPullRequest,
387 Op::MergePullRequest,
388 Op::ClosePullRequest,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts389 Op::ReopenPullRequest,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP390 Op::GetMergeQueue,
391 ],
392 ),
393 (
394 "Sessions",
g1t coordinates the work and the person's own sessions do it: Ask g1t reads g1t with the same tools any agent gets, answers in one conversation shared with the @g1t direct message in Chat, and hands work to sessions in the person's own harness, whose subagents g1t records, ties to issues and pull requests, and lets see each other.395 "Who is working on what, and how a pull request was made. A session is one run of your own harness (a Claude Code session, a Codex run) on a repository: started once, kept alive by heartbeats, attached to an issue and a pull request, and recording prompts, reasoning, the tools that ran, the skills used and what it touched. Each subagent is a session of its own under the one that started it. A pull request's session shows what was recorded on it. A session can also be started on an issue in your own Claude, on the workspace's Anthropic account.",
Merge branch 'worktree-agent-a6ec0a89d7fe7a9ae'396 &[
397 Op::Coordination(CoordinationOp::StartSession),
398 Op::Coordination(CoordinationOp::UpdateSession),
399 Op::Coordination(CoordinationOp::EndSession),
400 Op::Coordination(CoordinationOp::GetSession),
401 Op::Coordination(CoordinationOp::ListSessions),
402 Op::Coordination(CoordinationOp::RecordSessionEntries),
g1t coordinates the work and the person's own sessions do it: Ask g1t reads g1t with the same tools any agent gets, answers in one conversation shared with the @g1t direct message in Chat, and hands work to sessions in the person's own harness, whose subagents g1t records, ties to issues and pull requests, and lets see each other.403 Op::Coordination(CoordinationOp::StartAgentSession),
Merge branch 'worktree-agent-a6ec0a89d7fe7a9ae'404 Op::ReadSession,
405 Op::RecordSession,
406 ],
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP407 ),
408 (
Merge branch 'worktree-agent-ab8033ab973f8d99a'409 "Decisions and why",
410 "Decision records: why the work is the way it is, and how sure that is (claimed, tested by a check or the merge queue, or approved by a person). And why a line of code is the way it is: its commit, pull request, issue, decisions and session.",
411 &[Op::ListDecisions, Op::RecordDecision, Op::Why],
412 ),
413 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP414 "Search",
415 "One search across all of g1t: repositories, code, issues, pull requests, people and workspaces. Public content for everyone, and private content in workspaces you belong to.",
416 &[Op::Search],
417 ),
418 (
419 "Actions",
Merge branch 'worktree-agent-a3b9b1f730f55b5bf'420 "GitHub Actions workflows in .g1t/workflows, their runs, their jobs' logs, their artifacts, and the repository's actions/cache entries.",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP421 &[
422 Op::ListWorkflows,
Merge branch 'worktree-agent-a4db4b523bb973765'423 Op::GetWorkflow,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP424 Op::ListWorkflowRuns,
425 Op::GetWorkflowRun,
426 Op::GetJobLogs,
427 Op::DispatchWorkflow,
428 Op::CancelWorkflowRun,
429 Op::RerunWorkflowRun,
430 Op::UpdateWorkflow,
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2431 Op::Artifacts(ArtifactsOp::ListArtifacts),
432 Op::Artifacts(ArtifactsOp::ListRunArtifacts),
433 Op::Artifacts(ArtifactsOp::GetArtifact),
434 Op::Artifacts(ArtifactsOp::DownloadArtifact),
435 Op::Artifacts(ArtifactsOp::DeleteArtifact),
436 Op::Artifacts(ArtifactsOp::GetArtifactRetention),
437 Op::Artifacts(ArtifactsOp::SetArtifactRetention),
Merge branch 'worktree-agent-a3b9b1f730f55b5bf'438 Op::Caches(CachesOp::ListCaches),
439 Op::Caches(CachesOp::GetCacheUsage),
440 Op::Caches(CachesOp::DeleteCachesByKey),
441 Op::Caches(CachesOp::DeleteCache),
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP442 ],
443 ),
444 (
Merge packages: roles, Actions access, source label, soft delete, API445 "Packages",
446 "A workspace's packages in every registry: their versions and download counts, deleting and restoring them within 30 days, their visibility and repository, the people and teams with a role on them, and which repositories' workflows may use them (Manage Actions access). A package is named by its type and its name, URL-encoded where it holds a slash.",
447 &[
448 Op::Packages(PackagesOp::ListPackages),
449 Op::Packages(PackagesOp::GetPackage),
450 Op::Packages(PackagesOp::UpdatePackage),
451 Op::Packages(PackagesOp::DeletePackage),
452 Op::Packages(PackagesOp::RestorePackage),
453 Op::Packages(PackagesOp::ListVersions),
454 Op::Packages(PackagesOp::GetVersion),
455 Op::Packages(PackagesOp::DeleteVersion),
456 Op::Packages(PackagesOp::RestoreVersion),
457 Op::Packages(PackagesOp::LinkPackage),
458 Op::Packages(PackagesOp::UnlinkPackage),
459 Op::Packages(PackagesOp::ListAccess),
460 Op::Packages(PackagesOp::SetAccess),
461 Op::Packages(PackagesOp::RemoveAccess),
462 Op::Packages(PackagesOp::ListActionsAccess),
463 Op::Packages(PackagesOp::SetActionsAccess),
464 Op::Packages(PackagesOp::RemoveActionsAccess),
465 ],
466 ),
467 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97468 "Deployments",
469 "A repository's deployments wherever they run: reported from any CI with these routes, made by g1t Actions jobs with an `environment:`, or built on g1t.page. Each has statuses, shows on its commit as the check `deploy / <environment>`, and belongs to an environment.",
470 &[
471 Op::Deployments(DeploymentsOp::ListDeployments),
472 Op::Deployments(DeploymentsOp::CreateDeployment),
473 Op::Deployments(DeploymentsOp::GetDeployment),
474 Op::Deployments(DeploymentsOp::ListDeploymentStatuses),
475 Op::Deployments(DeploymentsOp::CreateDeploymentStatus),
476 Op::Deployments(DeploymentsOp::ListEnvironments),
477 Op::Deployments(DeploymentsOp::GetEnvironment),
Merge branch 'worktree-agent-a4d35ee70c50683d0' into claude/cool-newton-7nm8r9478 Op::Deployments(DeploymentsOp::StartDeploymentBuild),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97479 ],
480 ),
481 (
Projects have Observability: their requests, logs, traces, metrics and errors, from apps on g1t.page with nothing to set up, and from software anywhere else over OpenTelemetry.482 "Observability",
483 "What a project's running software did: its requests, logs, traces, grouped errors and metrics, from its apps on g1t.page with nothing to set up and from OpenTelemetry (OTLP over HTTP) sent from anywhere with an ingest token. Reading needs a role of your own on the project's repository; resolving errors, Triage; settings, ingest tokens, exports and usage, Admin.",
484 &[
485 Op::Telemetry(TelemetryOp::GetOverview),
486 Op::Telemetry(TelemetryOp::ListRequests),
487 Op::Telemetry(TelemetryOp::GetRequest),
488 Op::Telemetry(TelemetryOp::ListLogs),
489 Op::Telemetry(TelemetryOp::ListTraces),
490 Op::Telemetry(TelemetryOp::GetTrace),
491 Op::Telemetry(TelemetryOp::ListErrors),
492 Op::Telemetry(TelemetryOp::UpdateError),
493 Op::Telemetry(TelemetryOp::ListMetrics),
494 Op::Telemetry(TelemetryOp::GetMetric),
495 Op::Telemetry(TelemetryOp::GetSettings),
496 Op::Telemetry(TelemetryOp::UpdateSettings),
497 Op::Telemetry(TelemetryOp::ListTokens),
498 Op::Telemetry(TelemetryOp::CreateToken),
499 Op::Telemetry(TelemetryOp::DeleteToken),
500 Op::Telemetry(TelemetryOp::ListExports),
501 Op::Telemetry(TelemetryOp::CreateExport),
502 Op::Telemetry(TelemetryOp::UpdateExport),
503 Op::Telemetry(TelemetryOp::DeleteExport),
504 Op::Telemetry(TelemetryOp::GetUsage),
505 ],
506 ),
507 (
Merge branch 'worktree-agent-a3abfcce648e87dca'508 "Run protection",
509 "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.",
510 &[
511 Op::Protection(ProtectionOp::UpdateEnvironment),
512 Op::Protection(ProtectionOp::DeleteEnvironment),
513 Op::Protection(ProtectionOp::GetPendingDeployments),
514 Op::Protection(ProtectionOp::ReviewPendingDeployments),
515 Op::Protection(ProtectionOp::ApproveWorkflowRun),
516 Op::Protection(ProtectionOp::GetWorkflowPermissions),
517 Op::Protection(ProtectionOp::SetWorkflowPermissions),
518 Op::Protection(ProtectionOp::GetForkPrApproval),
519 Op::Protection(ProtectionOp::SetForkPrApproval),
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts520 Op::Protection(ProtectionOp::GetActionsAccess),
521 Op::Protection(ProtectionOp::SetActionsAccess),
Merge branch 'worktree-agent-a3abfcce648e87dca'522 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
523 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
524 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
Merge GitHub pull request #8 (claude/cool-newton-7nm8r9): Docker deployments on g1t.page behind a switch that stays off until Cloudflare's container APIs are checked live, workflows a workspace manages in its repositories, tarball and zipball downloads, refs/pull/* kept to g1t alone, framework detection for g1t.page builds, and a workflow's event payload matching GitHub's.525 Op::Protection(ProtectionOp::ListWorkspaceManagedWorkflows),
526 Op::Protection(ProtectionOp::CreateWorkspaceManagedWorkflow),
527 Op::Protection(ProtectionOp::UpdateWorkspaceManagedWorkflow),
528 Op::Protection(ProtectionOp::DeleteWorkspaceManagedWorkflow),
Merge branch 'worktree-agent-a3abfcce648e87dca'529 ],
530 ),
531 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP532 "Secrets and variables",
533 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
534 &[
535 Op::ListActionsSecrets,
536 Op::SetActionsSecret,
537 Op::DeleteActionsSecret,
538 Op::ListActionsVariables,
539 Op::SetActionsVariable,
540 Op::DeleteActionsVariable,
541 ],
542 ),
543 (
544 "Runners",
The API and MCP server no longer offer g1t's own agents. g1t is what your coding agents work against, not an agent of its own, so the operations that drove hosted agents are gone: messaging an agent on a pull request (message_agent, take_messages, answer_message), assigning or delegating an issue to g1t (assign_issue, delegate), plans (plan_work, get_plan, apply_plan), the context hub (search_context, get_entity), model routes, agents' computers, AI Gateway requests, "Fix with g1t" on a security alert, and every Customize route (marketplaces, plugins, connectors). The callbacks the agent sandbox reported through (/agent-runs/*, /runs/:id/usage, /plans/:id, /reviews/:id) go with them, update_repo_settings stops accepting agent_review, max_revisions and hold_low_confidence, import_issue stops accepting assign, and an old agent token with no run behind it is refused.545 "Self-hosted runners: your own machines, which run your workflow jobs for $0 of g1t compute. They register with a short-lived token and only ever connect out.",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP546 &[
547 Op::ListRunners,
548 Op::CreateRunnerRegistrationToken,
549 Op::RemoveRunner,
550 Op::ListRunnerGroups,
551 Op::CreateRunnerGroup,
552 Op::UpdateRunnerGroup,
553 Op::DeleteRunnerGroup,
554 Op::GetRunnerSettings,
555 Op::UpdateRunnerSettings,
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.556 ],
557 ),
558 (
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP559 "Webhooks",
560 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
561 &[
562 Op::ListWebhooks,
563 Op::CreateWebhook,
564 Op::UpdateWebhook,
565 Op::DeleteWebhook,
566 Op::PingWebhook,
567 Op::ListWebhookDeliveries,
568 Op::RedeliverWebhook,
569 ],
570 ),
571 (
572 "Integrations",
The contracts no longer describe g1t's own agents, and workspaces can keep their AI providers. Every consumer had already stopped using them, so the TypeScript and Rust contracts drop the workspace-agent, ability, look, skill-library, context, runner-agent and mention modules, the chat and docs RPCs agents posted and read through, the folio agent methods, the agent_waiting notification, agent.asked and memory.changed events, AI credit, token and gateway billing types, model routes and sessions, team agents, agent tokens, plan, review, message and confidence types, command rules, cost caps and confidence rules. The agents:run and models:* scopes are no longer offered by any preset, OAuth default or permission form, but a stored token or grant that names them still reads; and the removed operations are gone from the scope table, so the API's check that every operation has exactly one scope is strict again. What stored data needs in order to parse (old run and credential kinds, an agent team lead, retired rules and webhook events, old guardrail and integration settings) still parses, and a run's token is still PrincipalKind::Agent, which now means a run's token and the @g1t rows written before. The customize, marketplace, skills and claude-plugin contracts stay only until the mobile app drops its Customize screens.573 "A workspace's connections to outside systems: AI providers, alert sources and issue trackers.",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP574 &[
575 Op::ListIntegrations,
576 Op::ConnectIntegration,
AI Gateway: OpenAI's format, open models, and your own providers577 Op::UpdateIntegration,
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP578 Op::DisconnectIntegration,
579 Op::TestIntegration,
580 Op::GetContext,
581 Op::ImportIssue,
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9582 ],
583 ),
584 (
Merge main into Artifacts Phase 2585 "Artifacts",
586 "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.",
587 &[
588 Op::Folios(FoliosOp::List),
589 Op::Folios(FoliosOp::Search),
590 Op::Folios(FoliosOp::Get),
591 Op::Folios(FoliosOp::GetContent),
592 Op::Folios(FoliosOp::ListVersions),
593 Op::Folios(FoliosOp::GetAccess),
594 Op::Folios(FoliosOp::ListTemplates),
595 Op::Folios(FoliosOp::ListSpaces),
596 Op::Folios(FoliosOp::QueryDataset),
597 Op::Folios(FoliosOp::Create),
598 Op::Folios(FoliosOp::Update),
599 Op::Folios(FoliosOp::Edit),
600 Op::Folios(FoliosOp::Trash),
601 Op::Folios(FoliosOp::Restore),
602 Op::Folios(FoliosOp::RestoreVersion),
603 Op::Folios(FoliosOp::SetAccess),
604 Op::Folios(FoliosOp::Purge),
605 ],
606 ),
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP607];
608
609/// The section of the API reference an operation is listed under.
610fn tag(op: Op) -> &'static str {
611 SECTIONS
612 .iter()
613 .find(|(_, _, ops)| ops.contains(&op))
614 .map_or("Repositories", |(name, _, _)| name)
615}
616
617/// What an operation's page is called, as a short sentence.
618fn title(op: Op) -> &'static str {
619 match op {
620 Op::Whoami => "Get the current user",
Merge branch 'worktree-agent-ad7c6d88d93adc817'621 Op::GetWorkspace => "Get a workspace",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP622 Op::CreateWorkspace => "Create a workspace",
623 Op::DeleteWorkspace => "Delete a workspace",
624 Op::UpdateWorkspace => "Update a workspace",
Merge main (membership, two-factor, GitHub repo roles) into tokens625 Op::ListMembers => "List a workspace's members",
626 Op::UpdateMember => "Change a member's role",
627 Op::RemoveMember => "Remove a member",
628 Op::TransferOwnership => "Transfer a workspace's ownership",
629 Op::LeaveWorkspace => "Leave a workspace",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP630 Op::ListEmails => "List your email addresses",
631 Op::AddEmail => "Add an email address",
Merge email confirmation gate: a code and a link, nothing until confirmed (identity 0036)632 Op::ConfirmEmail => "Confirm an email address",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP633 Op::RemoveEmail => "Remove an email address",
634 Op::UpdateEmailSettings => "Change your email settings",
Merge branch 'worktree-agent-a6da31375506fc440'635 Op::ListInvites => "List your invites to g1t",
636 Op::CreateInvite => "Invite a friend to g1t",
637 Op::RevokeInvite => "Revoke an invite to g1t",
638 Op::ResendInvite => "Send an invite to g1t again",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP639 Op::ListWorkspaceInvites => "List a workspace's invites",
640 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)641 Op::ListInvitations => "List your workspace invitations",
642 Op::AcceptInvitation => "Accept a workspace invitation",
643 Op::DeclineInvitation => "Decline a workspace invitation",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP644 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
645 Op::TransferRepo => "Transfer a repository",
646 Op::RenameRepo => "Rename a repository",
647 Op::RenameBranch => "Rename a branch",
The Branches page does things to branches now. It has tabs (Overview, Yours, Active, Stale, All, kept in the address as ?tab=) and search; Overview shows the default branch, then the first five of your branches, the active ones and the stale ones, each linking to the rest. Each branch is a row with its name in a code chip with a copy button, who made its latest commit and when, that commit's checks, behind and ahead counts with bars drawn against the largest shown, and its pull request (the open one, else the newest merged or closed) with its state; on a phone the columns fold under the name. Yours is branches whose latest commit is the viewer's; stale is no commit in 90 days.648 Op::CreateBranch => "Create a branch",
649 Op::DeleteBranch => "Delete a branch",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP650 Op::ArchiveRepo => "Archive a repository",
651 Op::UnarchiveRepo => "Unarchive a repository",
652 Op::SetRepoVisibility => "Change a repository's visibility",
653 Op::DeleteRepo => "Delete a repository",
654 Op::ListDeletedRepos => "List recently deleted repositories",
655 Op::RestoreRepo => "Restore a deleted repository",
656 Op::PurgeRepo => "Purge a deleted repository",
657 Op::ListRepos => "List repositories",
658 Op::GetRepo => "Get a repository",
659 Op::CreateRepo => "Create a repository",
660 Op::UpdateRepo => "Update a repository",
661 Op::GetRepoSettings => "Get repository settings",
662 Op::UpdateRepoSettings => "Update repository settings",
663 Op::ListCheckNames => "List check names",
664 Op::GetMergeQueue => "Get the merge queue",
665 Op::Search => "Search g1t",
666 Op::ListIssues => "List issues",
667 Op::GetIssue => "Get an issue",
668 Op::CreateIssue => "Create an issue",
669 Op::UpdateIssue => "Update an issue",
670 Op::CloseIssue => "Close an issue",
671 Op::ReopenIssue => "Reopen an issue",
672 Op::ListLabels => "List labels",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar673 Op::CreateLabel => "Create a label",
674 Op::UpdateLabel => "Update a label",
675 Op::DeleteLabel => "Delete a label",
676 Op::AddDefaultLabels => "Add the default labels",
677 Op::ListIssueLabels => "List an issue's labels",
678 Op::AddIssueLabels => "Add labels to an issue",
679 Op::SetIssueLabels => "Set an issue's labels",
680 Op::RemoveIssueLabels => "Remove labels from an issue",
681 Op::ListMilestones => "List milestones",
682 Op::GetMilestone => "Get a milestone",
683 Op::CreateMilestone => "Create a milestone",
684 Op::UpdateMilestone => "Update a milestone",
685 Op::DeleteMilestone => "Delete a milestone",
686 Op::UpdatePullRequest => "Update a pull request",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP687 Op::AddComment => "Add a comment",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts688 Op::EditComment => "Edit a comment",
689 Op::DeleteComment => "Delete a comment",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP690 Op::ReviewPullRequest => "Review a pull request",
691 Op::ListPullRequests => "List pull requests",
692 Op::GetPullRequest => "Get a pull request",
693 Op::CreatePullRequest => "Create a pull request",
694 Op::RecordSession => "Record session entries",
695 Op::ReadSession => "Read a session",
Merge branch 'worktree-agent-ab8033ab973f8d99a'696 Op::RecordDecision => "Record a decision",
697 Op::ListDecisions => "List a pull request's decisions",
698 Op::Why => "Explain a line",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP699 Op::MarkPullRequestReady => "Mark a pull request ready",
700 Op::ClosePullRequest => "Close a pull request",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts701 Op::ReopenPullRequest => "Reopen a pull request",
702 Op::ConvertPullRequestToDraft => "Convert a pull request to a draft",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP703 Op::GetPullRequestChanges => "Get a pull request's changes",
704 Op::MergePullRequest => "Merge a pull request",
705 Op::ListEvents => "List repository events",
706 Op::ListIntegrations => "List integrations",
707 Op::ConnectIntegration => "Connect an integration",
AI Gateway: OpenAI's format, open models, and your own providers708 Op::UpdateIntegration => "Update an integration",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP709 Op::DisconnectIntegration => "Disconnect an integration",
710 Op::TestIntegration => "Test an integration",
711 Op::GetContext => "Look up a ticket",
712 Op::ImportIssue => "Import an issue",
713 Op::ListWebhooks => "List webhooks",
714 Op::CreateWebhook => "Create a webhook",
715 Op::UpdateWebhook => "Update a webhook",
716 Op::DeleteWebhook => "Delete a webhook",
717 Op::PingWebhook => "Ping a webhook",
718 Op::ListWebhookDeliveries => "List webhook deliveries",
719 Op::RedeliverWebhook => "Redeliver a webhook delivery",
720 Op::ListWorkflows => "List workflows",
Merge branch 'worktree-agent-a4db4b523bb973765'721 Op::GetWorkflow => "Get a workflow",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP722 Op::ListWorkflowRuns => "List workflow runs",
723 Op::GetWorkflowRun => "Get a workflow run",
724 Op::GetJobLogs => "Get a job's log",
725 Op::DispatchWorkflow => "Run a workflow",
726 Op::CancelWorkflowRun => "Cancel a workflow run",
727 Op::RerunWorkflowRun => "Re-run a workflow run",
728 Op::UpdateWorkflow => "Turn a workflow on or off",
729 Op::ListActionsSecrets => "List secrets",
730 Op::SetActionsSecret => "Set a secret",
731 Op::DeleteActionsSecret => "Delete a secret",
732 Op::ListActionsVariables => "List variables",
733 Op::SetActionsVariable => "Set a variable",
734 Op::DeleteActionsVariable => "Delete a variable",
735 Op::ListRunners => "List self-hosted runners",
736 Op::ListRunnerGroups => "List runner groups",
737 Op::GetRunnerSettings => "Get runner settings",
738 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
739 Op::RemoveRunner => "Remove a self-hosted runner",
740 Op::CreateRunnerGroup => "Create a runner group",
741 Op::UpdateRunnerGroup => "Change a runner group",
742 Op::DeleteRunnerGroup => "Delete a runner group",
743 Op::UpdateRunnerSettings => "Change runner settings",
744 Op::ListCollaborators => "List who has access",
745 Op::AddCollaborator => "Add a collaborator",
746 Op::UpdateCollaborator => "Change a collaborator's role",
747 Op::RemoveCollaborator => "Remove a collaborator",
748 Op::GetCollaboratorPermission => "Get someone's permission",
749 Op::ListRepoInvitations => "List a repository's invitations",
750 Op::RevokeRepoInvitation => "Revoke a repository invitation",
751 Op::ListMyRepoInvitations => "List your repository invitations",
752 Op::AcceptRepoInvitation => "Accept a repository invitation",
753 Op::DeclineRepoInvitation => "Decline a repository invitation",
754 Op::SetBasePermission => "Set the base permission",
755 Op::ListOutsideCollaborators => "List outside collaborators",
756 Op::ListSecurityAlerts => "List security alerts",
757 Op::DismissSecurityAlert => "Dismiss a security alert",
758 Op::ReopenSecurityAlert => "Reopen a security alert",
759 Op::ListNotifications => "List notifications",
760 Op::MarkNotificationsRead => "Mark notifications read",
761 Op::GetNotificationThread => "Get a thread",
762 Op::MarkThreadRead => "Mark a thread read",
763 Op::MarkThreadDone => "Mark a thread done",
764 Op::SaveThread => "Save a thread",
765 Op::SnoozeThread => "Snooze a thread",
766 Op::GetThreadSubscription => "Get a thread subscription",
767 Op::SetThreadSubscription => "Set a thread subscription",
768 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
769 Op::GetRepoSubscription => "Get how you watch a repository",
770 Op::SetRepoSubscription => "Watch a repository",
771 Op::DeleteRepoSubscription => "Stop watching a repository",
772 Op::ListWatchedRepos => "List repositories you watch",
API: pinned projects over REST and MCP773 Op::ListPinnedProjects => "List your pinned projects",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit774 Op::GetUsage => "Get a workspace's usage",
775 Op::GetBudget => "Get a workspace's budget",
776 Op::SetBudget => "Change a workspace's budget",
777 Op::ListInvoices => "List a workspace's invoices",
778 Op::GetBillingDetails => "Get a workspace's billing details",
API: pinned projects over REST and MCP779 Op::PinProject => "Pin a project",
780 Op::UnpinProject => "Unpin a project",
781 Op::ReorderPinnedProjects => "Reorder your pinned projects",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97782 Op::ListProjects => "List a workspace's projects",
g1t coordinates the work and the person's own sessions do it: Ask g1t reads g1t with the same tools any agent gets, answers in one conversation shared with the @g1t direct message in Chat, and hands work to sessions in the person's own harness, whose subagents g1t records, ties to issues and pull requests, and lets see each other.783 Op::GetWorkspaceActivity => "Get a workspace's activity",
784 Op::GetContents => "Get repository contents",
785 Op::ListCommits => "List commits",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97786 Op::GetProject => "Get a project",
787 Op::UpdateProject => "Update a project",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar788 Op::ListTeams => "List teams",
789 Op::GetTeam => "Get a team",
790 Op::CreateTeam => "Create a team",
791 Op::UpdateTeam => "Update a team",
792 Op::DeleteTeam => "Delete a team",
793 Op::ListTeamMembers => "List a team's members",
794 Op::SetTeamMember => "Add or change a team member",
795 Op::RemoveTeamMember => "Remove a team member",
796 Op::ListChildTeams => "List child teams",
797 Op::ListTeamRepos => "List a team's repositories",
798 Op::SetTeamRepo => "Give a team a role on a repository",
799 Op::RemoveTeamRepo => "Remove a team from a repository",
800 Op::SetTeamReviewAssignment => "Set a team's review assignment",
801 Op::ListUserTeams => "List someone's teams",
802 Op::RequestReviewers => "Request reviewers",
803 Op::RemoveRequestedReviewers => "Remove requested reviewers",
804 Op::GetCodeownersErrors => "List CODEOWNERS errors",
805 Op::Security(op) => op.title(),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge806 Op::Rules(op) => op.title(),
Merge checks: statuses and check runs on every commit807 Op::Checks(op) => op.title(),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97808 Op::About(op) => op.title(),
809 Op::Deployments(op) => op.title(),
Projects have Observability: their requests, logs, traces, metrics and errors, from apps on g1t.page with nothing to set up, and from software anywhere else over OpenTelemetry.810 Op::Telemetry(op) => op.title(),
Merge branch 'worktree-agent-a3abfcce648e87dca'811 Op::Protection(op) => op.title(),
API and MCP for a workspace's personal access token rules, members' tokens and approvals812 Op::Tokens(op) => op.title(),
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2813 Op::Artifacts(op) => op.title(),
Merge branch 'worktree-agent-a3b9b1f730f55b5bf'814 Op::Caches(op) => op.title(),
Merge GitHub pull request #8 (claude/cool-newton-7nm8r9): Docker deployments on g1t.page behind a switch that stays off until Cloudflare's container APIs are checked live, workflows a workspace manages in its repositories, tarball and zipball downloads, refs/pull/* kept to g1t alone, framework detection for g1t.page builds, and a workflow's event payload matching GitHub's.815 Op::Archives(op) => op.title(),
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca816 Op::DeployKeys(op) => op.title(),
Merge packages: roles, Actions access, source label, soft delete, API817 Op::Packages(op) => op.title(),
Merge main into Artifacts Phase 2818 Op::Folios(op) => op.title(),
Merge branch 'worktree-agent-a6ec0a89d7fe7a9ae'819 Op::Coordination(op) => op.title(),
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP820 }
821}
822
823/// Why an operation can be refused with `402 payment_required`, if it
The API and MCP server no longer offer g1t's own agents. g1t is what your coding agents work against, not an agent of its own, so the operations that drove hosted agents are gone: messaging an agent on a pull request (message_agent, take_messages, answer_message), assigning or delegating an issue to g1t (assign_issue, delegate), plans (plan_work, get_plan, apply_plan), the context hub (search_context, get_entity), model routes, agents' computers, AI Gateway requests, "Fix with g1t" on a security alert, and every Customize route (marketplaces, plugins, connectors). The callbacks the agent sandbox reported through (/agent-runs/*, /runs/:id/usage, /plans/:id, /reviews/:id) go with them, update_repo_settings stops accepting agent_review, max_revisions and hold_low_confidence, import_issue stops accepting assign, and an old agent token with no run behind it is refused.824/// can: the ones that make a repository private in a workspace, when a
825/// free workspace's private storage has no room for it.
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP826fn may_need_payment(op: Op) -> Option<&'static str> {
827 match op {
828 Op::UpdateRepo | Op::SetRepoVisibility | Op::TransferRepo => Some(
829 "A free workspace's private storage has no room for this private repository.",
830 ),
831 _ => None,
832 }
833}
834
835/// What the reference says beyond each operation's own description, keyed
836/// by operation id, written by hand from what the services return: `notes`
837/// (Markdown, added to the description) and example `params` (path),
838/// `query`, `request` (body) and `response`.
839const REFERENCE: &str = include_str!("reference.json");
840
841fn examples() -> Map<String, Value> {
842 match serde_json::from_str(REFERENCE) {
843 Ok(Value::Object(examples)) => examples,
844 _ => Map::new(),
845 }
846}
847
848/// `/repos/:owner/:name` as OpenAPI writes it: `/repos/{owner}/{name}`.
849fn openapi_path(route: &Route) -> String {
850 route
851 .path
852 .split('/')
853 .map(|segment| match segment.strip_prefix(':') {
854 Some(name) => format!("{{{name}}}"),
855 None => segment.to_owned(),
856 })
857 .collect::<Vec<_>>()
858 .join("/")
859}
860
861fn error_response(description: &str) -> Value {
862 json!({
863 "description": description,
864 "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } },
865 })
866}
867
868/// A parameter in the path or the query, described by the operation's
869/// input schema where it has the same name.
870fn parameter(name: &str, place: &str, required: bool, schema: Option<&Value>) -> Value {
871 let mut schema = schema.cloned().unwrap_or_else(|| json!({ "type": "string" }));
872 let description = match name {
873 "owner" => Some(Value::from("The workspace that owns the repository.")),
874 "name" => Some(Value::from("The repository's name.")),
875 _ => schema.as_object_mut().and_then(|schema| schema.remove("description")),
876 };
877 let mut parameter = json!({
878 "name": name,
879 "in": place,
880 "required": required,
881 "schema": schema,
882 });
883 if let Some(description) = description {
884 parameter["description"] = description;
885 }
886 parameter
887}
888
889/// The operation id of a route. An operation reached at a workspace's
890/// address as well as a repository's is documented once for each, with its
891/// own id; GitHub's alternative addresses for one operation keep GitHub's
892/// names.
893fn operation_id(route: &Route) -> String {
894 let op = route.op;
895 let base = match (route.method, route.path.rsplit('/').next().unwrap_or_default()) {
896 ("PUT", "enable") => "enable_workflow".to_owned(),
897 ("PUT", "disable") => "disable_workflow".to_owned(),
898 ("POST", "rerun-failed-jobs") => "rerun_failed_jobs".to_owned(),
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)899 ("POST", "rerun") if route.path.contains("/jobs/:job/") => "rerun_job".to_owned(),
900 ("POST", "force-cancel") => "force_cancel_workflow_run".to_owned(),
901 ("GET", ":attempt") => "get_workflow_run_attempt".to_owned(),
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP902 ("PATCH", ":setting") => "update_actions_variable".to_owned(),
903 ("GET", "runs") if route.path.contains("/workflows/:workflow/") => "list_runs_of_workflow".to_owned(),
904 // One repository's notifications, and an issue's subscription by
905 // its number rather than a thread's id.
906 (_, "notifications") if route.path.starts_with("/repos/") => match op {
907 Op::ListNotifications => "list_repo_notifications".to_owned(),
908 _ => "mark_repo_notifications_read".to_owned(),
909 },
910 (method, "subscription") if route.path.contains("/issues/:number/") => match method {
911 "GET" => "get_issue_subscription".to_owned(),
912 "PUT" => "set_issue_subscription".to_owned(),
913 _ => "delete_issue_subscription".to_owned(),
914 },
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar915 // One label off an issue, by its name in the path.
916 ("DELETE", ":label") if route.path.contains("/issues/:number/") => "remove_issue_label".to_owned(),
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP917 ("DELETE", "saved") => "unsave_thread".to_owned(),
918 ("DELETE", "snooze") => "unsnooze_thread".to_owned(),
Merge branch 'worktree-agent-ab8033ab973f8d99a'919 // An issue's decisions, by its number.
920 ("GET", "decisions") if route.path.contains("/issues/:number/") => "list_issue_decisions".to_owned(),
Merge branch 'worktree-agent-aef0bb4ceda89e542'921 // A claim that opens its issue first.
922 ("POST", "claims") => "claim_new_issue".to_owned(),
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP923 _ => op.name().to_owned(),
924 };
925 if route.path.starts_with("/workspaces/") && ROUTES.iter().any(|other| other.op == op && other.path.starts_with("/repos/")) {
926 format!("{base}_for_workspace")
927 } else {
928 base
929 }
930}
931
932/// The summary of a route: its operation's title, or for one of GitHub's
933/// alternative addresses, what that address does.
934fn summary(route: &Route, id: &str) -> String {
935 let base = match id.trim_end_matches("_for_workspace") {
936 "enable_workflow" => "Turn a workflow on",
937 "disable_workflow" => "Turn a workflow off",
938 "rerun_failed_jobs" => "Re-run failed jobs",
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)939 "rerun_job" => "Re-run a job",
940 "force_cancel_workflow_run" => "Force-cancel a workflow run",
941 "get_workflow_run_attempt" => "Get a workflow run attempt",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP942 "update_actions_variable" => "Update a variable",
943 "list_runs_of_workflow" => "List a workflow's runs",
944 "list_repo_notifications" => "List a repository's notifications",
945 "mark_repo_notifications_read" => "Mark a repository's notifications read",
946 "get_issue_subscription" => "Get your subscription to an issue",
947 "set_issue_subscription" => "Subscribe to an issue",
948 "delete_issue_subscription" => "Unsubscribe from an issue",
949 "unsave_thread" => "Unsave a thread",
950 "unsnooze_thread" => "Bring a snoozed thread back",
Merge branch 'worktree-agent-ab8033ab973f8d99a'951 "list_issue_decisions" => "List an issue's decisions",
Merge branch 'worktree-agent-aef0bb4ceda89e542'952 "claim_new_issue" => "Open an issue and claim it",
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP953 _ => title(route.op),
954 };
955 if id.ends_with("_for_workspace") {
956 format!("{base} for a workspace")
957 } else {
958 base.to_owned()
959 }
960}
961
962fn operation(route: &Route) -> Value {
963 let op = route.op;
964 let path_params: Vec<&str> = route.params().collect();
Merge checks: statuses and check runs on every commit965 // `owner` and `name` in the path stand for the operation's `repo` input,
966 // so a `name` in the body, such as a check run's, is the body's own.
967 let stands_for_repo =
968 |name: &str| matches!(name, "owner" | "name") && path_params.contains(&"owner") && path_params.contains(&"name");
969 let covered = |name: &str| name == "repo" || (path_params.contains(&name) && !stands_for_repo(name));
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP970 let all_properties = op.properties();
971 let mut properties = all_properties.clone();
972 properties.retain(|name, _| !covered(name));
973 let required: Vec<String> = op
974 .required()
975 .into_iter()
976 .filter(|name| !covered(name))
977 .collect();
978
979 let mut parameters: Vec<Value> = path_params
980 .iter()
Merge checks: statuses and check runs on every commit981 .map(|name| parameter(name, "path", true, if stands_for_repo(name) { None } else { all_properties.get(*name) }))
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP982 .collect();
983 let mut body = Value::Null;
984 if route.method == "GET" {
985 for (name, key) in route.query {
986 parameters.push(parameter(
987 name,
988 "query",
989 required.iter().any(|required| required == key),
990 properties.get(*key),
991 ));
992 }
993 } else if !properties.is_empty() {
994 let mut schema = json!({ "type": "object", "properties": properties });
995 if !required.is_empty() {
996 schema["required"] = json!(required);
997 }
998 body = json!({
999 "required": !required.is_empty(),
1000 "content": { "application/json": { "schema": schema } },
1001 });
1002 }
1003
1004 let id = operation_id(route);
1005 let mut responses = Map::new();
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1006 if route.no_content() {
1007 responses.insert("204".into(), json!({ "description": "Success. There is no body." }));
1008 } else {
1009 responses.insert(
1010 "200".into(),
1011 json!({
1012 "description": "Success.",
1013 "content": { "application/json": { "schema": {} } },
1014 }),
1015 );
1016 }
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP1017 responses.insert(
1018 "401".into(),
1019 error_response("A token is required, or the one sent is not valid."),
1020 );
1021 if let Some(reason) = may_need_payment(op) {
1022 responses.insert("402".into(), error_response(reason));
1023 }
1024 responses.insert(
1025 "403".into(),
1026 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."),
1027 );
1028 if !matches!(op, Op::Whoami | Op::ListRepos | Op::Search) {
1029 responses.insert("404".into(), error_response("It does not exist, or you cannot see it."));
1030 }
1031 if route.method != "GET" {
1032 responses.insert(
1033 "409".into(),
1034 error_response("The request conflicts with the current state."),
1035 );
1036 }
1037 if op != Op::Whoami {
1038 responses.insert("422".into(), error_response("The input is not valid."));
1039 }
1040 // Public data can be read without a token; everything else needs one.
1041 let scope: Vec<&str> = scope_for(op.name()).map(|scope| scope.as_str()).into_iter().collect();
1042 let security = if op.needs_user() {
1043 json!([{ "token": scope }])
1044 } else {
1045 json!([{ "token": scope }, {}])
1046 };
1047 let (tool, action) = crate::tools::TOOLS
1048 .iter()
1049 .find_map(|tool| {
1050 tool.actions
1051 .iter()
1052 .find(|action| action.op == op)
1053 .map(|action| (tool.name, action.name))
1054 })
1055 .unwrap_or_default();
1056 let mut described = json!({
1057 "operationId": id,
1058 "tags": [tag(op)],
1059 "summary": summary(route, &id),
1060 "description": op.description(),
1061 "x-operation": op.name(),
1062 "x-mcp-tool": tool,
1063 "x-mcp-action": action,
1064 "x-scope": scope.first().copied(),
1065 "security": security,
1066 "parameters": parameters,
1067 "responses": responses,
1068 });
1069 if !body.is_null() {
1070 described["requestBody"] = body;
1071 }
1072 described
1073}
1074
1075/// Entries for device sign-in, which is not an operation.
1076fn onboarding() -> Map<String, Value> {
1077 let paths = json!({
1078 "/device/code": {
1079 "post": {
1080 "operationId": "device_code",
1081 "tags": ["Accounts"],
1082 "summary": "Start signing in",
1083 "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`.",
1084 "security": [],
1085 "requestBody": {
1086 "content": { "application/json": { "schema": {
1087 "type": "object",
1088 "properties": {
1089 "client_name": {
1090 "type": "string",
1091 "description": "What is asking, shown to the person approving. For example, Claude Code.",
1092 },
1093 },
1094 } } },
1095 },
1096 "responses": { "200": {
1097 "description": "The codes for this sign-in.",
1098 "content": { "application/json": { "schema": {
1099 "type": "object",
1100 "properties": {
1101 "device_code": { "type": "string", "description": "Secret. Send it to /device/token." },
1102 "user_code": { "type": "string", "description": "Shown to the person, like WDJB-MJHT." },
1103 "verification_uri": { "type": "string" },
1104 "verification_uri_complete": {
1105 "type": "string",
1106 "description": "The link to give the person; it carries the code.",
1107 },
1108 "expires_in": { "type": "integer", "description": "Seconds until the codes expire." },
1109 "interval": { "type": "integer", "description": "Seconds to wait between polls." },
1110 },
1111 } } },
1112 } },
1113 },
1114 },
1115 "/device/token": {
1116 "post": {
1117 "operationId": "device_token",
1118 "tags": ["Accounts"],
1119 "summary": "Finish signing in",
1120 "description": "Asks whether the person has approved. Poll no faster than the interval. The token is returned once.",
1121 "security": [],
1122 "requestBody": {
1123 "required": true,
1124 "content": { "application/json": { "schema": {
1125 "type": "object",
1126 "required": ["device_code"],
1127 "properties": { "device_code": { "type": "string" } },
1128 } } },
1129 },
1130 "responses": { "200": {
1131 "description": "The state of the sign-in.",
1132 "content": { "application/json": { "schema": {
1133 "type": "object",
1134 "required": ["status"],
1135 "properties": {
1136 "status": { "type": "string", "enum": ["pending", "approved", "denied", "expired"] },
1137 "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 calendar1138 "username": { "type": "string", "description": "Lowercased: what the account is found and linked by." },
1139 "display_username": { "type": "string", "description": "The username as its owner wrote it; the same as username when they chose no case." },
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP1140 "verified": {
1141 "type": "boolean",
1142 "description": "Whether the account's email is confirmed.",
1143 },
1144 },
1145 } } },
1146 } },
1147 },
1148 },
1149 });
1150 match paths {
1151 Value::Object(paths) => paths,
1152 _ => Map::new(),
1153 }
1154}
1155
1156
1157/// Puts each operation's examples, where it has them, into its request
1158/// and response. Path and query values go under `x-example-params` and
1159/// `x-example-query`, which tools that build a request can use.
1160fn attach_examples(paths: &mut Map<String, Value>) {
1161 let examples = examples();
1162 for methods in paths.values_mut() {
1163 let Some(methods) = methods.as_object_mut() else { continue };
1164 for operation in methods.values_mut() {
1165 let id = operation["operationId"].as_str().unwrap_or_default().to_owned();
1166 let name = operation["x-operation"].as_str().unwrap_or_default().to_owned();
1167 let Some(example) = examples.get(&id).or_else(|| examples.get(&name)) else {
1168 continue;
1169 };
1170 if let Some(notes) = example.get("notes").and_then(Value::as_str) {
1171 let description = operation["description"].as_str().unwrap_or_default();
1172 operation["description"] = json!(format!("{description}\n\n{notes}"));
1173 }
1174 if let Some(response) = example.get("response") {
1175 let content = &mut operation["responses"]["200"]["content"]["application/json"];
1176 if content.is_object() {
1177 content["example"] = response.clone();
1178 }
1179 }
1180 if let Some(request) = example.get("request") {
1181 let content = &mut operation["requestBody"]["content"]["application/json"];
1182 if content.is_object() {
1183 content["example"] = request.clone();
1184 }
1185 }
1186 for (key, extension) in [("params", "x-example-params"), ("query", "x-example-query")] {
1187 if let Some(values) = example.get(key) {
1188 operation[extension] = values.clone();
1189 }
1190 }
1191 }
1192 }
1193}
1194
1195pub fn document() -> Value {
1196 let mut paths = onboarding();
1197 for route in ROUTES {
1198 let entry = paths
1199 .entry(openapi_path(route))
1200 .or_insert_with(|| json!({}));
1201 entry[route.method.to_lowercase()] = operation(route);
1202 }
1203 attach_examples(&mut paths);
1204 let tags: Vec<Value> = SECTIONS
1205 .iter()
1206 .map(|(name, description, ops)| {
1207 json!({
1208 "name": name,
1209 "description": description,
1210 // The section's operations in reading order, by MCP tool name.
1211 "x-tools": ops.iter().map(|op| op.name()).collect::<Vec<_>>(),
1212 })
1213 })
1214 .collect();
1215 let codes = ["unauthenticated", "payment_required", "forbidden", "not_found", "conflict", "invalid"];
1216 json!({
1217 "openapi": "3.1.0",
1218 "info": {
1219 "title": "g1t API",
1220 "version": "1",
1221 "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.",
1222 "license": { "name": "MIT", "identifier": "MIT" },
1223 },
1224 "servers": [{ "url": "https://api.g1t.sh" }],
1225 "security": [{ "token": [] }, {}],
1226 "tags": tags,
1227 "paths": paths,
1228 "components": {
1229 "securitySchemes": {
1230 "token": {
1231 "type": "http",
1232 "scheme": "bearer",
1233 "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.",
1234 },
1235 },
1236 "schemas": {
1237 "Error": {
1238 "type": "object",
1239 "required": ["error"],
1240 "properties": {
1241 "error": {
1242 "type": "object",
1243 "required": ["code", "message"],
1244 "properties": {
1245 "code": { "type": "string", "enum": codes },
1246 "message": { "type": "string" },
1247 "needed_scope": {
1248 "type": "string",
1249 "description": "On a 403 for an access token without the scope the call needs: that scope, such as `issues:write`.",
1250 },
1251 },
1252 },
1253 },
1254 },
1255 },
1256 },
1257 })
1258}
1259
1260#[cfg(test)]
1261mod tests {
1262 use super::*;
1263
1264 #[test]
1265 fn every_route_is_documented_once() {
1266 let document = document();
1267 let mut ids = Vec::new();
1268 for (_, methods) in document["paths"].as_object().unwrap() {
1269 for (_, operation) in methods.as_object().unwrap() {
1270 ids.push(operation["operationId"].as_str().unwrap().to_owned());
1271 }
1272 }
1273 for op in Op::ALL {
1274 assert_eq!(
1275 ids.iter().filter(|id| *id == op.name()).count(),
1276 1,
1277 "{}",
1278 op.name()
1279 );
1280 }
1281 let mut unique = ids.clone();
1282 unique.sort();
1283 unique.dedup();
1284 assert_eq!(unique.len(), ids.len(), "operation ids repeat");
1285 }
1286
1287 #[test]
1288 fn path_and_query_inputs_are_not_repeated_in_the_body() {
1289 let document = document();
1290 let merge = &document["paths"]["/repos/{owner}/{name}/pulls/{number}/merge"]["post"];
1291 let body = &merge["requestBody"]["content"]["application/json"]["schema"]["properties"];
1292 assert!(body.get("keep_issue_open").is_some());
1293 assert!(body.get("repo").is_none() && body.get("number").is_none());
1294 let list = &document["paths"]["/repos"]["get"];
1295 assert_eq!(list["parameters"][0]["name"], "q");
1296 assert!(list.get("requestBody").is_none());
1297 }
1298
1299 #[test]
1300 fn every_operation_is_in_one_section() {
1301 for op in Op::ALL {
1302 let sections = SECTIONS
1303 .iter()
1304 .filter(|(_, _, ops)| ops.contains(&op))
1305 .count();
1306 assert_eq!(sections, 1, "{}", op.name());
1307 }
1308 }
1309
1310 #[test]
1311 fn titles_read_as_sentences() {
1312 assert_eq!(title(Op::CreateIssue), "Create an issue");
1313 assert_eq!(title(Op::Whoami), "Get the current user");
1314 }
1315
1316 #[test]
1317 fn every_operation_has_an_example_response() {
1318 let examples = examples();
1319 assert!(!examples.is_empty(), "reference.json does not parse");
1320 let document = document();
1321 let mut known = Vec::new();
1322 for (path, methods) in document["paths"].as_object().unwrap() {
1323 for (method, operation) in methods.as_object().unwrap() {
1324 known.push(operation["operationId"].as_str().unwrap().to_owned());
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1325 // Nothing to show for a success without a body.
1326 if operation["responses"]["204"].is_object() {
1327 continue;
1328 }
Docs: inbox threads, reasons, subscriptions, watching, email, API and MCP1329 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1330 assert!(!example.is_null(), "{method} {path} has no example response");
1331 }
1332 }
1333 for id in examples.keys() {
1334 assert!(known.contains(id), "reference.json names {id}, which is not an operation");
1335 }
1336 }
1337
1338 #[test]
1339 fn example_requests_send_only_what_the_body_takes() {
1340 let document = document();
1341 for (path, methods) in document["paths"].as_object().unwrap() {
1342 for (method, operation) in methods.as_object().unwrap() {
1343 let content = &operation["requestBody"]["content"]["application/json"];
1344 let Some(example) = content["example"].as_object() else { continue };
1345 let properties = &content["schema"]["properties"];
1346 for key in example.keys() {
1347 assert!(!properties[key].is_null(), "{method} {path}: {key} is not in the body");
1348 }
1349 }
1350 }
1351 }
1352
1353 /// The docs site's copy of the document. Run with `G1T_WRITE_OPENAPI=1`
1354 /// to rewrite it after changing an operation.
1355 #[test]
1356 fn the_docs_copy_is_current() {
1357 let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/src/data/openapi.json");
1358 let current = serde_json::to_string_pretty(&document()).unwrap() + "\n";
1359 if std::env::var_os("G1T_WRITE_OPENAPI").is_some() {
1360 std::fs::write(path, &current).unwrap();
1361 return;
1362 }
1363 let copy = std::fs::read_to_string(path).unwrap_or_default().replace("\r\n", "\n");
1364 assert!(
1365 copy == current,
1366 "apps/docs/src/data/openapi.json is out of date: run G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi"
1367 );
1368 }
1369
1370 /// The reference shows responses as they are sent: `snake_case`.
1371 #[test]
1372 fn example_responses_are_snake_case() {
1373 let document = document();
1374 for (path, methods) in document["paths"].as_object().unwrap() {
1375 for (method, operation) in methods.as_object().unwrap() {
1376 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1377 let leaked = g1t_kit::wire::camel_case_keys(example);
1378 assert!(leaked.is_empty(), "{method} {path} shows {leaked:?}");
1379 }
1380 }
1381 }
1382
1383 /// Examples never hold anything that reads as a real credential, which
1384 /// secret scanners rightly flag in a public repository: they end in `…`
1385 /// after the prefix, as `whsec_…` and `g1t_…` do.
1386 #[test]
1387 fn examples_hold_no_real_looking_secrets() {
1388 let prefixes = ["whsec_", "g1t_", "g1tr_", "g1trt_", "sk_live_", "sk_test_", "ghp_", "github_pat_", "xoxb-", "AKIA"];
1389 for (line, text) in REFERENCE.lines().enumerate() {
1390 for prefix in prefixes {
1391 let mut rest = text;
1392 while let Some(at) = rest.find(prefix) {
1393 let after = &rest[at + prefix.len()..];
1394 let run = after.chars().take_while(|c| c.is_ascii_alphanumeric()).count();
1395 assert!(
1396 run < 12,
1397 "reference.json line {}: `{prefix}` followed by {run} characters reads as a real secret; write `{prefix}…`",
1398 line + 1
1399 );
1400 rest = after;
1401 }
1402 }
1403 }
1404 }
1405}

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