Skip to content
Sign in

flagon-io/g1t

public
0

g1t/apps/api/src/openapi.rs

1,286 lines56,974 bytesCodeBlame

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.

API and MCP server in Rust; a public index at the API root1//! The OpenAPI document, generated from the same list the routes are.
Merge branch 'worktree-agent-ab2e39e11a6493412'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.
API and MCP server in Rust; a public index at the API root6
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;
API and MCP server in Rust; a public index at the API root8use serde_json::{Map, Value, json};
9
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9710use crate::about::AboutOp;
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R211use crate::artifacts::ArtifactsOp;
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca12use crate::deploy_keys::DeployKeysOp;
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9713use crate::deployments::DeploymentsOp;
Merge packages: roles, Actions access, source label, soft delete, API14use crate::packages::PackagesOp;
Merge branch 'worktree-agent-a3abfcce648e87dca'15use crate::protection::ProtectionOp;
API and MCP for a workspace's personal access token rules, members' tokens and approvals16use crate::token_policy::TokenOp;
API and MCP server in Rust; a public index at the API root17use crate::operations::Op;
Merge checks: statuses and check runs on every commit18use crate::checks::ChecksOp;
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge19use crate::rules::RulesOp;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar20use crate::security::SecurityOp;
API and MCP server in Rust; a public index at the API root21use crate::rest::{ROUTES, Route};
22
Merge branch 'worktree-agent-ab2e39e11a6493412'23/// The sections of the API reference: a name, what it covers, and its
24/// operations in the order a reader meets them.
25const SECTIONS: &[(&str, &str, &[Op])] = &[
26 (
27 "Accounts",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look28 "Signing in from a tool, who a token acts as, and your email addresses.",
29 &[Op::Whoami, Op::ListEmails, Op::AddEmail, Op::RemoveEmail, Op::UpdateEmailSettings],
Merge branch 'worktree-agent-ab2e39e11a6493412'30 ),
31 (
API: notifications over REST and MCP, with notifications scopes32 "Notifications",
33 "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.",
34 &[
35 Op::ListNotifications,
36 Op::MarkNotificationsRead,
37 Op::GetNotificationThread,
38 Op::MarkThreadRead,
39 Op::MarkThreadDone,
40 Op::SaveThread,
41 Op::SnoozeThread,
42 Op::GetThreadSubscription,
43 Op::SetThreadSubscription,
44 Op::DeleteThreadSubscription,
45 Op::GetRepoSubscription,
46 Op::SetRepoSubscription,
47 Op::DeleteRepoSubscription,
48 Op::ListWatchedRepos,
49 ],
50 ),
51 (
API: pinned projects over REST and MCP52 "Pinned projects",
53 "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.",
54 &[Op::ListPinnedProjects, Op::PinProject, Op::UnpinProject, Op::ReorderPinnedProjects],
55 ),
56 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9757 "Projects",
58 "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.",
59 &[Op::ListProjects, Op::GetProject, Op::UpdateProject],
60 ),
61 (
Merge branch 'worktree-agent-ab2e39e11a6493412'62 "Workspaces",
63 "A workspace owns repositories and is the first part of their address. People and agents work in workspaces.",
Merge branch 'worktree-agent-ad7c6d88d93adc817'64 &[Op::GetWorkspace, Op::CreateWorkspace, Op::UpdateWorkspace, Op::DeleteWorkspace],
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look65 ),
66 (
API and MCP for a workspace's personal access token rules, members' tokens and approvals67 "Personal access tokens",
68 "A workspace's rules for its members' personal access tokens: whether classic and fine-grained tokens reach it, whether fine-grained tokens 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.",
69 &[
70 Op::Tokens(TokenOp::GetTokenPolicy),
71 Op::Tokens(TokenOp::SetTokenPolicy),
72 Op::Tokens(TokenOp::ListMemberTokens),
73 Op::Tokens(TokenOp::ListTokenRequests),
74 Op::Tokens(TokenOp::ReviewTokenRequest),
75 Op::Tokens(TokenOp::RevokeMemberToken),
76 ],
77 ),
78 (
Merge main (membership, two-factor, GitHub repo roles) into tokens79 "Members",
80 "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.",
81 &[Op::ListMembers, Op::UpdateMember, Op::RemoveMember, Op::TransferOwnership, Op::LeaveWorkspace],
82 ),
83 (
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look84 "Invites",
85 "While g1t is invite-only, every new account needs an invite. Your invites, and inviting people into a workspace by email.",
86 &[
87 Op::ListInvites,
88 Op::CreateInvite,
89 Op::RevokeInvite,
90 Op::ListWorkspaceInvites,
91 Op::InviteMember,
92 Op::RevokeWorkspaceInvite,
93 ],
Merge branch 'worktree-agent-ab2e39e11a6493412'94 ),
95 (
Usage, Billing settings and prepaid AI credit; fixes from the UX audit96 "Billing",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens97 "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 audit98 &[
99 Op::GetUsage,
100 Op::GetBudget,
101 Op::SetBudget,
102 Op::GetAiCredit,
103 Op::BuyAiCredit,
104 Op::ListInvoices,
105 Op::GetBillingDetails,
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens106 Op::ListGatewayRequests,
Usage, Billing settings and prepaid AI credit; fixes from the UX audit107 ],
108 ),
109 (
Merge branch 'worktree-agent-ab2e39e11a6493412'110 "Repositories",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look111 "A repository, how it handles pull requests, and its timeline: renaming, archiving, moving and deleting it.",
Merge branch 'worktree-agent-ab2e39e11a6493412'112 &[
113 Op::ListRepos,
114 Op::CreateRepo,
115 Op::GetRepo,
116 Op::UpdateRepo,
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look117 Op::RenameRepo,
118 Op::RenameBranch,
119 Op::SetRepoVisibility,
120 Op::ArchiveRepo,
121 Op::UnarchiveRepo,
122 Op::TransferRepo,
123 Op::DeleteRepo,
124 Op::ListDeletedRepos,
125 Op::RestoreRepo,
126 Op::PurgeRepo,
Merge branch 'worktree-agent-ab2e39e11a6493412'127 Op::GetRepoSettings,
128 Op::UpdateRepoSettings,
Fast pages, required checks on the branch, self-hosted runners, honest incidents129 Op::ListCheckNames,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar130 Op::GetCodeownersErrors,
Merge branch 'worktree-agent-ab2e39e11a6493412'131 Op::ListEvents,
132 ],
133 ),
134 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97135 "Repository insights",
136 "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.",
137 &[Op::About(AboutOp::GetLanguages), Op::About(AboutOp::ListContributors), Op::About(AboutOp::GetLicense)],
138 ),
139 (
140 "Stars",
141 "Starring a repository, to keep it and to say you like it: who starred one, and what you starred.",
142 &[
143 Op::About(AboutOp::ListStargazers),
144 Op::About(AboutOp::ListStarred),
145 Op::About(AboutOp::CheckStarred),
146 Op::About(AboutOp::Star),
147 Op::About(AboutOp::Unstar),
148 ],
149 ),
150 (
151 "Releases",
152 "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.",
153 &[
154 Op::About(AboutOp::ListReleases),
155 Op::About(AboutOp::CreateRelease),
156 Op::About(AboutOp::GetLatestRelease),
157 Op::About(AboutOp::GetReleaseByTag),
158 Op::About(AboutOp::GetRelease),
159 Op::About(AboutOp::UpdateRelease),
160 Op::About(AboutOp::DeleteRelease),
161 ],
162 ),
163 (
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look164 "Access",
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca165 "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 look166 &[
167 Op::ListCollaborators,
168 Op::AddCollaborator,
169 Op::UpdateCollaborator,
170 Op::RemoveCollaborator,
171 Op::GetCollaboratorPermission,
172 Op::ListRepoInvitations,
173 Op::RevokeRepoInvitation,
174 Op::ListMyRepoInvitations,
175 Op::AcceptRepoInvitation,
176 Op::DeclineRepoInvitation,
177 Op::SetBasePermission,
178 Op::ListOutsideCollaborators,
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca179 Op::DeployKeys(DeployKeysOp::ListDeployKeys),
180 Op::DeployKeys(DeployKeysOp::GetDeployKey),
181 Op::DeployKeys(DeployKeysOp::CreateDeployKey),
182 Op::DeployKeys(DeployKeysOp::DeleteDeployKey),
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look183 ],
184 ),
185 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar186 "Teams",
187 "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.",
188 &[
189 Op::ListTeams,
190 Op::CreateTeam,
191 Op::GetTeam,
192 Op::UpdateTeam,
193 Op::DeleteTeam,
194 Op::ListTeamMembers,
195 Op::SetTeamMember,
196 Op::RemoveTeamMember,
197 Op::ListChildTeams,
198 Op::ListTeamRepos,
199 Op::SetTeamRepo,
200 Op::RemoveTeamRepo,
201 Op::SetTeamReviewAssignment,
202 Op::ListUserTeams,
203 ],
204 ),
205 (
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily206 "Security",
207 "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.",
208 &[Op::ListSecurityAlerts, Op::DismissSecurityAlert, Op::ReopenSecurityAlert],
209 ),
210 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar211 "Secret scanning",
212 "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.",
213 &[
214 Op::Security(SecurityOp::ListSecretAlerts),
215 Op::Security(SecurityOp::GetSecretAlert),
216 Op::Security(SecurityOp::UpdateSecretAlert),
217 Op::Security(SecurityOp::ListSecretLocations),
218 Op::Security(SecurityOp::BypassPushProtection),
219 Op::Security(SecurityOp::CheckSecretValidity),
220 Op::Security(SecurityOp::ListBypassRequests),
221 Op::Security(SecurityOp::ReviewBypassRequest),
222 Op::Security(SecurityOp::ListCustomPatterns),
223 Op::Security(SecurityOp::CreateCustomPattern),
224 Op::Security(SecurityOp::UpdateCustomPattern),
225 Op::Security(SecurityOp::DeleteCustomPattern),
226 Op::Security(SecurityOp::DryRunCustomPattern),
227 ],
228 ),
229 (
230 "Code scanning",
231 "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.",
232 &[
233 Op::Security(SecurityOp::ListCodeAlerts),
234 Op::Security(SecurityOp::GetCodeAlert),
235 Op::Security(SecurityOp::UpdateCodeAlert),
236 Op::Security(SecurityOp::ListAnalyses),
237 Op::Security(SecurityOp::UploadSarif),
238 Op::Security(SecurityOp::GetSarifUpload),
239 Op::Security(SecurityOp::FixAlert),
240 ],
241 ),
242 (
243 "Supply chain",
244 "What a repository depends on: vulnerability alerts, the dependency graph, an SPDX SBOM of it, and comparing two commits' dependencies as dependency review does.",
245 &[
246 Op::Security(SecurityOp::ListVulnerabilityAlerts),
247 Op::Security(SecurityOp::GetVulnerabilityAlert),
248 Op::Security(SecurityOp::UpdateVulnerabilityAlert),
249 Op::Security(SecurityOp::GetDependencyGraph),
250 Op::Security(SecurityOp::GetSbom),
251 Op::Security(SecurityOp::CompareDependencies),
252 ],
253 ),
254 (
255 "Security settings",
256 "When pull request checks fail, dependency review's policy, delegated bypass and validity checks, and a workspace's security overview.",
257 &[
258 Op::Security(SecurityOp::GetSettings),
259 Op::Security(SecurityOp::UpdateSettings),
260 Op::Security(SecurityOp::GetWorkspaceSettings),
261 Op::Security(SecurityOp::UpdateWorkspaceSettings),
262 Op::Security(SecurityOp::GetOverview),
263 ],
264 ),
265 (
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge266 "Rules",
267 "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.",
268 &[
269 Op::Rules(RulesOp::ListRepoRulesets),
270 Op::Rules(RulesOp::CreateRepoRuleset),
271 Op::Rules(RulesOp::GetRepoRuleset),
272 Op::Rules(RulesOp::UpdateRepoRuleset),
273 Op::Rules(RulesOp::DeleteRepoRuleset),
274 Op::Rules(RulesOp::GetBranchRules),
275 Op::Rules(RulesOp::ListRuleEvaluations),
276 Op::Rules(RulesOp::ListWorkspaceRulesets),
277 Op::Rules(RulesOp::CreateWorkspaceRuleset),
278 Op::Rules(RulesOp::GetWorkspaceRuleset),
279 Op::Rules(RulesOp::UpdateWorkspaceRuleset),
280 Op::Rules(RulesOp::DeleteWorkspaceRuleset),
281 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
282 ],
283 ),
284 (
Merge checks: statuses and check runs on every commit285 "Checks",
286 "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.",
287 &[
288 Op::Checks(ChecksOp::CreateCommitStatus),
289 Op::Checks(ChecksOp::ListCommitStatuses),
290 Op::Checks(ChecksOp::GetCombinedStatus),
291 Op::Checks(ChecksOp::CreateCheckRun),
292 Op::Checks(ChecksOp::UpdateCheckRun),
293 Op::Checks(ChecksOp::GetCheckRun),
294 Op::Checks(ChecksOp::ListCheckRunAnnotations),
295 Op::Checks(ChecksOp::RerequestCheckRun),
296 Op::Checks(ChecksOp::ListCheckRunsForRef),
297 Op::Checks(ChecksOp::ListCheckSuitesForRef),
298 Op::Checks(ChecksOp::GetCheckSuite),
299 Op::Checks(ChecksOp::RerequestCheckSuite),
300 ],
301 ),
302 (
Merge branch 'worktree-agent-ab2e39e11a6493412'303 "Issues",
304 "What should change in a repository, with labels and comments. Issues and pull requests share one sequence of numbers.",
305 &[
306 Op::ListIssues,
307 Op::CreateIssue,
308 Op::GetIssue,
309 Op::UpdateIssue,
310 Op::CloseIssue,
311 Op::ReopenIssue,
312 Op::AssignIssue,
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step313 Op::Delegate,
Merge branch 'worktree-agent-ab2e39e11a6493412'314 Op::AddComment,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar315 Op::ListIssueLabels,
316 Op::AddIssueLabels,
317 Op::SetIssueLabels,
318 Op::RemoveIssueLabels,
319 ],
320 ),
321 (
322 "Labels and milestones",
323 "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.",
324 &[
Merge branch 'worktree-agent-ab2e39e11a6493412'325 Op::ListLabels,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar326 Op::CreateLabel,
327 Op::UpdateLabel,
328 Op::DeleteLabel,
329 Op::AddDefaultLabels,
330 Op::ListMilestones,
331 Op::CreateMilestone,
332 Op::GetMilestone,
333 Op::UpdateMilestone,
334 Op::DeleteMilestone,
Merge branch 'worktree-agent-ab2e39e11a6493412'335 ],
336 ),
337 (
338 "Plans",
339 "An outcome turned into the issues that would get there, with the order they must merge in.",
340 &[Op::PlanWork, Op::GetPlan, Op::ApplyPlan],
341 ),
342 (
343 "Pull requests",
344 "A proposed change in its own fork or on a branch. Several can be made for one issue; the one merged resolves it.",
345 &[
346 Op::ListPullRequests,
347 Op::CreatePullRequest,
348 Op::GetPullRequest,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar349 Op::UpdatePullRequest,
Merge branch 'worktree-agent-ab2e39e11a6493412'350 Op::GetPullRequestChanges,
351 Op::MarkPullRequestReady,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar352 Op::RequestReviewers,
353 Op::RemoveRequestedReviewers,
Merge branch 'worktree-agent-ab2e39e11a6493412'354 Op::ReviewPullRequest,
355 Op::MergePullRequest,
356 Op::ClosePullRequest,
357 Op::GetMergeQueue,
358 Op::MessageAgent,
359 Op::AnswerMessage,
360 Op::TakeMessages,
361 ],
362 ),
363 (
364 "Sessions",
365 "The record of how a pull request was made: prompts, reasoning and the tools that ran.",
366 &[Op::ReadSession, Op::RecordSession],
367 ),
368 (
Agents and memory, checks and conflicts, profiles, slug renames, custom domains369 "Memory",
370 "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.",
371 &[Op::Remember, Op::Recall],
372 ),
373 (
Search across all of g1t, Explore, and a command palette374 "Search",
375 "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.",
376 &[Op::Search],
377 ),
378 (
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API379 "Context",
380 "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.",
381 &[Op::SearchContext, Op::GetEntity],
382 ),
383 (
Merge branch 'worktree-agent-ab2e39e11a6493412'384 "Actions",
385 "GitHub Actions workflows in .g1t/workflows, their runs, and their jobs' logs.",
386 &[
387 Op::ListWorkflows,
388 Op::ListWorkflowRuns,
389 Op::GetWorkflowRun,
390 Op::GetJobLogs,
391 Op::DispatchWorkflow,
392 Op::CancelWorkflowRun,
393 Op::RerunWorkflowRun,
394 Op::UpdateWorkflow,
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2395 Op::Artifacts(ArtifactsOp::ListArtifacts),
396 Op::Artifacts(ArtifactsOp::ListRunArtifacts),
397 Op::Artifacts(ArtifactsOp::GetArtifact),
398 Op::Artifacts(ArtifactsOp::DownloadArtifact),
399 Op::Artifacts(ArtifactsOp::DeleteArtifact),
400 Op::Artifacts(ArtifactsOp::GetArtifactRetention),
401 Op::Artifacts(ArtifactsOp::SetArtifactRetention),
Merge branch 'worktree-agent-ab2e39e11a6493412'402 ],
403 ),
404 (
Merge packages: roles, Actions access, source label, soft delete, API405 "Packages",
406 "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.",
407 &[
408 Op::Packages(PackagesOp::ListPackages),
409 Op::Packages(PackagesOp::GetPackage),
410 Op::Packages(PackagesOp::UpdatePackage),
411 Op::Packages(PackagesOp::DeletePackage),
412 Op::Packages(PackagesOp::RestorePackage),
413 Op::Packages(PackagesOp::ListVersions),
414 Op::Packages(PackagesOp::GetVersion),
415 Op::Packages(PackagesOp::DeleteVersion),
416 Op::Packages(PackagesOp::RestoreVersion),
417 Op::Packages(PackagesOp::LinkPackage),
418 Op::Packages(PackagesOp::UnlinkPackage),
419 Op::Packages(PackagesOp::ListAccess),
420 Op::Packages(PackagesOp::SetAccess),
421 Op::Packages(PackagesOp::RemoveAccess),
422 Op::Packages(PackagesOp::ListActionsAccess),
423 Op::Packages(PackagesOp::SetActionsAccess),
424 Op::Packages(PackagesOp::RemoveActionsAccess),
425 ],
426 ),
427 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97428 "Deployments",
429 "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.",
430 &[
431 Op::Deployments(DeploymentsOp::ListDeployments),
432 Op::Deployments(DeploymentsOp::CreateDeployment),
433 Op::Deployments(DeploymentsOp::GetDeployment),
434 Op::Deployments(DeploymentsOp::ListDeploymentStatuses),
435 Op::Deployments(DeploymentsOp::CreateDeploymentStatus),
436 Op::Deployments(DeploymentsOp::ListEnvironments),
437 Op::Deployments(DeploymentsOp::GetEnvironment),
438 ],
439 ),
440 (
Merge branch 'worktree-agent-a3abfcce648e87dca'441 "Run protection",
442 "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.",
443 &[
444 Op::Protection(ProtectionOp::UpdateEnvironment),
445 Op::Protection(ProtectionOp::DeleteEnvironment),
446 Op::Protection(ProtectionOp::GetPendingDeployments),
447 Op::Protection(ProtectionOp::ReviewPendingDeployments),
448 Op::Protection(ProtectionOp::ApproveWorkflowRun),
449 Op::Protection(ProtectionOp::GetWorkflowPermissions),
450 Op::Protection(ProtectionOp::SetWorkflowPermissions),
451 Op::Protection(ProtectionOp::GetForkPrApproval),
452 Op::Protection(ProtectionOp::SetForkPrApproval),
453 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
454 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
455 Op::Protection(ProtectionOp::SetWorkspaceWorkflowPermissions),
456 ],
457 ),
458 (
Merge branch 'worktree-agent-ab2e39e11a6493412'459 "Secrets and variables",
460 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
461 &[
462 Op::ListActionsSecrets,
463 Op::SetActionsSecret,
464 Op::DeleteActionsSecret,
465 Op::ListActionsVariables,
466 Op::SetActionsVariable,
467 Op::DeleteActionsVariable,
468 ],
469 ),
470 (
Fast pages, required checks on the branch, self-hosted runners, honest incidents471 "Runners",
472 "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.",
473 &[
474 Op::ListRunners,
475 Op::CreateRunnerRegistrationToken,
476 Op::RemoveRunner,
477 Op::ListRunnerGroups,
478 Op::CreateRunnerGroup,
479 Op::UpdateRunnerGroup,
480 Op::DeleteRunnerGroup,
481 Op::GetRunnerSettings,
482 Op::UpdateRunnerSettings,
483 ],
484 ),
485 (
Merge branch 'worktree-agent-ab2e39e11a6493412'486 "Webhooks",
487 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
488 &[
489 Op::ListWebhooks,
490 Op::CreateWebhook,
491 Op::UpdateWebhook,
492 Op::DeleteWebhook,
493 Op::PingWebhook,
494 Op::ListWebhookDeliveries,
495 Op::RedeliverWebhook,
496 ],
497 ),
498 (
499 "Integrations",
500 "A workspace's connections to outside systems: model providers, alert sources and issue trackers.",
501 &[
502 Op::ListIntegrations,
503 Op::ConnectIntegration,
AI Gateway: OpenAI's format, open models, and your own providers504 Op::UpdateIntegration,
Merge branch 'worktree-agent-ab2e39e11a6493412'505 Op::DisconnectIntegration,
506 Op::TestIntegration,
507 Op::GetModelRoutes,
508 Op::SetModelRoutes,
509 Op::GetContext,
510 Op::ImportIssue,
511 ],
512 ),
513];
514
API and MCP server in Rust; a public index at the API root515/// The section of the API reference an operation is listed under.
516fn tag(op: Op) -> &'static str {
Merge branch 'worktree-agent-ab2e39e11a6493412'517 SECTIONS
API and MCP server in Rust; a public index at the API root518 .iter()
Merge branch 'worktree-agent-ab2e39e11a6493412'519 .find(|(_, _, ops)| ops.contains(&op))
520 .map_or("Repositories", |(name, _, _)| name)
521}
522
523/// What an operation's page is called, as a short sentence.
524fn title(op: Op) -> &'static str {
525 match op {
526 Op::Whoami => "Get the current user",
Merge branch 'worktree-agent-ad7c6d88d93adc817'527 Op::GetWorkspace => "Get a workspace",
Merge branch 'worktree-agent-ab2e39e11a6493412'528 Op::CreateWorkspace => "Create a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look529 Op::DeleteWorkspace => "Delete a workspace",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily530 Op::UpdateWorkspace => "Update a workspace",
Merge main (membership, two-factor, GitHub repo roles) into tokens531 Op::ListMembers => "List a workspace's members",
532 Op::UpdateMember => "Change a member's role",
533 Op::RemoveMember => "Remove a member",
534 Op::TransferOwnership => "Transfer a workspace's ownership",
535 Op::LeaveWorkspace => "Leave a workspace",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look536 Op::ListEmails => "List your email addresses",
537 Op::AddEmail => "Add an email address",
538 Op::RemoveEmail => "Remove an email address",
539 Op::UpdateEmailSettings => "Change your email settings",
540 Op::ListInvites => "List your invites",
541 Op::CreateInvite => "Create an invite",
542 Op::RevokeInvite => "Revoke an invite",
543 Op::ListWorkspaceInvites => "List a workspace's invites",
544 Op::InviteMember => "Invite someone to a workspace",
545 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
546 Op::TransferRepo => "Transfer a repository",
547 Op::RenameRepo => "Rename a repository",
548 Op::RenameBranch => "Rename a branch",
549 Op::ArchiveRepo => "Archive a repository",
550 Op::UnarchiveRepo => "Unarchive a repository",
551 Op::SetRepoVisibility => "Change a repository's visibility",
552 Op::DeleteRepo => "Delete a repository",
553 Op::ListDeletedRepos => "List recently deleted repositories",
554 Op::RestoreRepo => "Restore a deleted repository",
555 Op::PurgeRepo => "Purge a deleted repository",
Merge branch 'worktree-agent-ab2e39e11a6493412'556 Op::ListRepos => "List repositories",
557 Op::GetRepo => "Get a repository",
558 Op::CreateRepo => "Create a repository",
559 Op::UpdateRepo => "Update a repository",
560 Op::GetRepoSettings => "Get repository settings",
561 Op::UpdateRepoSettings => "Update repository settings",
Fast pages, required checks on the branch, self-hosted runners, honest incidents562 Op::ListCheckNames => "List check names",
Merge branch 'worktree-agent-ab2e39e11a6493412'563 Op::GetMergeQueue => "Get the merge queue",
564 Op::MessageAgent => "Message an agent",
565 Op::AnswerMessage => "Answer a message",
566 Op::TakeMessages => "Take new messages",
Agents and memory, checks and conflicts, profiles, slug renames, custom domains567 Op::Remember => "Remember something",
568 Op::Recall => "Recall memory",
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API569 Op::SearchContext => "Search the context hub",
570 Op::GetEntity => "Get a catalog entry",
Search across all of g1t, Explore, and a command palette571 Op::Search => "Search g1t",
Merge branch 'worktree-agent-ab2e39e11a6493412'572 Op::ListIssues => "List issues",
573 Op::GetIssue => "Get an issue",
574 Op::CreateIssue => "Create an issue",
575 Op::UpdateIssue => "Update an issue",
576 Op::CloseIssue => "Close an issue",
577 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-agent578 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 step579 Op::Delegate => "Put an agent on it",
Merge branch 'worktree-agent-ab2e39e11a6493412'580 Op::PlanWork => "Plan work",
581 Op::GetPlan => "Get a plan",
582 Op::ApplyPlan => "Apply a plan",
583 Op::ListLabels => "List labels",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar584 Op::CreateLabel => "Create a label",
585 Op::UpdateLabel => "Update a label",
586 Op::DeleteLabel => "Delete a label",
587 Op::AddDefaultLabels => "Add the default labels",
588 Op::ListIssueLabels => "List an issue's labels",
589 Op::AddIssueLabels => "Add labels to an issue",
590 Op::SetIssueLabels => "Set an issue's labels",
591 Op::RemoveIssueLabels => "Remove labels from an issue",
592 Op::ListMilestones => "List milestones",
593 Op::GetMilestone => "Get a milestone",
594 Op::CreateMilestone => "Create a milestone",
595 Op::UpdateMilestone => "Update a milestone",
596 Op::DeleteMilestone => "Delete a milestone",
597 Op::UpdatePullRequest => "Update a pull request",
Merge branch 'worktree-agent-ab2e39e11a6493412'598 Op::AddComment => "Add a comment",
599 Op::ReviewPullRequest => "Review a pull request",
600 Op::ListPullRequests => "List pull requests",
601 Op::GetPullRequest => "Get a pull request",
602 Op::CreatePullRequest => "Create a pull request",
603 Op::RecordSession => "Record session entries",
604 Op::ReadSession => "Read a session",
605 Op::MarkPullRequestReady => "Mark a pull request ready",
606 Op::ClosePullRequest => "Close a pull request",
607 Op::GetPullRequestChanges => "Get a pull request's changes",
608 Op::MergePullRequest => "Merge a pull request",
609 Op::ListEvents => "List repository events",
610 Op::ListIntegrations => "List integrations",
611 Op::ConnectIntegration => "Connect an integration",
AI Gateway: OpenAI's format, open models, and your own providers612 Op::UpdateIntegration => "Update an integration",
Merge branch 'worktree-agent-ab2e39e11a6493412'613 Op::DisconnectIntegration => "Disconnect an integration",
614 Op::TestIntegration => "Test an integration",
615 Op::GetContext => "Look up a ticket",
616 Op::ImportIssue => "Import an issue",
617 Op::GetModelRoutes => "Get model routes",
618 Op::SetModelRoutes => "Set model routes",
619 Op::ListWebhooks => "List webhooks",
620 Op::CreateWebhook => "Create a webhook",
621 Op::UpdateWebhook => "Update a webhook",
622 Op::DeleteWebhook => "Delete a webhook",
623 Op::PingWebhook => "Ping a webhook",
624 Op::ListWebhookDeliveries => "List webhook deliveries",
625 Op::RedeliverWebhook => "Redeliver a webhook delivery",
626 Op::ListWorkflows => "List workflows",
627 Op::ListWorkflowRuns => "List workflow runs",
628 Op::GetWorkflowRun => "Get a workflow run",
629 Op::GetJobLogs => "Get a job's log",
630 Op::DispatchWorkflow => "Run a workflow",
631 Op::CancelWorkflowRun => "Cancel a workflow run",
632 Op::RerunWorkflowRun => "Re-run a workflow run",
633 Op::UpdateWorkflow => "Turn a workflow on or off",
634 Op::ListActionsSecrets => "List secrets",
635 Op::SetActionsSecret => "Set a secret",
636 Op::DeleteActionsSecret => "Delete a secret",
637 Op::ListActionsVariables => "List variables",
638 Op::SetActionsVariable => "Set a variable",
639 Op::DeleteActionsVariable => "Delete a variable",
Fast pages, required checks on the branch, self-hosted runners, honest incidents640 Op::ListRunners => "List self-hosted runners",
641 Op::ListRunnerGroups => "List runner groups",
642 Op::GetRunnerSettings => "Get runner settings",
643 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
644 Op::RemoveRunner => "Remove a self-hosted runner",
645 Op::CreateRunnerGroup => "Create a runner group",
646 Op::UpdateRunnerGroup => "Change a runner group",
647 Op::DeleteRunnerGroup => "Delete a runner group",
648 Op::UpdateRunnerSettings => "Change runner settings",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look649 Op::ListCollaborators => "List who has access",
650 Op::AddCollaborator => "Add a collaborator",
651 Op::UpdateCollaborator => "Change a collaborator's role",
652 Op::RemoveCollaborator => "Remove a collaborator",
653 Op::GetCollaboratorPermission => "Get someone's permission",
654 Op::ListRepoInvitations => "List a repository's invitations",
655 Op::RevokeRepoInvitation => "Revoke a repository invitation",
656 Op::ListMyRepoInvitations => "List your repository invitations",
657 Op::AcceptRepoInvitation => "Accept a repository invitation",
658 Op::DeclineRepoInvitation => "Decline a repository invitation",
659 Op::SetBasePermission => "Set the base permission",
660 Op::ListOutsideCollaborators => "List outside collaborators",
Git storage hardened, pages in tens of milliseconds, honest security alerts, and costs reconciled daily661 Op::ListSecurityAlerts => "List security alerts",
662 Op::DismissSecurityAlert => "Dismiss a security alert",
663 Op::ReopenSecurityAlert => "Reopen a security alert",
API: notifications over REST and MCP, with notifications scopes664 Op::ListNotifications => "List notifications",
665 Op::MarkNotificationsRead => "Mark notifications read",
666 Op::GetNotificationThread => "Get a thread",
667 Op::MarkThreadRead => "Mark a thread read",
668 Op::MarkThreadDone => "Mark a thread done",
669 Op::SaveThread => "Save a thread",
670 Op::SnoozeThread => "Snooze a thread",
671 Op::GetThreadSubscription => "Get a thread subscription",
672 Op::SetThreadSubscription => "Set a thread subscription",
673 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
674 Op::GetRepoSubscription => "Get how you watch a repository",
675 Op::SetRepoSubscription => "Watch a repository",
676 Op::DeleteRepoSubscription => "Stop watching a repository",
677 Op::ListWatchedRepos => "List repositories you watch",
API: pinned projects over REST and MCP678 Op::ListPinnedProjects => "List your pinned projects",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit679 Op::GetUsage => "Get a workspace's usage",
680 Op::GetBudget => "Get a workspace's budget",
681 Op::SetBudget => "Change a workspace's budget",
682 Op::GetAiCredit => "Get a workspace's AI credit",
683 Op::BuyAiCredit => "Buy AI credit",
684 Op::ListInvoices => "List a workspace's invoices",
685 Op::GetBillingDetails => "Get a workspace's billing details",
Merge the AI Gateway: Anthropic's Messages API on a workspace's tokens686 Op::ListGatewayRequests => "List a workspace's AI Gateway requests",
API: pinned projects over REST and MCP687 Op::PinProject => "Pin a project",
688 Op::UnpinProject => "Unpin a project",
689 Op::ReorderPinnedProjects => "Reorder your pinned projects",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97690 Op::ListProjects => "List a workspace's projects",
691 Op::GetProject => "Get a project",
692 Op::UpdateProject => "Update a project",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar693 Op::ListTeams => "List teams",
694 Op::GetTeam => "Get a team",
695 Op::CreateTeam => "Create a team",
696 Op::UpdateTeam => "Update a team",
697 Op::DeleteTeam => "Delete a team",
698 Op::ListTeamMembers => "List a team's members",
699 Op::SetTeamMember => "Add or change a team member",
700 Op::RemoveTeamMember => "Remove a team member",
701 Op::ListChildTeams => "List child teams",
702 Op::ListTeamRepos => "List a team's repositories",
703 Op::SetTeamRepo => "Give a team a role on a repository",
704 Op::RemoveTeamRepo => "Remove a team from a repository",
705 Op::SetTeamReviewAssignment => "Set a team's review assignment",
706 Op::ListUserTeams => "List someone's teams",
707 Op::RequestReviewers => "Request reviewers",
708 Op::RemoveRequestedReviewers => "Remove requested reviewers",
709 Op::GetCodeownersErrors => "List CODEOWNERS errors",
710 Op::Security(op) => op.title(),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge711 Op::Rules(op) => op.title(),
Merge checks: statuses and check runs on every commit712 Op::Checks(op) => op.title(),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97713 Op::About(op) => op.title(),
714 Op::Deployments(op) => op.title(),
Merge branch 'worktree-agent-a3abfcce648e87dca'715 Op::Protection(op) => op.title(),
API and MCP for a workspace's personal access token rules, members' tokens and approvals716 Op::Tokens(op) => op.title(),
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2717 Op::Artifacts(op) => op.title(),
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca718 Op::DeployKeys(op) => op.title(),
Merge packages: roles, Actions access, source label, soft delete, API719 Op::Packages(op) => op.title(),
API and MCP server in Rust; a public index at the API root720 }
721}
722
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look723/// Why an operation can be refused with `402 payment_required`, if it
724/// can: the ones that start an agent, when the workspace has no credit,
725/// and the ones that make a repository private in a workspace, when a free
726/// workspace's private storage has no room for it.
727fn may_need_payment(op: Op) -> Option<&'static str> {
728 match op {
729 Op::AssignIssue | Op::PlanWork | Op::ApplyPlan => Some("The workspace has no agent credit."),
730 Op::UpdateRepo | Op::SetRepoVisibility | Op::TransferRepo => Some(
731 "A free workspace's private storage has no room for this private repository.",
732 ),
733 _ => None,
734 }
Merge branch 'worktree-agent-ab2e39e11a6493412'735}
736
737/// What the reference says beyond each operation's own description, keyed
738/// by operation id, written by hand from what the services return: `notes`
739/// (Markdown, added to the description) and example `params` (path),
740/// `query`, `request` (body) and `response`.
741const REFERENCE: &str = include_str!("reference.json");
742
743fn examples() -> Map<String, Value> {
744 match serde_json::from_str(REFERENCE) {
745 Ok(Value::Object(examples)) => examples,
746 _ => Map::new(),
API and MCP server in Rust; a public index at the API root747 }
748}
749
Agents as a team: lifecycle, merge queue, billing and a new shell750/// `/repos/:owner/:name` as OpenAPI writes it: `/repos/{owner}/{name}`.
API and MCP server in Rust; a public index at the API root751fn openapi_path(route: &Route) -> String {
752 route
753 .path
754 .split('/')
755 .map(|segment| match segment.strip_prefix(':') {
756 Some(name) => format!("{{{name}}}"),
757 None => segment.to_owned(),
758 })
759 .collect::<Vec<_>>()
760 .join("/")
761}
762
763fn error_response(description: &str) -> Value {
764 json!({
765 "description": description,
766 "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } },
767 })
768}
769
Merge branch 'worktree-agent-ab2e39e11a6493412'770/// A parameter in the path or the query, described by the operation's
771/// input schema where it has the same name.
772fn parameter(name: &str, place: &str, required: bool, schema: Option<&Value>) -> Value {
773 let mut schema = schema.cloned().unwrap_or_else(|| json!({ "type": "string" }));
774 let description = match name {
775 "owner" => Some(Value::from("The workspace that owns the repository.")),
776 "name" => Some(Value::from("The repository's name.")),
777 _ => schema.as_object_mut().and_then(|schema| schema.remove("description")),
778 };
779 let mut parameter = json!({
780 "name": name,
781 "in": place,
782 "required": required,
783 "schema": schema,
784 });
785 if let Some(description) = description {
786 parameter["description"] = description;
787 }
788 parameter
789}
790
791/// The operation id of a route. An operation reached at a workspace's
792/// address as well as a repository's is documented once for each, with its
793/// own id; GitHub's alternative addresses for one operation keep GitHub's
794/// names.
795fn operation_id(route: &Route) -> String {
796 let op = route.op;
797 let base = match (route.method, route.path.rsplit('/').next().unwrap_or_default()) {
798 ("PUT", "enable") => "enable_workflow".to_owned(),
799 ("PUT", "disable") => "disable_workflow".to_owned(),
800 ("POST", "rerun-failed-jobs") => "rerun_failed_jobs".to_owned(),
801 ("PATCH", ":setting") => "update_actions_variable".to_owned(),
802 ("GET", "runs") if route.path.contains("/workflows/:workflow/") => "list_runs_of_workflow".to_owned(),
API: notifications over REST and MCP, with notifications scopes803 // One repository's notifications, and an issue's subscription by
804 // its number rather than a thread's id.
805 (_, "notifications") if route.path.starts_with("/repos/") => match op {
806 Op::ListNotifications => "list_repo_notifications".to_owned(),
807 _ => "mark_repo_notifications_read".to_owned(),
808 },
809 (method, "subscription") if route.path.contains("/issues/:number/") => match method {
810 "GET" => "get_issue_subscription".to_owned(),
811 "PUT" => "set_issue_subscription".to_owned(),
812 _ => "delete_issue_subscription".to_owned(),
813 },
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar814 // One label off an issue, by its name in the path.
815 ("DELETE", ":label") if route.path.contains("/issues/:number/") => "remove_issue_label".to_owned(),
API: notifications over REST and MCP, with notifications scopes816 ("DELETE", "saved") => "unsave_thread".to_owned(),
817 ("DELETE", "snooze") => "unsnooze_thread".to_owned(),
Merge branch 'worktree-agent-ab2e39e11a6493412'818 _ => op.name().to_owned(),
819 };
820 if route.path.starts_with("/workspaces/") && ROUTES.iter().any(|other| other.op == op && other.path.starts_with("/repos/")) {
821 format!("{base}_for_workspace")
822 } else {
823 base
824 }
825}
826
827/// The summary of a route: its operation's title, or for one of GitHub's
828/// alternative addresses, what that address does.
829fn summary(route: &Route, id: &str) -> String {
830 let base = match id.trim_end_matches("_for_workspace") {
831 "enable_workflow" => "Turn a workflow on",
832 "disable_workflow" => "Turn a workflow off",
833 "rerun_failed_jobs" => "Re-run failed jobs",
834 "update_actions_variable" => "Update a variable",
835 "list_runs_of_workflow" => "List a workflow's runs",
API: notifications over REST and MCP, with notifications scopes836 "list_repo_notifications" => "List a repository's notifications",
837 "mark_repo_notifications_read" => "Mark a repository's notifications read",
838 "get_issue_subscription" => "Get your subscription to an issue",
839 "set_issue_subscription" => "Subscribe to an issue",
840 "delete_issue_subscription" => "Unsubscribe from an issue",
841 "unsave_thread" => "Unsave a thread",
842 "unsnooze_thread" => "Bring a snoozed thread back",
Merge branch 'worktree-agent-ab2e39e11a6493412'843 _ => title(route.op),
844 };
845 if id.ends_with("_for_workspace") {
846 format!("{base} for a workspace")
847 } else {
848 base.to_owned()
849 }
850}
851
API and MCP server in Rust; a public index at the API root852fn operation(route: &Route) -> Value {
853 let op = route.op;
854 let path_params: Vec<&str> = route.params().collect();
Merge checks: statuses and check runs on every commit855 // `owner` and `name` in the path stand for the operation's `repo` input,
856 // so a `name` in the body, such as a check run's, is the body's own.
857 let stands_for_repo =
858 |name: &str| matches!(name, "owner" | "name") && path_params.contains(&"owner") && path_params.contains(&"name");
859 let covered = |name: &str| name == "repo" || (path_params.contains(&name) && !stands_for_repo(name));
Merge branch 'worktree-agent-ab2e39e11a6493412'860 let all_properties = op.properties();
861 let mut properties = all_properties.clone();
API and MCP server in Rust; a public index at the API root862 properties.retain(|name, _| !covered(name));
863 let required: Vec<String> = op
864 .required()
865 .into_iter()
866 .filter(|name| !covered(name))
867 .collect();
868
869 let mut parameters: Vec<Value> = path_params
870 .iter()
Merge checks: statuses and check runs on every commit871 .map(|name| parameter(name, "path", true, if stands_for_repo(name) { None } else { all_properties.get(*name) }))
API and MCP server in Rust; a public index at the API root872 .collect();
873 let mut body = Value::Null;
874 if route.method == "GET" {
875 for (name, key) in route.query {
Merge branch 'worktree-agent-ab2e39e11a6493412'876 parameters.push(parameter(
877 name,
878 "query",
879 required.iter().any(|required| required == key),
880 properties.get(*key),
881 ));
API and MCP server in Rust; a public index at the API root882 }
883 } else if !properties.is_empty() {
884 let mut schema = json!({ "type": "object", "properties": properties });
885 if !required.is_empty() {
886 schema["required"] = json!(required);
887 }
888 body = json!({
889 "required": !required.is_empty(),
890 "content": { "application/json": { "schema": schema } },
891 });
892 }
893
Merge branch 'worktree-agent-ab2e39e11a6493412'894 let id = operation_id(route);
895 let mut responses = Map::new();
896 responses.insert(
897 "200".into(),
898 json!({
899 "description": "Success.",
900 "content": { "application/json": { "schema": {} } },
901 }),
902 );
903 responses.insert(
904 "401".into(),
905 error_response("A token is required, or the one sent is not valid."),
906 );
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look907 if let Some(reason) = may_need_payment(op) {
908 responses.insert("402".into(), error_response(reason));
Merge branch 'worktree-agent-ab2e39e11a6493412'909 }
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step910 responses.insert(
911 "403".into(),
912 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."),
913 );
Search across all of g1t, Explore, and a command palette914 if !matches!(op, Op::Whoami | Op::ListRepos | Op::Search) {
Merge branch 'worktree-agent-ab2e39e11a6493412'915 responses.insert("404".into(), error_response("It does not exist, or you cannot see it."));
916 }
917 if route.method != "GET" {
918 responses.insert(
919 "409".into(),
920 error_response("The request conflicts with the current state."),
921 );
922 }
923 if op != Op::Whoami {
924 responses.insert("422".into(), error_response("The input is not valid."));
925 }
926 // 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 step927 let scope: Vec<&str> = scope_for(op.name()).map(|scope| scope.as_str()).into_iter().collect();
Merge branch 'worktree-agent-ab2e39e11a6493412'928 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 step929 json!([{ "token": scope }])
Webhooks: every event, to your own addresses, signed and retried930 } else {
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step931 json!([{ "token": scope }, {}])
Webhooks: every event, to your own addresses, signed and retried932 };
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step933 let (tool, action) = crate::tools::TOOLS
934 .iter()
935 .find_map(|tool| {
936 tool.actions
937 .iter()
938 .find(|action| action.op == op)
939 .map(|action| (tool.name, action.name))
940 })
941 .unwrap_or_default();
API and MCP server in Rust; a public index at the API root942 let mut described = json!({
Webhooks: every event, to your own addresses, signed and retried943 "operationId": id,
API and MCP server in Rust; a public index at the API root944 "tags": [tag(op)],
Merge branch 'worktree-agent-ab2e39e11a6493412'945 "summary": summary(route, &id),
API and MCP server in Rust; a public index at the API root946 "description": op.description(),
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step947 "x-operation": op.name(),
948 "x-mcp-tool": tool,
949 "x-mcp-action": action,
950 "x-scope": scope.first().copied(),
Merge branch 'worktree-agent-ab2e39e11a6493412'951 "security": security,
API and MCP server in Rust; a public index at the API root952 "parameters": parameters,
Merge branch 'worktree-agent-ab2e39e11a6493412'953 "responses": responses,
API and MCP server in Rust; a public index at the API root954 });
955 if !body.is_null() {
956 described["requestBody"] = body;
957 }
958 described
959}
960
961/// Entries for device sign-in, which is not an operation.
962fn onboarding() -> Map<String, Value> {
963 let paths = json!({
Agents as a team: lifecycle, merge queue, billing and a new shell964 "/device/code": {
API and MCP server in Rust; a public index at the API root965 "post": {
966 "operationId": "device_code",
967 "tags": ["Accounts"],
968 "summary": "Start signing in",
Agents as a team: lifecycle, merge queue, billing and a new shell969 "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`.",
API and MCP server in Rust; a public index at the API root970 "security": [],
971 "requestBody": {
972 "content": { "application/json": { "schema": {
973 "type": "object",
974 "properties": {
975 "client_name": {
976 "type": "string",
977 "description": "What is asking, shown to the person approving. For example, Claude Code.",
978 },
979 },
980 } } },
981 },
982 "responses": { "200": {
983 "description": "The codes for this sign-in.",
984 "content": { "application/json": { "schema": {
985 "type": "object",
986 "properties": {
Agents as a team: lifecycle, merge queue, billing and a new shell987 "device_code": { "type": "string", "description": "Secret. Send it to /device/token." },
API and MCP server in Rust; a public index at the API root988 "user_code": { "type": "string", "description": "Shown to the person, like WDJB-MJHT." },
989 "verification_uri": { "type": "string" },
990 "verification_uri_complete": {
991 "type": "string",
992 "description": "The link to give the person; it carries the code.",
993 },
994 "expires_in": { "type": "integer", "description": "Seconds until the codes expire." },
995 "interval": { "type": "integer", "description": "Seconds to wait between polls." },
996 },
997 } } },
998 } },
999 },
1000 },
Agents as a team: lifecycle, merge queue, billing and a new shell1001 "/device/token": {
API and MCP server in Rust; a public index at the API root1002 "post": {
1003 "operationId": "device_token",
1004 "tags": ["Accounts"],
1005 "summary": "Finish signing in",
1006 "description": "Asks whether the person has approved. Poll no faster than the interval. The token is returned once.",
1007 "security": [],
1008 "requestBody": {
1009 "required": true,
1010 "content": { "application/json": { "schema": {
1011 "type": "object",
1012 "required": ["device_code"],
1013 "properties": { "device_code": { "type": "string" } },
1014 } } },
1015 },
1016 "responses": { "200": {
1017 "description": "The state of the sign-in.",
1018 "content": { "application/json": { "schema": {
1019 "type": "object",
1020 "required": ["status"],
1021 "properties": {
1022 "status": { "type": "string", "enum": ["pending", "approved", "denied", "expired"] },
1023 "token": { "type": "string", "description": "Present when approved." },
1024 "username": { "type": "string" },
1025 "verified": {
1026 "type": "boolean",
1027 "description": "Whether the account's email is confirmed.",
1028 },
1029 },
1030 } } },
1031 } },
1032 },
1033 },
1034 });
1035 match paths {
1036 Value::Object(paths) => paths,
1037 _ => Map::new(),
1038 }
1039}
1040
Merge branch 'worktree-agent-ab2e39e11a6493412'1041
1042/// Puts each operation's examples, where it has them, into its request
1043/// and response. Path and query values go under `x-example-params` and
1044/// `x-example-query`, which tools that build a request can use.
1045fn attach_examples(paths: &mut Map<String, Value>) {
1046 let examples = examples();
1047 for methods in paths.values_mut() {
1048 let Some(methods) = methods.as_object_mut() else { continue };
1049 for operation in methods.values_mut() {
1050 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 step1051 let name = operation["x-operation"].as_str().unwrap_or_default().to_owned();
1052 let Some(example) = examples.get(&id).or_else(|| examples.get(&name)) else {
Merge branch 'worktree-agent-ab2e39e11a6493412'1053 continue;
1054 };
1055 if let Some(notes) = example.get("notes").and_then(Value::as_str) {
1056 let description = operation["description"].as_str().unwrap_or_default();
1057 operation["description"] = json!(format!("{description}\n\n{notes}"));
1058 }
1059 if let Some(response) = example.get("response") {
1060 let content = &mut operation["responses"]["200"]["content"]["application/json"];
1061 if content.is_object() {
1062 content["example"] = response.clone();
1063 }
1064 }
1065 if let Some(request) = example.get("request") {
1066 let content = &mut operation["requestBody"]["content"]["application/json"];
1067 if content.is_object() {
1068 content["example"] = request.clone();
1069 }
1070 }
1071 for (key, extension) in [("params", "x-example-params"), ("query", "x-example-query")] {
1072 if let Some(values) = example.get(key) {
1073 operation[extension] = values.clone();
1074 }
1075 }
1076 }
1077 }
1078}
1079
API and MCP server in Rust; a public index at the API root1080pub fn document() -> Value {
1081 let mut paths = onboarding();
1082 for route in ROUTES {
1083 let entry = paths
1084 .entry(openapi_path(route))
1085 .or_insert_with(|| json!({}));
1086 entry[route.method.to_lowercase()] = operation(route);
1087 }
Merge branch 'worktree-agent-ab2e39e11a6493412'1088 attach_examples(&mut paths);
1089 let tags: Vec<Value> = SECTIONS
1090 .iter()
1091 .map(|(name, description, ops)| {
1092 json!({
1093 "name": name,
1094 "description": description,
1095 // The section's operations in reading order, by MCP tool name.
1096 "x-tools": ops.iter().map(|op| op.name()).collect::<Vec<_>>(),
1097 })
1098 })
1099 .collect();
1100 let codes = ["unauthenticated", "payment_required", "forbidden", "not_found", "conflict", "invalid"];
API and MCP server in Rust; a public index at the API root1101 json!({
1102 "openapi": "3.1.0",
1103 "info": {
1104 "title": "g1t API",
1105 "version": "1",
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API1106 "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.",
API and MCP server in Rust; a public index at the API root1107 "license": { "name": "MIT", "identifier": "MIT" },
1108 },
1109 "servers": [{ "url": "https://api.g1t.sh" }],
1110 "security": [{ "token": [] }, {}],
Merge branch 'worktree-agent-ab2e39e11a6493412'1111 "tags": tags,
API and MCP server in Rust; a public index at the API root1112 "paths": paths,
1113 "components": {
1114 "securitySchemes": {
1115 "token": {
1116 "type": "http",
1117 "scheme": "bearer",
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1118 "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.",
API and MCP server in Rust; a public index at the API root1119 },
1120 },
1121 "schemas": {
1122 "Error": {
1123 "type": "object",
1124 "required": ["error"],
1125 "properties": {
1126 "error": {
1127 "type": "object",
1128 "required": ["code", "message"],
1129 "properties": {
Merge branch 'worktree-agent-ab2e39e11a6493412'1130 "code": { "type": "string", "enum": codes },
API and MCP server in Rust; a public index at the API root1131 "message": { "type": "string" },
Thirteen MCP tools and classic token scopes; agents rate their confidence and can be put on an issue in one step1132 "needed_scope": {
1133 "type": "string",
1134 "description": "On a 403 for an access token without the scope the call needs: that scope, such as `issues:write`.",
1135 },
API and MCP server in Rust; a public index at the API root1136 },
1137 },
1138 },
1139 },
1140 },
1141 },
1142 })
1143}
1144
1145#[cfg(test)]
1146mod tests {
1147 use super::*;
1148
1149 #[test]
1150 fn every_route_is_documented_once() {
1151 let document = document();
1152 let mut ids = Vec::new();
1153 for (_, methods) in document["paths"].as_object().unwrap() {
1154 for (_, operation) in methods.as_object().unwrap() {
1155 ids.push(operation["operationId"].as_str().unwrap().to_owned());
1156 }
1157 }
1158 for op in Op::ALL {
1159 assert_eq!(
1160 ids.iter().filter(|id| *id == op.name()).count(),
1161 1,
1162 "{}",
1163 op.name()
1164 );
1165 }
Webhooks: every event, to your own addresses, signed and retried1166 let mut unique = ids.clone();
1167 unique.sort();
1168 unique.dedup();
1169 assert_eq!(unique.len(), ids.len(), "operation ids repeat");
API and MCP server in Rust; a public index at the API root1170 }
1171
1172 #[test]
1173 fn path_and_query_inputs_are_not_repeated_in_the_body() {
1174 let document = document();
Agents as a team: lifecycle, merge queue, billing and a new shell1175 let merge = &document["paths"]["/repos/{owner}/{name}/pulls/{number}/merge"]["post"];
API and MCP server in Rust; a public index at the API root1176 let body = &merge["requestBody"]["content"]["application/json"]["schema"]["properties"];
1177 assert!(body.get("keep_issue_open").is_some());
1178 assert!(body.get("repo").is_none() && body.get("number").is_none());
Agents as a team: lifecycle, merge queue, billing and a new shell1179 let list = &document["paths"]["/repos"]["get"];
API and MCP server in Rust; a public index at the API root1180 assert_eq!(list["parameters"][0]["name"], "q");
1181 assert!(list.get("requestBody").is_none());
1182 }
1183
1184 #[test]
Merge branch 'worktree-agent-ab2e39e11a6493412'1185 fn every_operation_is_in_one_section() {
1186 for op in Op::ALL {
1187 let sections = SECTIONS
1188 .iter()
1189 .filter(|(_, _, ops)| ops.contains(&op))
1190 .count();
1191 assert_eq!(sections, 1, "{}", op.name());
1192 }
1193 }
1194
1195 #[test]
API and MCP server in Rust; a public index at the API root1196 fn titles_read_as_sentences() {
Merge branch 'worktree-agent-ab2e39e11a6493412'1197 assert_eq!(title(Op::CreateIssue), "Create an issue");
API and MCP server in Rust; a public index at the API root1198 assert_eq!(title(Op::Whoami), "Get the current user");
1199 }
Merge branch 'worktree-agent-ab2e39e11a6493412'1200
1201 #[test]
1202 fn every_operation_has_an_example_response() {
1203 let examples = examples();
1204 assert!(!examples.is_empty(), "reference.json does not parse");
1205 let document = document();
1206 let mut known = Vec::new();
1207 for (path, methods) in document["paths"].as_object().unwrap() {
1208 for (method, operation) in methods.as_object().unwrap() {
1209 known.push(operation["operationId"].as_str().unwrap().to_owned());
1210 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1211 assert!(!example.is_null(), "{method} {path} has no example response");
1212 }
1213 }
1214 for id in examples.keys() {
1215 assert!(known.contains(id), "reference.json names {id}, which is not an operation");
1216 }
1217 }
1218
1219 #[test]
1220 fn example_requests_send_only_what_the_body_takes() {
1221 let document = document();
1222 for (path, methods) in document["paths"].as_object().unwrap() {
1223 for (method, operation) in methods.as_object().unwrap() {
1224 let content = &operation["requestBody"]["content"]["application/json"];
1225 let Some(example) = content["example"].as_object() else { continue };
1226 let properties = &content["schema"]["properties"];
1227 for key in example.keys() {
1228 assert!(!properties[key].is_null(), "{method} {path}: {key} is not in the body");
1229 }
1230 }
1231 }
1232 }
1233
1234 /// The docs site's copy of the document. Run with `G1T_WRITE_OPENAPI=1`
1235 /// to rewrite it after changing an operation.
1236 #[test]
1237 fn the_docs_copy_is_current() {
1238 let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/src/data/openapi.json");
1239 let current = serde_json::to_string_pretty(&document()).unwrap() + "\n";
1240 if std::env::var_os("G1T_WRITE_OPENAPI").is_some() {
1241 std::fs::write(path, &current).unwrap();
1242 return;
1243 }
1244 let copy = std::fs::read_to_string(path).unwrap_or_default().replace("\r\n", "\n");
1245 assert!(
1246 copy == current,
1247 "apps/docs/src/data/openapi.json is out of date: run G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi"
1248 );
1249 }
API reference: no example reads as a real secret1250
Agents get guardrails, run credentials, an audit log, a context hub, repository instructions and mentions; security upkeep; snake_case API1251 /// The reference shows responses as they are sent: `snake_case`.
1252 #[test]
1253 fn example_responses_are_snake_case() {
1254 let document = document();
1255 for (path, methods) in document["paths"].as_object().unwrap() {
1256 for (method, operation) in methods.as_object().unwrap() {
1257 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1258 let leaked = g1t_kit::wire::camel_case_keys(example);
1259 assert!(leaked.is_empty(), "{method} {path} shows {leaked:?}");
1260 }
1261 }
1262 }
1263
API reference: no example reads as a real secret1264 /// Examples never hold anything that reads as a real credential, which
1265 /// secret scanners rightly flag in a public repository: they end in `…`
1266 /// after the prefix, as `whsec_…` and `g1t_…` do.
1267 #[test]
1268 fn examples_hold_no_real_looking_secrets() {
Fast pages, required checks on the branch, self-hosted runners, honest incidents1269 let prefixes = ["whsec_", "g1t_", "g1tr_", "g1trt_", "sk_live_", "sk_test_", "ghp_", "github_pat_", "xoxb-", "AKIA"];
API reference: no example reads as a real secret1270 for (line, text) in REFERENCE.lines().enumerate() {
1271 for prefix in prefixes {
1272 let mut rest = text;
1273 while let Some(at) = rest.find(prefix) {
1274 let after = &rest[at + prefix.len()..];
1275 let run = after.chars().take_while(|c| c.is_ascii_alphanumeric()).count();
1276 assert!(
1277 run < 12,
1278 "reference.json line {}: `{prefix}` followed by {run} characters reads as a real secret; write `{prefix}…`",
1279 line + 1
1280 );
1281 rest = after;
1282 }
1283 }
1284 }
1285 }
API and MCP server in Rust; a public index at the API root1286}

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