docs: sync agent-api-openapi.yaml from warp-server - #613
Conversation
Prune unused entries from every shared component section, not just components.schemas, so a response referenced only by an excluded /factory path can no longer ship in the published spec. Co-Authored-By: Oz <oz-agent@warp.dev> Co-Authored-By: Warp <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
This PR was generated with Warp. Comment |
|
Your GitHub account is not connected to Warp. Connect it here. |
…g across developer reference Consolidates three overlapping docs PRs into one per requester ask: - Keeps this PR's (#622) already-reviewed factory-API decision-framework section on factory-api.mdx as the base. - Folds in #626's OpenAPI sync (supersedes #613), the factory-api.mdx Endpoints rename + interactive reference link, and the tone/structure rewrite of reference/api-and-sdk/index.mdx, reference/index.mdx, reference/api-and-sdk/quickstart.mdx, reference/api-and-sdk/demo-sentry-monitoring-with-sdk.mdx, and reference/api-and-sdk/troubleshooting/errors/index.mdx. - Re-threads the choosing-how-work-reaches-a-factory cross-link into the rewritten reference/api-and-sdk/index.mdx overview paragraph so neither PR's intent is lost.
|
Thanks for this — folding it into #622 per the consolidation ask in the originating Slack thread. This PR's OpenAPI sync is superseded by the newer regeneration carried in #626 (which was also folded into #622): #626's sync includes the same "un-exclude the Closing this one in favor of #622. Thanks for the work here — let us know if anything looks off in how it landed. |


Summary
Regenerates
developers/agent-api-openapi.yaml(the file Scalar renders atdocs.warp.dev/api) from the canonical spec inwarp-server/public_api/openapi.yaml, and fixes a filter gap in the sync script that let a private component leak into the published copy.Found by the
missing_docsdrift-watch audit, which flagged two new/factoryroutes in warp-server; triaging them surfaced the accumulated spec drift below.Source commit:
warp-server@8b41081c4(develop).Changes
developers/agent-api-openapi.yaml(regenerated)Schemas added:
ChargedUsageDetail,InferenceCostBreakdownUsd,InferenceUsageDetail,TokenCountBreakdown— the per-category token and dollar-cost breakdown now returned with run usage.Schemas modified:
AgentResponse,AmbientAgentConfig,FileArtifactData,FileArtifactResponseData,Harness,RequestUsage,RunExecutionLocation.RequestUsagegainstotal_tokens,inference_cost_breakdown_usd, andusage_by_category; cost fields now describe conversion at the owning team's current credit price rather than a fixed rate;AmbientAgentConfiggainscomputer_use_model_id;AgentResponse.availableis redescribed as "whether the agent is currently enabled."Top-level
infoupdated: titleOz Agent API→Warp Agent API, plus severalOz→Warpwording changes in descriptions. These all come from upstream.Removed:
components.responses.FactoryAccessDenied— see below..agents/skills/sync-openapi-spec/scripts/sync_openapi.pyThe script pruned
components.schemasdown to entries reachable from the surviving paths, but copied every other component section verbatim.FactoryAccessDenied— a shared response referenced only by the private/factory/*operations that this policy excludes — therefore shipped in the published spec as an orphan definition naming a private surface.PRUNABLE_COMPONENT_SECTIONS, mirroringunusedComponentsinwarp-server/public_api/public-openapi-filter.yaml(schemas,parameters,examples,headers,requestBodies,responses,mediaTypes). Sections outside the set (securitySchemes) are still copied verbatim, since nothing$refs them.$refwalking from schema names to(section, name)pairs so reachability follows cross-section edges (a shared response pulls in the schemas it references)._transitive_schemasbecame_reachable_components.--mode diffnow reports added/removed/modified entries for every pruned section, not justschemas. A stalecomponents.responsesentry in the target previously reported as "in sync.".agents/skills/sync-openapi-spec/references/sync-policy.mdDocuments the new pruning rule and the leak it closes.
Validation
--mode self-test→ OK--mode diffafter apply →In sync. No changes needed.npm run build→ exit 0 (only the repo's pre-existing chunk-size and/404route warnings)/factory,/memory*, or/harness-supportpaths, and nox-*implementation extensionsReviewers
scripts/suggest_reviewers.pyresolved no owner forwarp-server:public_api/openapi.yaml,router/handlers/public_api/factories.go, orrouter/handlers/public_api/factory_automations.go— neither.github/CODEOWNERSnor.github/STAKEHOLDERShas a rule coveringpublic_api/orrouter/handlers/public_api/. Recent history on those files is almost entirely automation commits, so no reviewer was auto-assigned; please route manually.Worth considering separately: adding a
/public_api/and/router/handlers/public_api/rule to warp-server's.github/STAKEHOLDERSso future spec syncs route themselves.Unverified claims
None — this PR adds no prose. Every schema and description is copied verbatim from the canonical warp-server spec.
Co-Authored-By: Oz oz-agent@warp.dev
Co-Authored-By: Warp agent@warp.dev
Deferred findings
This PR resolves every API-category finding from the 2026-08-24
missing_docsdrift-watch run. The run's remaining 23 findings are all low-severity terminology matches deferred tostyle_lint, and they are listed with per-term rationale in the companion bookkeeping PR #614 under "Deferred findings". Nothing from the run was dropped without a recorded decision.