Skip to content

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

Draft
hongyi-chen wants to merge 1 commit into
mainfrom
sync-openapi-spec/2026-05-11
Draft

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

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

Syncs developers/agent-api-openapi.yaml from warp-server/public_api/openapi.yaml.

Source warp-server commit: edcd8278af3c62f1fea20803dff7d5552b8808d0

Structural diff before apply:

Drift detected between
  source: /workspace/warp-server/public_api/openapi.yaml
  target: /workspace/docs/developers/agent-api-openapi.yaml

Paths whose operations differ between source and target:
  ~ /agent/identities/{uid}
  ~ /agent/runs
  ~ /agent/sessions/{sessionUuid}/redirect
Schemas present in source subset but missing from target:
  + AgentRunMode
  + MemoryStoreRef
  + SecretRef
  + SessionSharingConfig
Schemas present in target but absent from source subset:
  - CreateExternalConversationRequest
  - CreateExternalConversationResponse
  - FinishTaskRequest
  - GetUploadTargetRequest
  - NotifyUserRequest
  - ReportArtifactRequest
  - ReportArtifactResponse
  - ReportPullRequestArtifactRequest
  - ResolvePromptRequest
  - ResolvePromptResponse
  - UploadTarget
Schemas whose definitions differ between source subset and target:
  ~ AgentResponse
  ~ AmbientAgentConfig
  ~ CreateAgentRequest
  ~ CreateScheduledAgentRequest
  ~ Harness
  ~ RequestUsage
  ~ RunAgentRequest
  ~ RunItem
  ~ ScheduledAgentItem
  ~ UpdateAgentRequest
  ~ UpdateScheduledAgentRequest

Validation:

  • python3 .agents/skills/sync-openapi-spec/scripts/sync_openapi.py --mode self-test passed.
  • Apply mode wrote the regenerated spec and confirmed all $refs resolve.
  • Follow-up diff reported In sync. No changes needed.
  • npm run build passed. The sandbox initially had no /etc/hosts, causing localhost resolution to fail while loading Astro config; adding standard localhost entries fixed the sandbox environment.
  • Optional npx @redocly/cli lint developers/agent-api-openapi.yaml failed on a duplicate canonical operationId: listAgents for /agent and /agent/identities, plus existing recommended-rule warnings. The generated docs YAML was left in sync with warp-server rather than hand-edited.

This PR was created by Oz (running Codex).

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen hongyi-chen added the documentation Improvements or additions to documentation label May 11, 2026
@cla-bot cla-bot Bot added the cla-signed label May 11, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 11, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 11, 2026 4:08pm

Request Review

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