docs: sync agent-api-openapi.yaml from warp-server - #499
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Regenerates developers/agent-api-openapi.yaml from warp-server's canonical public spec with the sync-openapi-spec skill. Co-Authored-By: Warp Agent <agent@warp.dev>
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
There was a problem hiding this comment.
Overview
This PR regenerates developers/agent-api-openapi.yaml from the canonical warp-server OpenAPI spec. The attached review diff does not include a patch for the only changed file, so I could not inspect the generated API changes, validate the memory-related public surface called out in the PR description, or perform a meaningful security/spec-alignment review against changed lines.
Concerns
⚠️ The annotated diff only saysPatch unavailable from GitHub for this file.Please rerun this review with an attached patch or split/provide the generated OpenAPI diff so reviewers can verify the endpoint/schema changes before merge.
Verdict
Found: 0 critical, 1 important, 0 suggestions
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
d559fb7 to
0efa846
Compare
What changed
Regenerates
developers/agent-api-openapi.yaml(the spec behind the Scalar API reference) from warp-server's canonicalpublic_api/openapi.yamlwith thesync-openapi-specskill. The branch was refreshed against today's warp-server checkout, so it now also carries the changes made since the previous revision.Public operations added:
GET /agent/artifacts/{artifactUid}/downloadGET /agent/run-by-external-referencePOST /agent/runs/{runId}/scoresAlso in the diff:
/harness-support/transcriptdrops out (warp-server now marks it internal),/agent/artifacts/{artifactUid},/agent/identities, and/agent/runspick up operation changes, and the reachable schema set is refreshed (including the deprecation ofbase_harnessin favor ofharnesson agent identities, and a newORCHESTRATIONrun source).Please confirm before merging
AgentMemoryCreateConfig,AgentAutoMemoryResponse,MemoryStoreRef, and related schemas. No/memory_storesoperation is published — those stay internal — but the schemas are reachable from the publicPOST /agent/identitiesrequest body in warp-server's spec, so they ride along. Agent Memory is still in research preview, so please confirm this is the intended public surface, or mark the fieldsx-internalin warp-server and re-run the sync.x-stainless-deprecation-messagenow appears in the published copy. warp-server'spublic-openapi-filter.yamlstrips that flag (along withx-go-typeand friends), but the docs-sidesync_openapi.pyonly stripsx-internaloperations. Worth a follow-up to the sync script.Validation
The sync script reports all
$refs resolve in the regenerated spec, andnpm run buildpasses.Reviewers
scripts/suggest_reviewers.pyfound no owner entries forwarp-server:public_api/openapi.yaml,router/handlers/public_api/agent_artifacts.go,run_score_reports.go, oragent_webhooks.go, so this needs manual assignment to the Oz API owners.Found by
The
missing_docsdrift-watch audit (three public API endpoints missing from the spec).Conversation: https://staging.warp.dev/conversation/1bda9ae7-44b1-43c5-bb7a-d22ccf8b6c16
Run: https://oz.staging.warp.dev/runs/019ff6ea-bc3c-7336-b1f5-9f1f5b89cd84
This PR was generated with Oz.