Skip to content

docs: sync agent-api-openapi.yaml from warp-server - #499

Open
hongyi-chen wants to merge 1 commit into
mainfrom
sync-openapi-spec/2026-08-10
Open

docs: sync agent-api-openapi.yaml from warp-server#499
hongyi-chen wants to merge 1 commit into
mainfrom
sync-openapi-spec/2026-08-10

Conversation

@hongyi-chen

@hongyi-chen hongyi-chen commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

What changed

Regenerates developers/agent-api-openapi.yaml (the spec behind the Scalar API reference) from warp-server's canonical public_api/openapi.yaml with the sync-openapi-spec skill. 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}/download
  • GET /agent/run-by-external-reference
  • POST /agent/runs/{runId}/scores

Also in the diff: /harness-support/transcript drops out (warp-server now marks it internal), /agent/artifacts/{artifactUid}, /agent/identities, and /agent/runs pick up operation changes, and the reachable schema set is refreshed (including the deprecation of base_harness in favor of harness on agent identities, and a new ORCHESTRATION run source).

Please confirm before merging

  • Agent memory schemas. The regenerated spec includes AgentMemoryCreateConfig, AgentAutoMemoryResponse, MemoryStoreRef, and related schemas. No /memory_stores operation is published — those stay internal — but the schemas are reachable from the public POST /agent/identities request 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 fields x-internal in warp-server and re-run the sync.
  • Implementation-only extensions. x-stainless-deprecation-message now appears in the published copy. warp-server's public-openapi-filter.yaml strips that flag (along with x-go-type and friends), but the docs-side sync_openapi.py only strips x-internal operations. Worth a follow-up to the sync script.

Validation

The sync script reports all $refs resolve in the regenerated spec, and npm run build passes.

Reviewers

scripts/suggest_reviewers.py found no owner entries for warp-server:public_api/openapi.yaml, router/handlers/public_api/agent_artifacts.go, run_score_reports.go, or agent_webhooks.go, so this needs manual assignment to the Oz API owners.

Found by

The missing_docs drift-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.

@hongyi-chen hongyi-chen added the documentation Improvements or additions to documentation label Aug 10, 2026
@vercel

vercel Bot commented Aug 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 12, 2026 5:27pm

Request Review

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>
@hongyi-chen
hongyi-chen marked this pull request as ready for review August 12, 2026 17:19
@oz-for-oss

oz-for-oss Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

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 /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 says Patch 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant