Skip to content
Sign up

flagon-io/g1t

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

A project is an app or a library: libraries show their package and how to ship a release, not production1//! 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 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.12use crate::archives::ArchiveOp;
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca13use crate::deploy_keys::DeployKeysOp;
Merge branch 'mirroring' into artifacts-mode14use crate::mirrors::MirrorsOp;
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9715use crate::deployments::DeploymentsOp;
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-a3abfcce648e87dca'19use crate::protection::ProtectionOp;
API and MCP for a workspace's personal access token rules, members' tokens and approvals20use crate::token_policy::TokenOp;
A project is an app or a library: libraries show their package and how to ship a release, not production21use crate::operations::Op;
Merge checks: statuses and check runs on every commit22use crate::checks::ChecksOp;
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge23use crate::rules::RulesOp;
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar24use crate::security::SecurityOp;
A project is an app or a library: libraries show their package and how to ship a release, not production25use crate::rest::{ROUTES, Route};
26
27/// The sections of the API reference: a name, what it covers, and its
28/// operations in the order a reader meets them.
29const SECTIONS: &[(&str, &str, &[Op])] = &[
30 (
31 "Accounts",
32 "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)33 &[Op::Whoami, Op::ListEmails, Op::AddEmail, Op::ConfirmEmail, Op::RemoveEmail, Op::UpdateEmailSettings],
A project is an app or a library: libraries show their package and how to ship a release, not production34 ),
35 (
API: notifications over REST and MCP, with notifications scopes36 "Notifications",
37 "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.",
38 &[
39 Op::ListNotifications,
40 Op::MarkNotificationsRead,
41 Op::GetNotificationThread,
42 Op::MarkThreadRead,
43 Op::MarkThreadDone,
44 Op::SaveThread,
45 Op::SnoozeThread,
46 Op::GetThreadSubscription,
47 Op::SetThreadSubscription,
48 Op::DeleteThreadSubscription,
49 Op::GetRepoSubscription,
50 Op::SetRepoSubscription,
51 Op::DeleteRepoSubscription,
52 Op::ListWatchedRepos,
53 ],
54 ),
55 (
API: pinned projects over REST and MCP56 "Pinned projects",
57 "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.",
58 &[Op::ListPinnedProjects, Op::PinProject, Op::UnpinProject, Op::ReorderPinnedProjects],
59 ),
60 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb9761 "Projects",
62 "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.",
63 &[Op::ListProjects, Op::GetProject, Op::UpdateProject],
64 ),
65 (
A project is an app or a library: libraries show their package and how to ship a release, not production66 "Workspaces",
67 "A workspace owns repositories and is the first part of their address. People and agents work in workspaces.",
Merge branch 'worktree-agent-ad7c6d88d93adc817'68 &[Op::GetWorkspace, Op::CreateWorkspace, Op::UpdateWorkspace, Op::DeleteWorkspace],
A project is an app or a library: libraries show their package and how to ship a release, not production69 ),
70 (
API and MCP for a workspace's personal access token rules, members' tokens and approvals71 "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 managers72 "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 approvals73 &[
74 Op::Tokens(TokenOp::GetTokenPolicy),
75 Op::Tokens(TokenOp::SetTokenPolicy),
76 Op::Tokens(TokenOp::ListMemberTokens),
77 Op::Tokens(TokenOp::ListTokenRequests),
78 Op::Tokens(TokenOp::ReviewTokenRequest),
79 Op::Tokens(TokenOp::RevokeMemberToken),
80 ],
81 ),
82 (
Merge main (membership, two-factor, GitHub repo roles) into tokens83 "Members",
84 "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.",
85 &[Op::ListMembers, Op::UpdateMember, Op::RemoveMember, Op::TransferOwnership, Op::LeaveWorkspace],
86 ),
87 (
A project is an app or a library: libraries show their package and how to ship a release, not production88 "Invites",
Merge workspace invitations: nobody joins a workspace without saying yes, people are found by username, your own invites can bring someone in, and nobody is left without a workspace (identity 0040)89 "While g1t is invite-only, every new account needs an invite. Your invites, inviting people into a workspace by username or email, and answering the invitations to workspaces sent to you.",
A project is an app or a library: libraries show their package and how to ship a release, not production90 &[
91 Op::ListInvites,
92 Op::CreateInvite,
93 Op::RevokeInvite,
94 Op::ListWorkspaceInvites,
95 Op::InviteMember,
96 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)97 Op::ListInvitations,
98 Op::AcceptInvitation,
99 Op::DeclineInvitation,
A project is an app or a library: libraries show their package and how to ship a release, not production100 ],
101 ),
102 (
Usage, Billing settings and prepaid AI credit; fixes from the UX audit103 "Billing",
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.104 "A workspace's usage, its budget, its AI credit and its invoices. Members read them; owners change the budget and buy credit, as people. A run's token never changes billing.",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit105 &[
106 Op::GetUsage,
107 Op::GetBudget,
108 Op::SetBudget,
109 Op::GetAiCredit,
110 Op::BuyAiCredit,
111 Op::ListInvoices,
112 Op::GetBillingDetails,
113 ],
114 ),
115 (
A project is an app or a library: libraries show their package and how to ship a release, not production116 "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.",
A project is an app or a library: libraries show their package and how to ship a release, not production118 &[
119 Op::ListRepos,
120 Op::CreateRepo,
121 Op::GetRepo,
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.122 Op::Archives(ArchiveOp::DownloadTarball),
123 Op::Archives(ArchiveOp::DownloadZipball),
A project is an app or a library: libraries show their package and how to ship a release, not production124 Op::UpdateRepo,
125 Op::RenameRepo,
126 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.127 Op::CreateBranch,
128 Op::DeleteBranch,
A project is an app or a library: libraries show their package and how to ship a release, not production129 Op::SetRepoVisibility,
130 Op::ArchiveRepo,
131 Op::UnarchiveRepo,
132 Op::TransferRepo,
133 Op::DeleteRepo,
134 Op::ListDeletedRepos,
135 Op::RestoreRepo,
136 Op::PurgeRepo,
137 Op::GetRepoSettings,
138 Op::UpdateRepoSettings,
139 Op::ListCheckNames,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar140 Op::GetCodeownersErrors,
A project is an app or a library: libraries show their package and how to ship a release, not production141 Op::ListEvents,
142 ],
143 ),
144 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97145 "Repository insights",
146 "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.",
147 &[Op::About(AboutOp::GetLanguages), Op::About(AboutOp::ListContributors), Op::About(AboutOp::GetLicense)],
148 ),
149 (
150 "Stars",
151 "Starring a repository, to keep it and to say you like it: who starred one, and what you starred.",
152 &[
153 Op::About(AboutOp::ListStargazers),
154 Op::About(AboutOp::ListStarred),
155 Op::About(AboutOp::CheckStarred),
156 Op::About(AboutOp::Star),
157 Op::About(AboutOp::Unstar),
158 ],
159 ),
160 (
161 "Releases",
162 "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.",
163 &[
164 Op::About(AboutOp::ListReleases),
165 Op::About(AboutOp::CreateRelease),
166 Op::About(AboutOp::GetLatestRelease),
167 Op::About(AboutOp::GetReleaseByTag),
168 Op::About(AboutOp::GetRelease),
169 Op::About(AboutOp::UpdateRelease),
170 Op::About(AboutOp::DeleteRelease),
171 ],
172 ),
173 (
A project is an app or a library: libraries show their package and how to ship a release, not production174 "Access",
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca175 "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.",
A project is an app or a library: libraries show their package and how to ship a release, not production176 &[
177 Op::ListCollaborators,
178 Op::AddCollaborator,
179 Op::UpdateCollaborator,
180 Op::RemoveCollaborator,
181 Op::GetCollaboratorPermission,
182 Op::ListRepoInvitations,
183 Op::RevokeRepoInvitation,
184 Op::ListMyRepoInvitations,
185 Op::AcceptRepoInvitation,
186 Op::DeclineRepoInvitation,
187 Op::SetBasePermission,
188 Op::ListOutsideCollaborators,
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca189 Op::DeployKeys(DeployKeysOp::ListDeployKeys),
190 Op::DeployKeys(DeployKeysOp::GetDeployKey),
191 Op::DeployKeys(DeployKeysOp::CreateDeployKey),
192 Op::DeployKeys(DeployKeysOp::DeleteDeployKey),
A project is an app or a library: libraries show their package and how to ship a release, not production193 ],
194 ),
195 (
Merge branch 'mirroring' into artifacts-mode196 "Mirroring",
197 "A repository's links to copies of it on other hosts: a mirror stands by as a read-only copy of a remote that leads, until someone takes over on g1t and later hands back, or moves it to g1t for good. A repository g1t leads can be mirrored to other hosts.",
198 &[
199 Op::Mirrors(MirrorsOp::GetMirror),
200 Op::Mirrors(MirrorsOp::GetHandBackPlan),
201 Op::Mirrors(MirrorsOp::TakeOver),
202 Op::Mirrors(MirrorsOp::SetCiFailover),
203 Op::Mirrors(MirrorsOp::HandBack),
204 Op::Mirrors(MirrorsOp::MoveToG1t),
205 Op::Mirrors(MirrorsOp::SyncMirror),
206 Op::Mirrors(MirrorsOp::AddRemote),
207 Op::Mirrors(MirrorsOp::UpdateRemote),
208 Op::Mirrors(MirrorsOp::RemoveRemote),
209 ],
210 ),
211 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar212 "Teams",
213 "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.",
214 &[
215 Op::ListTeams,
216 Op::CreateTeam,
217 Op::GetTeam,
218 Op::UpdateTeam,
219 Op::DeleteTeam,
220 Op::ListTeamMembers,
221 Op::SetTeamMember,
222 Op::RemoveTeamMember,
223 Op::ListChildTeams,
224 Op::ListTeamRepos,
225 Op::SetTeamRepo,
226 Op::RemoveTeamRepo,
227 Op::SetTeamReviewAssignment,
228 Op::ListUserTeams,
229 ],
230 ),
231 (
A project is an app or a library: libraries show their package and how to ship a release, not production232 "Security",
233 "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.",
234 &[Op::ListSecurityAlerts, Op::DismissSecurityAlert, Op::ReopenSecurityAlert],
235 ),
236 (
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar237 "Secret scanning",
238 "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.",
239 &[
240 Op::Security(SecurityOp::ListSecretAlerts),
241 Op::Security(SecurityOp::GetSecretAlert),
242 Op::Security(SecurityOp::UpdateSecretAlert),
243 Op::Security(SecurityOp::ListSecretLocations),
244 Op::Security(SecurityOp::BypassPushProtection),
245 Op::Security(SecurityOp::CheckSecretValidity),
246 Op::Security(SecurityOp::ListBypassRequests),
247 Op::Security(SecurityOp::ReviewBypassRequest),
248 Op::Security(SecurityOp::ListCustomPatterns),
249 Op::Security(SecurityOp::CreateCustomPattern),
250 Op::Security(SecurityOp::UpdateCustomPattern),
251 Op::Security(SecurityOp::DeleteCustomPattern),
252 Op::Security(SecurityOp::DryRunCustomPattern),
253 ],
254 ),
255 (
256 "Code scanning",
257 "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.",
258 &[
259 Op::Security(SecurityOp::ListCodeAlerts),
260 Op::Security(SecurityOp::GetCodeAlert),
261 Op::Security(SecurityOp::UpdateCodeAlert),
262 Op::Security(SecurityOp::ListAnalyses),
263 Op::Security(SecurityOp::UploadSarif),
264 Op::Security(SecurityOp::GetSarifUpload),
265 ],
266 ),
267 (
268 "Supply chain",
269 "What a repository depends on: vulnerability alerts, the dependency graph, an SPDX SBOM of it, and comparing two commits' dependencies as dependency review does.",
270 &[
271 Op::Security(SecurityOp::ListVulnerabilityAlerts),
272 Op::Security(SecurityOp::GetVulnerabilityAlert),
273 Op::Security(SecurityOp::UpdateVulnerabilityAlert),
274 Op::Security(SecurityOp::GetDependencyGraph),
275 Op::Security(SecurityOp::GetSbom),
276 Op::Security(SecurityOp::CompareDependencies),
277 ],
278 ),
279 (
280 "Security settings",
281 "When pull request checks fail, dependency review's policy, delegated bypass and validity checks, and a workspace's security overview.",
282 &[
283 Op::Security(SecurityOp::GetSettings),
284 Op::Security(SecurityOp::UpdateSettings),
285 Op::Security(SecurityOp::GetWorkspaceSettings),
286 Op::Security(SecurityOp::UpdateWorkspaceSettings),
287 Op::Security(SecurityOp::GetOverview),
288 ],
289 ),
290 (
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9291 "Security advisories",
292 "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.",
293 &[
294 Op::Security(SecurityOp::ListAdvisories),
295 Op::Security(SecurityOp::CreateAdvisory),
296 Op::Security(SecurityOp::GetAdvisory),
297 Op::Security(SecurityOp::UpdateAdvisory),
298 Op::Security(SecurityOp::SetAdvisoryState),
299 Op::Security(SecurityOp::ListReports),
300 Op::Security(SecurityOp::ReportVulnerability),
301 Op::Security(SecurityOp::ReviewReport),
302 ],
303 ),
304 (
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge305 "Rules",
306 "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.",
307 &[
308 Op::Rules(RulesOp::ListRepoRulesets),
309 Op::Rules(RulesOp::CreateRepoRuleset),
310 Op::Rules(RulesOp::GetRepoRuleset),
311 Op::Rules(RulesOp::UpdateRepoRuleset),
312 Op::Rules(RulesOp::DeleteRepoRuleset),
313 Op::Rules(RulesOp::GetBranchRules),
314 Op::Rules(RulesOp::ListRuleEvaluations),
315 Op::Rules(RulesOp::ListWorkspaceRulesets),
316 Op::Rules(RulesOp::CreateWorkspaceRuleset),
317 Op::Rules(RulesOp::GetWorkspaceRuleset),
318 Op::Rules(RulesOp::UpdateWorkspaceRuleset),
319 Op::Rules(RulesOp::DeleteWorkspaceRuleset),
320 Op::Rules(RulesOp::ListWorkspaceRuleEvaluations),
321 ],
322 ),
323 (
Merge checks: statuses and check runs on every commit324 "Checks",
325 "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.",
326 &[
327 Op::Checks(ChecksOp::CreateCommitStatus),
328 Op::Checks(ChecksOp::ListCommitStatuses),
329 Op::Checks(ChecksOp::GetCombinedStatus),
330 Op::Checks(ChecksOp::CreateCheckRun),
331 Op::Checks(ChecksOp::UpdateCheckRun),
332 Op::Checks(ChecksOp::GetCheckRun),
333 Op::Checks(ChecksOp::ListCheckRunAnnotations),
334 Op::Checks(ChecksOp::RerequestCheckRun),
335 Op::Checks(ChecksOp::ListCheckRunsForRef),
336 Op::Checks(ChecksOp::ListCheckSuitesForRef),
337 Op::Checks(ChecksOp::GetCheckSuite),
338 Op::Checks(ChecksOp::RerequestCheckSuite),
339 ],
340 ),
341 (
A project is an app or a library: libraries show their package and how to ship a release, not production342 "Issues",
343 "What should change in a repository, with labels and comments. Issues and pull requests share one sequence of numbers.",
344 &[
345 Op::ListIssues,
346 Op::CreateIssue,
347 Op::GetIssue,
348 Op::UpdateIssue,
349 Op::CloseIssue,
350 Op::ReopenIssue,
351 Op::AddComment,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts352 Op::EditComment,
353 Op::DeleteComment,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar354 Op::ListIssueLabels,
355 Op::AddIssueLabels,
356 Op::SetIssueLabels,
357 Op::RemoveIssueLabels,
358 ],
359 ),
360 (
361 "Labels and milestones",
362 "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.",
363 &[
A project is an app or a library: libraries show their package and how to ship a release, not production364 Op::ListLabels,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar365 Op::CreateLabel,
366 Op::UpdateLabel,
367 Op::DeleteLabel,
368 Op::AddDefaultLabels,
369 Op::ListMilestones,
370 Op::CreateMilestone,
371 Op::GetMilestone,
372 Op::UpdateMilestone,
373 Op::DeleteMilestone,
A project is an app or a library: libraries show their package and how to ship a release, not production374 ],
375 ),
376 (
377 "Pull requests",
378 "A proposed change in its own fork or on a branch. Several can be made for one issue; the one merged resolves it.",
379 &[
380 Op::ListPullRequests,
381 Op::CreatePullRequest,
382 Op::GetPullRequest,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar383 Op::UpdatePullRequest,
A project is an app or a library: libraries show their package and how to ship a release, not production384 Op::GetPullRequestChanges,
385 Op::MarkPullRequestReady,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts386 Op::ConvertPullRequestToDraft,
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar387 Op::RequestReviewers,
388 Op::RemoveRequestedReviewers,
A project is an app or a library: libraries show their package and how to ship a release, not production389 Op::ReviewPullRequest,
390 Op::MergePullRequest,
391 Op::ClosePullRequest,
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts392 Op::ReopenPullRequest,
A project is an app or a library: libraries show their package and how to ship a release, not production393 Op::GetMergeQueue,
394 ],
395 ),
396 (
397 "Sessions",
398 "The record of how a pull request was made: prompts, reasoning and the tools that ran.",
399 &[Op::ReadSession, Op::RecordSession],
400 ),
401 (
402 "Memory",
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.403 "What agents and people learned that the next agent should know, for one project or across a workspace. Members only; never a secret.",
A project is an app or a library: libraries show their package and how to ship a release, not production404 &[Op::Remember, Op::Recall],
405 ),
406 (
407 "Search",
408 "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.",
409 &[Op::Search],
410 ),
411 (
412 "Actions",
413 "GitHub Actions workflows in .g1t/workflows, their runs, and their jobs' logs.",
414 &[
415 Op::ListWorkflows,
416 Op::ListWorkflowRuns,
417 Op::GetWorkflowRun,
418 Op::GetJobLogs,
419 Op::DispatchWorkflow,
420 Op::CancelWorkflowRun,
421 Op::RerunWorkflowRun,
422 Op::UpdateWorkflow,
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2423 Op::Artifacts(ArtifactsOp::ListArtifacts),
424 Op::Artifacts(ArtifactsOp::ListRunArtifacts),
425 Op::Artifacts(ArtifactsOp::GetArtifact),
426 Op::Artifacts(ArtifactsOp::DownloadArtifact),
427 Op::Artifacts(ArtifactsOp::DeleteArtifact),
428 Op::Artifacts(ArtifactsOp::GetArtifactRetention),
429 Op::Artifacts(ArtifactsOp::SetArtifactRetention),
A project is an app or a library: libraries show their package and how to ship a release, not production430 ],
431 ),
432 (
Merge packages: roles, Actions access, source label, soft delete, API433 "Packages",
434 "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.",
435 &[
436 Op::Packages(PackagesOp::ListPackages),
437 Op::Packages(PackagesOp::GetPackage),
438 Op::Packages(PackagesOp::UpdatePackage),
439 Op::Packages(PackagesOp::DeletePackage),
440 Op::Packages(PackagesOp::RestorePackage),
441 Op::Packages(PackagesOp::ListVersions),
442 Op::Packages(PackagesOp::GetVersion),
443 Op::Packages(PackagesOp::DeleteVersion),
444 Op::Packages(PackagesOp::RestoreVersion),
445 Op::Packages(PackagesOp::LinkPackage),
446 Op::Packages(PackagesOp::UnlinkPackage),
447 Op::Packages(PackagesOp::ListAccess),
448 Op::Packages(PackagesOp::SetAccess),
449 Op::Packages(PackagesOp::RemoveAccess),
450 Op::Packages(PackagesOp::ListActionsAccess),
451 Op::Packages(PackagesOp::SetActionsAccess),
452 Op::Packages(PackagesOp::RemoveActionsAccess),
453 ],
454 ),
455 (
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97456 "Deployments",
457 "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.",
458 &[
459 Op::Deployments(DeploymentsOp::ListDeployments),
460 Op::Deployments(DeploymentsOp::CreateDeployment),
461 Op::Deployments(DeploymentsOp::GetDeployment),
462 Op::Deployments(DeploymentsOp::ListDeploymentStatuses),
463 Op::Deployments(DeploymentsOp::CreateDeploymentStatus),
464 Op::Deployments(DeploymentsOp::ListEnvironments),
465 Op::Deployments(DeploymentsOp::GetEnvironment),
Merge branch 'worktree-agent-a4d35ee70c50683d0' into claude/cool-newton-7nm8r9466 Op::Deployments(DeploymentsOp::StartDeploymentBuild),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97467 ],
468 ),
469 (
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.470 "Observability",
471 "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.",
472 &[
473 Op::Telemetry(TelemetryOp::GetOverview),
474 Op::Telemetry(TelemetryOp::ListRequests),
475 Op::Telemetry(TelemetryOp::GetRequest),
476 Op::Telemetry(TelemetryOp::ListLogs),
477 Op::Telemetry(TelemetryOp::ListTraces),
478 Op::Telemetry(TelemetryOp::GetTrace),
479 Op::Telemetry(TelemetryOp::ListErrors),
480 Op::Telemetry(TelemetryOp::UpdateError),
481 Op::Telemetry(TelemetryOp::ListMetrics),
482 Op::Telemetry(TelemetryOp::GetMetric),
483 Op::Telemetry(TelemetryOp::GetSettings),
484 Op::Telemetry(TelemetryOp::UpdateSettings),
485 Op::Telemetry(TelemetryOp::ListTokens),
486 Op::Telemetry(TelemetryOp::CreateToken),
487 Op::Telemetry(TelemetryOp::DeleteToken),
488 Op::Telemetry(TelemetryOp::ListExports),
489 Op::Telemetry(TelemetryOp::CreateExport),
490 Op::Telemetry(TelemetryOp::UpdateExport),
491 Op::Telemetry(TelemetryOp::DeleteExport),
492 Op::Telemetry(TelemetryOp::GetUsage),
493 ],
494 ),
495 (
Merge branch 'worktree-agent-a3abfcce648e87dca'496 "Run protection",
497 "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.",
498 &[
499 Op::Protection(ProtectionOp::UpdateEnvironment),
500 Op::Protection(ProtectionOp::DeleteEnvironment),
501 Op::Protection(ProtectionOp::GetPendingDeployments),
502 Op::Protection(ProtectionOp::ReviewPendingDeployments),
503 Op::Protection(ProtectionOp::ApproveWorkflowRun),
504 Op::Protection(ProtectionOp::GetWorkflowPermissions),
505 Op::Protection(ProtectionOp::SetWorkflowPermissions),
506 Op::Protection(ProtectionOp::GetForkPrApproval),
507 Op::Protection(ProtectionOp::SetForkPrApproval),
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts508 Op::Protection(ProtectionOp::GetActionsAccess),
509 Op::Protection(ProtectionOp::SetActionsAccess),
Merge branch 'worktree-agent-a3abfcce648e87dca'510 Op::Protection(ProtectionOp::CreateRepositoryDispatch),
511 Op::Protection(ProtectionOp::GetWorkspaceWorkflowPermissions),
512 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.513 Op::Protection(ProtectionOp::ListWorkspaceManagedWorkflows),
514 Op::Protection(ProtectionOp::CreateWorkspaceManagedWorkflow),
515 Op::Protection(ProtectionOp::UpdateWorkspaceManagedWorkflow),
516 Op::Protection(ProtectionOp::DeleteWorkspaceManagedWorkflow),
Merge branch 'worktree-agent-a3abfcce648e87dca'517 ],
518 ),
519 (
A project is an app or a library: libraries show their package and how to ship a release, not production520 "Secrets and variables",
521 "Values that workflows and deployments read, per repository or for a whole workspace, with a row per environment.",
522 &[
523 Op::ListActionsSecrets,
524 Op::SetActionsSecret,
525 Op::DeleteActionsSecret,
526 Op::ListActionsVariables,
527 Op::SetActionsVariable,
528 Op::DeleteActionsVariable,
529 ],
530 ),
531 (
532 "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.533 "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.",
A project is an app or a library: libraries show their package and how to ship a release, not production534 &[
535 Op::ListRunners,
536 Op::CreateRunnerRegistrationToken,
537 Op::RemoveRunner,
538 Op::ListRunnerGroups,
539 Op::CreateRunnerGroup,
540 Op::UpdateRunnerGroup,
541 Op::DeleteRunnerGroup,
542 Op::GetRunnerSettings,
543 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.544 ],
545 ),
546 (
A project is an app or a library: libraries show their package and how to ship a release, not production547 "Webhooks",
548 "Signed HTTPS requests sent to your own address as things happen, for a repository or a whole workspace.",
549 &[
550 Op::ListWebhooks,
551 Op::CreateWebhook,
552 Op::UpdateWebhook,
553 Op::DeleteWebhook,
554 Op::PingWebhook,
555 Op::ListWebhookDeliveries,
556 Op::RedeliverWebhook,
557 ],
558 ),
559 (
560 "Integrations",
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.561 "A workspace's connections to outside systems: alert sources and issue trackers.",
A project is an app or a library: libraries show their package and how to ship a release, not production562 &[
563 Op::ListIntegrations,
564 Op::ConnectIntegration,
AI Gateway: OpenAI's format, open models, and your own providers565 Op::UpdateIntegration,
A project is an app or a library: libraries show their package and how to ship a release, not production566 Op::DisconnectIntegration,
567 Op::TestIntegration,
568 Op::GetContext,
569 Op::ImportIssue,
Merge remote-tracking branch 'origin/claude/cool-newton-7nm8r9' into claude/cool-newton-7nm8r9570 ],
571 ),
572 (
Merge main into Artifacts Phase 2573 "Artifacts",
574 "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.",
575 &[
576 Op::Folios(FoliosOp::List),
577 Op::Folios(FoliosOp::Search),
578 Op::Folios(FoliosOp::Get),
579 Op::Folios(FoliosOp::GetContent),
580 Op::Folios(FoliosOp::ListVersions),
581 Op::Folios(FoliosOp::GetAccess),
582 Op::Folios(FoliosOp::ListTemplates),
583 Op::Folios(FoliosOp::ListSpaces),
584 Op::Folios(FoliosOp::QueryDataset),
585 Op::Folios(FoliosOp::Create),
586 Op::Folios(FoliosOp::Update),
587 Op::Folios(FoliosOp::Edit),
588 Op::Folios(FoliosOp::Trash),
589 Op::Folios(FoliosOp::Restore),
590 Op::Folios(FoliosOp::RestoreVersion),
591 Op::Folios(FoliosOp::SetAccess),
592 Op::Folios(FoliosOp::Purge),
593 ],
594 ),
A project is an app or a library: libraries show their package and how to ship a release, not production595];
596
597/// The section of the API reference an operation is listed under.
598fn tag(op: Op) -> &'static str {
599 SECTIONS
600 .iter()
601 .find(|(_, _, ops)| ops.contains(&op))
602 .map_or("Repositories", |(name, _, _)| name)
603}
604
605/// What an operation's page is called, as a short sentence.
606fn title(op: Op) -> &'static str {
607 match op {
608 Op::Whoami => "Get the current user",
Merge branch 'worktree-agent-ad7c6d88d93adc817'609 Op::GetWorkspace => "Get a workspace",
A project is an app or a library: libraries show their package and how to ship a release, not production610 Op::CreateWorkspace => "Create a workspace",
611 Op::DeleteWorkspace => "Delete a workspace",
612 Op::UpdateWorkspace => "Update a workspace",
Merge main (membership, two-factor, GitHub repo roles) into tokens613 Op::ListMembers => "List a workspace's members",
614 Op::UpdateMember => "Change a member's role",
615 Op::RemoveMember => "Remove a member",
616 Op::TransferOwnership => "Transfer a workspace's ownership",
617 Op::LeaveWorkspace => "Leave a workspace",
A project is an app or a library: libraries show their package and how to ship a release, not production618 Op::ListEmails => "List your email addresses",
619 Op::AddEmail => "Add an email address",
Merge email confirmation gate: a code and a link, nothing until confirmed (identity 0036)620 Op::ConfirmEmail => "Confirm an email address",
A project is an app or a library: libraries show their package and how to ship a release, not production621 Op::RemoveEmail => "Remove an email address",
622 Op::UpdateEmailSettings => "Change your email settings",
623 Op::ListInvites => "List your invites",
624 Op::CreateInvite => "Create an invite",
625 Op::RevokeInvite => "Revoke an invite",
626 Op::ListWorkspaceInvites => "List a workspace's invites",
627 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)628 Op::ListInvitations => "List your workspace invitations",
629 Op::AcceptInvitation => "Accept a workspace invitation",
630 Op::DeclineInvitation => "Decline a workspace invitation",
A project is an app or a library: libraries show their package and how to ship a release, not production631 Op::RevokeWorkspaceInvite => "Revoke a workspace's invite",
632 Op::TransferRepo => "Transfer a repository",
633 Op::RenameRepo => "Rename a repository",
634 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.635 Op::CreateBranch => "Create a branch",
636 Op::DeleteBranch => "Delete a branch",
A project is an app or a library: libraries show their package and how to ship a release, not production637 Op::ArchiveRepo => "Archive a repository",
638 Op::UnarchiveRepo => "Unarchive a repository",
639 Op::SetRepoVisibility => "Change a repository's visibility",
640 Op::DeleteRepo => "Delete a repository",
641 Op::ListDeletedRepos => "List recently deleted repositories",
642 Op::RestoreRepo => "Restore a deleted repository",
643 Op::PurgeRepo => "Purge a deleted repository",
644 Op::ListRepos => "List repositories",
645 Op::GetRepo => "Get a repository",
646 Op::CreateRepo => "Create a repository",
647 Op::UpdateRepo => "Update a repository",
648 Op::GetRepoSettings => "Get repository settings",
649 Op::UpdateRepoSettings => "Update repository settings",
650 Op::ListCheckNames => "List check names",
651 Op::GetMergeQueue => "Get the merge queue",
652 Op::Remember => "Remember something",
653 Op::Recall => "Recall memory",
654 Op::Search => "Search g1t",
655 Op::ListIssues => "List issues",
656 Op::GetIssue => "Get an issue",
657 Op::CreateIssue => "Create an issue",
658 Op::UpdateIssue => "Update an issue",
659 Op::CloseIssue => "Close an issue",
660 Op::ReopenIssue => "Reopen an issue",
661 Op::ListLabels => "List labels",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar662 Op::CreateLabel => "Create a label",
663 Op::UpdateLabel => "Update a label",
664 Op::DeleteLabel => "Delete a label",
665 Op::AddDefaultLabels => "Add the default labels",
666 Op::ListIssueLabels => "List an issue's labels",
667 Op::AddIssueLabels => "Add labels to an issue",
668 Op::SetIssueLabels => "Set an issue's labels",
669 Op::RemoveIssueLabels => "Remove labels from an issue",
670 Op::ListMilestones => "List milestones",
671 Op::GetMilestone => "Get a milestone",
672 Op::CreateMilestone => "Create a milestone",
673 Op::UpdateMilestone => "Update a milestone",
674 Op::DeleteMilestone => "Delete a milestone",
675 Op::UpdatePullRequest => "Update a pull request",
A project is an app or a library: libraries show their package and how to ship a release, not production676 Op::AddComment => "Add a comment",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts677 Op::EditComment => "Edit a comment",
678 Op::DeleteComment => "Delete a comment",
A project is an app or a library: libraries show their package and how to ship a release, not production679 Op::ReviewPullRequest => "Review a pull request",
680 Op::ListPullRequests => "List pull requests",
681 Op::GetPullRequest => "Get a pull request",
682 Op::CreatePullRequest => "Create a pull request",
683 Op::RecordSession => "Record session entries",
684 Op::ReadSession => "Read a session",
685 Op::MarkPullRequestReady => "Mark a pull request ready",
686 Op::ClosePullRequest => "Close a pull request",
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts687 Op::ReopenPullRequest => "Reopen a pull request",
688 Op::ConvertPullRequestToDraft => "Convert a pull request to a draft",
A project is an app or a library: libraries show their package and how to ship a release, not production689 Op::GetPullRequestChanges => "Get a pull request's changes",
690 Op::MergePullRequest => "Merge a pull request",
691 Op::ListEvents => "List repository events",
692 Op::ListIntegrations => "List integrations",
693 Op::ConnectIntegration => "Connect an integration",
AI Gateway: OpenAI's format, open models, and your own providers694 Op::UpdateIntegration => "Update an integration",
A project is an app or a library: libraries show their package and how to ship a release, not production695 Op::DisconnectIntegration => "Disconnect an integration",
696 Op::TestIntegration => "Test an integration",
697 Op::GetContext => "Look up a ticket",
698 Op::ImportIssue => "Import an issue",
699 Op::ListWebhooks => "List webhooks",
700 Op::CreateWebhook => "Create a webhook",
701 Op::UpdateWebhook => "Update a webhook",
702 Op::DeleteWebhook => "Delete a webhook",
703 Op::PingWebhook => "Ping a webhook",
704 Op::ListWebhookDeliveries => "List webhook deliveries",
705 Op::RedeliverWebhook => "Redeliver a webhook delivery",
706 Op::ListWorkflows => "List workflows",
707 Op::ListWorkflowRuns => "List workflow runs",
708 Op::GetWorkflowRun => "Get a workflow run",
709 Op::GetJobLogs => "Get a job's log",
710 Op::DispatchWorkflow => "Run a workflow",
711 Op::CancelWorkflowRun => "Cancel a workflow run",
712 Op::RerunWorkflowRun => "Re-run a workflow run",
713 Op::UpdateWorkflow => "Turn a workflow on or off",
714 Op::ListActionsSecrets => "List secrets",
715 Op::SetActionsSecret => "Set a secret",
716 Op::DeleteActionsSecret => "Delete a secret",
717 Op::ListActionsVariables => "List variables",
718 Op::SetActionsVariable => "Set a variable",
719 Op::DeleteActionsVariable => "Delete a variable",
720 Op::ListRunners => "List self-hosted runners",
721 Op::ListRunnerGroups => "List runner groups",
722 Op::GetRunnerSettings => "Get runner settings",
723 Op::CreateRunnerRegistrationToken => "Create a runner registration token",
724 Op::RemoveRunner => "Remove a self-hosted runner",
725 Op::CreateRunnerGroup => "Create a runner group",
726 Op::UpdateRunnerGroup => "Change a runner group",
727 Op::DeleteRunnerGroup => "Delete a runner group",
728 Op::UpdateRunnerSettings => "Change runner settings",
729 Op::ListCollaborators => "List who has access",
730 Op::AddCollaborator => "Add a collaborator",
731 Op::UpdateCollaborator => "Change a collaborator's role",
732 Op::RemoveCollaborator => "Remove a collaborator",
733 Op::GetCollaboratorPermission => "Get someone's permission",
734 Op::ListRepoInvitations => "List a repository's invitations",
735 Op::RevokeRepoInvitation => "Revoke a repository invitation",
736 Op::ListMyRepoInvitations => "List your repository invitations",
737 Op::AcceptRepoInvitation => "Accept a repository invitation",
738 Op::DeclineRepoInvitation => "Decline a repository invitation",
739 Op::SetBasePermission => "Set the base permission",
740 Op::ListOutsideCollaborators => "List outside collaborators",
741 Op::ListSecurityAlerts => "List security alerts",
742 Op::DismissSecurityAlert => "Dismiss a security alert",
743 Op::ReopenSecurityAlert => "Reopen a security alert",
API: notifications over REST and MCP, with notifications scopes744 Op::ListNotifications => "List notifications",
745 Op::MarkNotificationsRead => "Mark notifications read",
746 Op::GetNotificationThread => "Get a thread",
747 Op::MarkThreadRead => "Mark a thread read",
748 Op::MarkThreadDone => "Mark a thread done",
749 Op::SaveThread => "Save a thread",
750 Op::SnoozeThread => "Snooze a thread",
751 Op::GetThreadSubscription => "Get a thread subscription",
752 Op::SetThreadSubscription => "Set a thread subscription",
753 Op::DeleteThreadSubscription => "Unsubscribe from a thread",
754 Op::GetRepoSubscription => "Get how you watch a repository",
755 Op::SetRepoSubscription => "Watch a repository",
756 Op::DeleteRepoSubscription => "Stop watching a repository",
757 Op::ListWatchedRepos => "List repositories you watch",
API: pinned projects over REST and MCP758 Op::ListPinnedProjects => "List your pinned projects",
Usage, Billing settings and prepaid AI credit; fixes from the UX audit759 Op::GetUsage => "Get a workspace's usage",
760 Op::GetBudget => "Get a workspace's budget",
761 Op::SetBudget => "Change a workspace's budget",
762 Op::GetAiCredit => "Get a workspace's AI credit",
763 Op::BuyAiCredit => "Buy AI credit",
764 Op::ListInvoices => "List a workspace's invoices",
765 Op::GetBillingDetails => "Get a workspace's billing details",
API: pinned projects over REST and MCP766 Op::PinProject => "Pin a project",
767 Op::UnpinProject => "Unpin a project",
768 Op::ReorderPinnedProjects => "Reorder your pinned projects",
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97769 Op::ListProjects => "List a workspace's projects",
770 Op::GetProject => "Get a project",
771 Op::UpdateProject => "Update a project",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar772 Op::ListTeams => "List teams",
773 Op::GetTeam => "Get a team",
774 Op::CreateTeam => "Create a team",
775 Op::UpdateTeam => "Update a team",
776 Op::DeleteTeam => "Delete a team",
777 Op::ListTeamMembers => "List a team's members",
778 Op::SetTeamMember => "Add or change a team member",
779 Op::RemoveTeamMember => "Remove a team member",
780 Op::ListChildTeams => "List child teams",
781 Op::ListTeamRepos => "List a team's repositories",
782 Op::SetTeamRepo => "Give a team a role on a repository",
783 Op::RemoveTeamRepo => "Remove a team from a repository",
784 Op::SetTeamReviewAssignment => "Set a team's review assignment",
785 Op::ListUserTeams => "List someone's teams",
786 Op::RequestReviewers => "Request reviewers",
787 Op::RemoveRequestedReviewers => "Remove requested reviewers",
788 Op::GetCodeownersErrors => "List CODEOWNERS errors",
789 Op::Security(op) => op.title(),
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge790 Op::Rules(op) => op.title(),
Merge checks: statuses and check runs on every commit791 Op::Checks(op) => op.title(),
Merge branch 'main' into worktree-agent-a69aeabc4b0deeb97792 Op::About(op) => op.title(),
793 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.794 Op::Telemetry(op) => op.title(),
Merge branch 'worktree-agent-a3abfcce648e87dca'795 Op::Protection(op) => op.title(),
API and MCP for a workspace's personal access token rules, members' tokens and approvals796 Op::Tokens(op) => op.title(),
Actions: OIDC tokens, the toolkit's cache and artifact services, and artifacts in R2797 Op::Artifacts(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.798 Op::Archives(op) => op.title(),
Merge branch 'worktree-agent-a5a5de74d8863d554' into worktree-agent-a16631325aecf58ca799 Op::DeployKeys(op) => op.title(),
Merge branch 'mirroring' into artifacts-mode800 Op::Mirrors(op) => op.title(),
Merge packages: roles, Actions access, source label, soft delete, API801 Op::Packages(op) => op.title(),
Merge main into Artifacts Phase 2802 Op::Folios(op) => op.title(),
A project is an app or a library: libraries show their package and how to ship a release, not production803 }
804}
805
806/// 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.807/// can: the ones that make a repository private in a workspace, when a
808/// free workspace's private storage has no room for it.
A project is an app or a library: libraries show their package and how to ship a release, not production809fn may_need_payment(op: Op) -> Option<&'static str> {
810 match op {
811 Op::UpdateRepo | Op::SetRepoVisibility | Op::TransferRepo => Some(
812 "A free workspace's private storage has no room for this private repository.",
813 ),
814 _ => None,
815 }
816}
817
818/// What the reference says beyond each operation's own description, keyed
819/// by operation id, written by hand from what the services return: `notes`
820/// (Markdown, added to the description) and example `params` (path),
821/// `query`, `request` (body) and `response`.
822const REFERENCE: &str = include_str!("reference.json");
823
824fn examples() -> Map<String, Value> {
825 match serde_json::from_str(REFERENCE) {
826 Ok(Value::Object(examples)) => examples,
827 _ => Map::new(),
828 }
829}
830
831/// `/repos/:owner/:name` as OpenAPI writes it: `/repos/{owner}/{name}`.
832fn openapi_path(route: &Route) -> String {
833 route
834 .path
835 .split('/')
836 .map(|segment| match segment.strip_prefix(':') {
837 Some(name) => format!("{{{name}}}"),
838 None => segment.to_owned(),
839 })
840 .collect::<Vec<_>>()
841 .join("/")
842}
843
844fn error_response(description: &str) -> Value {
845 json!({
846 "description": description,
847 "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } },
848 })
849}
850
851/// A parameter in the path or the query, described by the operation's
852/// input schema where it has the same name.
853fn parameter(name: &str, place: &str, required: bool, schema: Option<&Value>) -> Value {
854 let mut schema = schema.cloned().unwrap_or_else(|| json!({ "type": "string" }));
855 let description = match name {
856 "owner" => Some(Value::from("The workspace that owns the repository.")),
857 "name" => Some(Value::from("The repository's name.")),
858 _ => schema.as_object_mut().and_then(|schema| schema.remove("description")),
859 };
860 let mut parameter = json!({
861 "name": name,
862 "in": place,
863 "required": required,
864 "schema": schema,
865 });
866 if let Some(description) = description {
867 parameter["description"] = description;
868 }
869 parameter
870}
871
872/// The operation id of a route. An operation reached at a workspace's
873/// address as well as a repository's is documented once for each, with its
874/// own id; GitHub's alternative addresses for one operation keep GitHub's
875/// names.
876fn operation_id(route: &Route) -> String {
877 let op = route.op;
878 let base = match (route.method, route.path.rsplit('/').next().unwrap_or_default()) {
879 ("PUT", "enable") => "enable_workflow".to_owned(),
880 ("PUT", "disable") => "disable_workflow".to_owned(),
881 ("POST", "rerun-failed-jobs") => "rerun_failed_jobs".to_owned(),
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)882 ("POST", "rerun") if route.path.contains("/jobs/:job/") => "rerun_job".to_owned(),
883 ("POST", "force-cancel") => "force_cancel_workflow_run".to_owned(),
884 ("GET", ":attempt") => "get_workflow_run_attempt".to_owned(),
A project is an app or a library: libraries show their package and how to ship a release, not production885 ("PATCH", ":setting") => "update_actions_variable".to_owned(),
886 ("GET", "runs") if route.path.contains("/workflows/:workflow/") => "list_runs_of_workflow".to_owned(),
API: notifications over REST and MCP, with notifications scopes887 // One repository's notifications, and an issue's subscription by
888 // its number rather than a thread's id.
889 (_, "notifications") if route.path.starts_with("/repos/") => match op {
890 Op::ListNotifications => "list_repo_notifications".to_owned(),
891 _ => "mark_repo_notifications_read".to_owned(),
892 },
893 (method, "subscription") if route.path.contains("/issues/:number/") => match method {
894 "GET" => "get_issue_subscription".to_owned(),
895 "PUT" => "set_issue_subscription".to_owned(),
896 _ => "delete_issue_subscription".to_owned(),
897 },
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar898 // One label off an issue, by its name in the path.
899 ("DELETE", ":label") if route.path.contains("/issues/:number/") => "remove_issue_label".to_owned(),
API: notifications over REST and MCP, with notifications scopes900 ("DELETE", "saved") => "unsave_thread".to_owned(),
901 ("DELETE", "snooze") => "unsnooze_thread".to_owned(),
A project is an app or a library: libraries show their package and how to ship a release, not production902 _ => op.name().to_owned(),
903 };
904 if route.path.starts_with("/workspaces/") && ROUTES.iter().any(|other| other.op == op && other.path.starts_with("/repos/")) {
905 format!("{base}_for_workspace")
906 } else {
907 base
908 }
909}
910
911/// The summary of a route: its operation's title, or for one of GitHub's
912/// alternative addresses, what that address does.
913fn summary(route: &Route, id: &str) -> String {
914 let base = match id.trim_end_matches("_for_workspace") {
915 "enable_workflow" => "Turn a workflow on",
916 "disable_workflow" => "Turn a workflow off",
917 "rerun_failed_jobs" => "Re-run failed jobs",
Merge Actions runs: summaries, attempts and re-runs, graceful cancel, log downloads, badges (actions 0009)918 "rerun_job" => "Re-run a job",
919 "force_cancel_workflow_run" => "Force-cancel a workflow run",
920 "get_workflow_run_attempt" => "Get a workflow run attempt",
A project is an app or a library: libraries show their package and how to ship a release, not production921 "update_actions_variable" => "Update a variable",
922 "list_runs_of_workflow" => "List a workflow's runs",
API: notifications over REST and MCP, with notifications scopes923 "list_repo_notifications" => "List a repository's notifications",
924 "mark_repo_notifications_read" => "Mark a repository's notifications read",
925 "get_issue_subscription" => "Get your subscription to an issue",
926 "set_issue_subscription" => "Subscribe to an issue",
927 "delete_issue_subscription" => "Unsubscribe from an issue",
928 "unsave_thread" => "Unsave a thread",
929 "unsnooze_thread" => "Bring a snoozed thread back",
A project is an app or a library: libraries show their package and how to ship a release, not production930 _ => title(route.op),
931 };
932 if id.ends_with("_for_workspace") {
933 format!("{base} for a workspace")
934 } else {
935 base.to_owned()
936 }
937}
938
939fn operation(route: &Route) -> Value {
940 let op = route.op;
941 let path_params: Vec<&str> = route.params().collect();
Merge checks: statuses and check runs on every commit942 // `owner` and `name` in the path stand for the operation's `repo` input,
943 // so a `name` in the body, such as a check run's, is the body's own.
944 let stands_for_repo =
945 |name: &str| matches!(name, "owner" | "name") && path_params.contains(&"owner") && path_params.contains(&"name");
946 let covered = |name: &str| name == "repo" || (path_params.contains(&name) && !stands_for_repo(name));
A project is an app or a library: libraries show their package and how to ship a release, not production947 let all_properties = op.properties();
948 let mut properties = all_properties.clone();
949 properties.retain(|name, _| !covered(name));
950 let required: Vec<String> = op
951 .required()
952 .into_iter()
953 .filter(|name| !covered(name))
954 .collect();
955
956 let mut parameters: Vec<Value> = path_params
957 .iter()
Merge checks: statuses and check runs on every commit958 .map(|name| parameter(name, "path", true, if stands_for_repo(name) { None } else { all_properties.get(*name) }))
A project is an app or a library: libraries show their package and how to ship a release, not production959 .collect();
960 let mut body = Value::Null;
961 if route.method == "GET" {
962 for (name, key) in route.query {
963 parameters.push(parameter(
964 name,
965 "query",
966 required.iter().any(|required| required == key),
967 properties.get(*key),
968 ));
969 }
970 } else if !properties.is_empty() {
971 let mut schema = json!({ "type": "object", "properties": properties });
972 if !required.is_empty() {
973 schema["required"] = json!(required);
974 }
975 body = json!({
976 "required": !required.is_empty(),
977 "content": { "application/json": { "schema": schema } },
978 });
979 }
980
981 let id = operation_id(route);
982 let mut responses = Map::new();
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts983 if route.no_content() {
984 responses.insert("204".into(), json!({ "description": "Success. There is no body." }));
985 } else {
986 responses.insert(
987 "200".into(),
988 json!({
989 "description": "Success.",
990 "content": { "application/json": { "schema": {} } },
991 }),
992 );
993 }
A project is an app or a library: libraries show their package and how to ship a release, not production994 responses.insert(
995 "401".into(),
996 error_response("A token is required, or the one sent is not valid."),
997 );
998 if let Some(reason) = may_need_payment(op) {
999 responses.insert("402".into(), error_response(reason));
1000 }
1001 responses.insert(
1002 "403".into(),
1003 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."),
1004 );
1005 if !matches!(op, Op::Whoami | Op::ListRepos | Op::Search) {
1006 responses.insert("404".into(), error_response("It does not exist, or you cannot see it."));
1007 }
1008 if route.method != "GET" {
1009 responses.insert(
1010 "409".into(),
1011 error_response("The request conflicts with the current state."),
1012 );
1013 }
1014 if op != Op::Whoami {
1015 responses.insert("422".into(), error_response("The input is not valid."));
1016 }
1017 // Public data can be read without a token; everything else needs one.
1018 let scope: Vec<&str> = scope_for(op.name()).map(|scope| scope.as_str()).into_iter().collect();
1019 let security = if op.needs_user() {
1020 json!([{ "token": scope }])
1021 } else {
1022 json!([{ "token": scope }, {}])
1023 };
1024 let (tool, action) = crate::tools::TOOLS
1025 .iter()
1026 .find_map(|tool| {
1027 tool.actions
1028 .iter()
1029 .find(|action| action.op == op)
1030 .map(|action| (tool.name, action.name))
1031 })
1032 .unwrap_or_default();
1033 let mut described = json!({
1034 "operationId": id,
1035 "tags": [tag(op)],
1036 "summary": summary(route, &id),
1037 "description": op.description(),
1038 "x-operation": op.name(),
1039 "x-mcp-tool": tool,
1040 "x-mcp-action": action,
1041 "x-scope": scope.first().copied(),
1042 "security": security,
1043 "parameters": parameters,
1044 "responses": responses,
1045 });
1046 if !body.is_null() {
1047 described["requestBody"] = body;
1048 }
1049 described
1050}
1051
1052/// Entries for device sign-in, which is not an operation.
1053fn onboarding() -> Map<String, Value> {
1054 let paths = json!({
1055 "/device/code": {
1056 "post": {
1057 "operationId": "device_code",
1058 "tags": ["Accounts"],
1059 "summary": "Start signing in",
1060 "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`.",
1061 "security": [],
1062 "requestBody": {
1063 "content": { "application/json": { "schema": {
1064 "type": "object",
1065 "properties": {
1066 "client_name": {
1067 "type": "string",
1068 "description": "What is asking, shown to the person approving. For example, Claude Code.",
1069 },
1070 },
1071 } } },
1072 },
1073 "responses": { "200": {
1074 "description": "The codes for this sign-in.",
1075 "content": { "application/json": { "schema": {
1076 "type": "object",
1077 "properties": {
1078 "device_code": { "type": "string", "description": "Secret. Send it to /device/token." },
1079 "user_code": { "type": "string", "description": "Shown to the person, like WDJB-MJHT." },
1080 "verification_uri": { "type": "string" },
1081 "verification_uri_complete": {
1082 "type": "string",
1083 "description": "The link to give the person; it carries the code.",
1084 },
1085 "expires_in": { "type": "integer", "description": "Seconds until the codes expire." },
1086 "interval": { "type": "integer", "description": "Seconds to wait between polls." },
1087 },
1088 } } },
1089 } },
1090 },
1091 },
1092 "/device/token": {
1093 "post": {
1094 "operationId": "device_token",
1095 "tags": ["Accounts"],
1096 "summary": "Finish signing in",
1097 "description": "Asks whether the person has approved. Poll no faster than the interval. The token is returned once.",
1098 "security": [],
1099 "requestBody": {
1100 "required": true,
1101 "content": { "application/json": { "schema": {
1102 "type": "object",
1103 "required": ["device_code"],
1104 "properties": { "device_code": { "type": "string" } },
1105 } } },
1106 },
1107 "responses": { "200": {
1108 "description": "The state of the sign-in.",
1109 "content": { "application/json": { "schema": {
1110 "type": "object",
1111 "required": ["status"],
1112 "properties": {
1113 "status": { "type": "string", "enum": ["pending", "approved", "denied", "expired"] },
1114 "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 calendar1115 "username": { "type": "string", "description": "Lowercased: what the account is found and linked by." },
1116 "display_username": { "type": "string", "description": "The username as its owner wrote it; the same as username when they chose no case." },
A project is an app or a library: libraries show their package and how to ship a release, not production1117 "verified": {
1118 "type": "boolean",
1119 "description": "Whether the account's email is confirmed.",
1120 },
1121 },
1122 } } },
1123 } },
1124 },
1125 },
1126 });
1127 match paths {
1128 Value::Object(paths) => paths,
1129 _ => Map::new(),
1130 }
1131}
1132
1133
1134/// Puts each operation's examples, where it has them, into its request
1135/// and response. Path and query values go under `x-example-params` and
1136/// `x-example-query`, which tools that build a request can use.
1137fn attach_examples(paths: &mut Map<String, Value>) {
1138 let examples = examples();
1139 for methods in paths.values_mut() {
1140 let Some(methods) = methods.as_object_mut() else { continue };
1141 for operation in methods.values_mut() {
1142 let id = operation["operationId"].as_str().unwrap_or_default().to_owned();
1143 let name = operation["x-operation"].as_str().unwrap_or_default().to_owned();
1144 let Some(example) = examples.get(&id).or_else(|| examples.get(&name)) else {
1145 continue;
1146 };
1147 if let Some(notes) = example.get("notes").and_then(Value::as_str) {
1148 let description = operation["description"].as_str().unwrap_or_default();
1149 operation["description"] = json!(format!("{description}\n\n{notes}"));
1150 }
1151 if let Some(response) = example.get("response") {
1152 let content = &mut operation["responses"]["200"]["content"]["application/json"];
1153 if content.is_object() {
1154 content["example"] = response.clone();
1155 }
1156 }
1157 if let Some(request) = example.get("request") {
1158 let content = &mut operation["requestBody"]["content"]["application/json"];
1159 if content.is_object() {
1160 content["example"] = request.clone();
1161 }
1162 }
1163 for (key, extension) in [("params", "x-example-params"), ("query", "x-example-query")] {
1164 if let Some(values) = example.get(key) {
1165 operation[extension] = values.clone();
1166 }
1167 }
1168 }
1169 }
1170}
1171
1172pub fn document() -> Value {
1173 let mut paths = onboarding();
1174 for route in ROUTES {
1175 let entry = paths
1176 .entry(openapi_path(route))
1177 .or_insert_with(|| json!({}));
1178 entry[route.method.to_lowercase()] = operation(route);
1179 }
1180 attach_examples(&mut paths);
1181 let tags: Vec<Value> = SECTIONS
1182 .iter()
1183 .map(|(name, description, ops)| {
1184 json!({
1185 "name": name,
1186 "description": description,
1187 // The section's operations in reading order, by MCP tool name.
1188 "x-tools": ops.iter().map(|op| op.name()).collect::<Vec<_>>(),
1189 })
1190 })
1191 .collect();
1192 let codes = ["unauthenticated", "payment_required", "forbidden", "not_found", "conflict", "invalid"];
1193 json!({
1194 "openapi": "3.1.0",
1195 "info": {
1196 "title": "g1t API",
1197 "version": "1",
1198 "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.",
1199 "license": { "name": "MIT", "identifier": "MIT" },
1200 },
1201 "servers": [{ "url": "https://api.g1t.sh" }],
1202 "security": [{ "token": [] }, {}],
1203 "tags": tags,
1204 "paths": paths,
1205 "components": {
1206 "securitySchemes": {
1207 "token": {
1208 "type": "http",
1209 "scheme": "bearer",
1210 "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.",
1211 },
1212 },
1213 "schemas": {
1214 "Error": {
1215 "type": "object",
1216 "required": ["error"],
1217 "properties": {
1218 "error": {
1219 "type": "object",
1220 "required": ["code", "message"],
1221 "properties": {
1222 "code": { "type": "string", "enum": codes },
1223 "message": { "type": "string" },
1224 "needed_scope": {
1225 "type": "string",
1226 "description": "On a 403 for an access token without the scope the call needs: that scope, such as `issues:write`.",
1227 },
1228 },
1229 },
1230 },
1231 },
1232 },
1233 },
1234 })
1235}
1236
1237#[cfg(test)]
1238mod tests {
1239 use super::*;
1240
1241 #[test]
1242 fn every_route_is_documented_once() {
1243 let document = document();
1244 let mut ids = Vec::new();
1245 for (_, methods) in document["paths"].as_object().unwrap() {
1246 for (_, operation) in methods.as_object().unwrap() {
1247 ids.push(operation["operationId"].as_str().unwrap().to_owned());
1248 }
1249 }
1250 for op in Op::ALL {
1251 assert_eq!(
1252 ids.iter().filter(|id| *id == op.name()).count(),
1253 1,
1254 "{}",
1255 op.name()
1256 );
1257 }
1258 let mut unique = ids.clone();
1259 unique.sort();
1260 unique.dedup();
1261 assert_eq!(unique.len(), ids.len(), "operation ids repeat");
1262 }
1263
1264 #[test]
1265 fn path_and_query_inputs_are_not_repeated_in_the_body() {
1266 let document = document();
1267 let merge = &document["paths"]["/repos/{owner}/{name}/pulls/{number}/merge"]["post"];
1268 let body = &merge["requestBody"]["content"]["application/json"]["schema"]["properties"];
1269 assert!(body.get("keep_issue_open").is_some());
1270 assert!(body.get("repo").is_none() && body.get("number").is_none());
1271 let list = &document["paths"]["/repos"]["get"];
1272 assert_eq!(list["parameters"][0]["name"], "q");
1273 assert!(list.get("requestBody").is_none());
1274 }
1275
1276 #[test]
1277 fn every_operation_is_in_one_section() {
1278 for op in Op::ALL {
1279 let sections = SECTIONS
1280 .iter()
1281 .filter(|(_, _, ops)| ops.contains(&op))
1282 .count();
1283 assert_eq!(sections, 1, "{}", op.name());
1284 }
1285 }
1286
1287 #[test]
1288 fn titles_read_as_sentences() {
1289 assert_eq!(title(Op::CreateIssue), "Create an issue");
1290 assert_eq!(title(Op::Whoami), "Get the current user");
1291 }
1292
1293 #[test]
1294 fn every_operation_has_an_example_response() {
1295 let examples = examples();
1296 assert!(!examples.is_empty(), "reference.json does not parse");
1297 let document = document();
1298 let mut known = Vec::new();
1299 for (path, methods) in document["paths"].as_object().unwrap() {
1300 for (method, operation) in methods.as_object().unwrap() {
1301 known.push(operation["operationId"].as_str().unwrap().to_owned());
Merge Actions: cross-repo workflows and actions, release and deployment triggers, step timeouts1302 // Nothing to show for a success without a body.
1303 if operation["responses"]["204"].is_object() {
1304 continue;
1305 }
A project is an app or a library: libraries show their package and how to ship a release, not production1306 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1307 assert!(!example.is_null(), "{method} {path} has no example response");
1308 }
1309 }
1310 for id in examples.keys() {
1311 assert!(known.contains(id), "reference.json names {id}, which is not an operation");
1312 }
1313 }
1314
1315 #[test]
1316 fn example_requests_send_only_what_the_body_takes() {
1317 let document = document();
1318 for (path, methods) in document["paths"].as_object().unwrap() {
1319 for (method, operation) in methods.as_object().unwrap() {
1320 let content = &operation["requestBody"]["content"]["application/json"];
1321 let Some(example) = content["example"].as_object() else { continue };
1322 let properties = &content["schema"]["properties"];
1323 for key in example.keys() {
1324 assert!(!properties[key].is_null(), "{method} {path}: {key} is not in the body");
1325 }
1326 }
1327 }
1328 }
1329
1330 /// The docs site's copy of the document. Run with `G1T_WRITE_OPENAPI=1`
1331 /// to rewrite it after changing an operation.
1332 #[test]
1333 fn the_docs_copy_is_current() {
1334 let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../docs/src/data/openapi.json");
1335 let current = serde_json::to_string_pretty(&document()).unwrap() + "\n";
1336 if std::env::var_os("G1T_WRITE_OPENAPI").is_some() {
1337 std::fs::write(path, &current).unwrap();
1338 return;
1339 }
1340 let copy = std::fs::read_to_string(path).unwrap_or_default().replace("\r\n", "\n");
1341 assert!(
1342 copy == current,
1343 "apps/docs/src/data/openapi.json is out of date: run G1T_WRITE_OPENAPI=1 cargo test -p g1t-api openapi"
1344 );
1345 }
1346
1347 /// The reference shows responses as they are sent: `snake_case`.
1348 #[test]
1349 fn example_responses_are_snake_case() {
1350 let document = document();
1351 for (path, methods) in document["paths"].as_object().unwrap() {
1352 for (method, operation) in methods.as_object().unwrap() {
1353 let example = &operation["responses"]["200"]["content"]["application/json"]["example"];
1354 let leaked = g1t_kit::wire::camel_case_keys(example);
1355 assert!(leaked.is_empty(), "{method} {path} shows {leaked:?}");
1356 }
1357 }
1358 }
1359
1360 /// Examples never hold anything that reads as a real credential, which
1361 /// secret scanners rightly flag in a public repository: they end in `…`
1362 /// after the prefix, as `whsec_…` and `g1t_…` do.
1363 #[test]
1364 fn examples_hold_no_real_looking_secrets() {
1365 let prefixes = ["whsec_", "g1t_", "g1tr_", "g1trt_", "sk_live_", "sk_test_", "ghp_", "github_pat_", "xoxb-", "AKIA"];
1366 for (line, text) in REFERENCE.lines().enumerate() {
1367 for prefix in prefixes {
1368 let mut rest = text;
1369 while let Some(at) = rest.find(prefix) {
1370 let after = &rest[at + prefix.len()..];
1371 let run = after.chars().take_while(|c| c.is_ascii_alphanumeric()).count();
1372 assert!(
1373 run < 12,
1374 "reference.json line {}: `{prefix}` followed by {run} characters reads as a real secret; write `{prefix}…`",
1375 line + 1
1376 );
1377 rest = after;
1378 }
1379 }
1380 }
1381 }
1382}

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