Skip to content

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

Merged
hongyi-chen merged 1 commit into
mainfrom
sync-openapi-spec/2026-05-19
May 20, 2026
Merged

docs: sync agent-api-openapi.yaml from warp-server#111
hongyi-chen merged 1 commit into
mainfrom
sync-openapi-spec/2026-05-19

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

Sync developers/agent-api-openapi.yaml (the file that powers the Scalar API reference at docs.warp.dev/api) from the canonical spec at warp-server/public_api/openapi.yaml.

Source

  • warp-server commit: 810f9bce554ff3c276b308e4cf741f0f39bc954b

Drift summary

Paths added (1)

  • + /agent/connected-self-hosted-workers

Paths modified (3)

  • ~ /agent/identities/{uid}
  • ~ /agent/runs
  • ~ /agent/sessions/{sessionUuid}/redirect

Schemas added (8)

  • + AgentRunMode
  • + AwsInferenceProviderConfig
  • + ConnectedSelfHostedWorker
  • + InferenceProvidersConfig
  • + ListConnectedSelfHostedWorkersResponse
  • + MemoryStoreRef
  • + SecretRef
  • + SessionSharingConfig

Schemas removed (10)

  • - CreateExternalConversationRequest
  • - CreateExternalConversationResponse
  • - FinishTaskRequest
  • - GetUploadTargetRequest
  • - NotifyUserRequest
  • - ReportArtifactRequest
  • - ReportArtifactResponse
  • - ReportPullRequestArtifactRequest
  • - ResolvePromptRequest
  • - ResolvePromptResponse
  • - UploadTarget

Schemas modified (12)

  • ~ AgentResponse
  • ~ AmbientAgentConfig
  • ~ CreateAgentRequest
  • ~ CreateScheduledAgentRequest
  • ~ Harness
  • ~ HarnessAuthSecrets
  • ~ RequestUsage
  • ~ RunAgentRequest
  • ~ RunItem
  • ~ ScheduledAgentItem
  • ~ UpdateAgentRequest
  • ~ UpdateScheduledAgentRequest

Top-level

  • info section refreshed to match the source spec.

Triage

No unclassified tags or paths were flagged by the sync script — every change is covered by the existing EXCLUDED_TAGS / EXCLUDED_PATHS policy plus the agent / schedules allowlist.

Validation

  • python3 .agents/skills/sync-openapi-spec/scripts/sync_openapi.py --mode self-testself-test: OK
  • --mode applyAll $refs resolve in the regenerated spec.
  • npm run build → 332 pages built, no errors.
  • npx @redocly/cli lint developers/agent-api-openapi.yaml → only pre-existing source-spec warnings (missing 4xx responses on some operations, nullable usage, license.url); none introduced by this sync.

Conversation: https://staging.warp.dev/conversation/af8f7d3f-05dc-4167-b545-95710157a5c5
Run: https://oz.staging.warp.dev/runs/019e426f-3d44-7260-adbb-1ee877ea2178

This PR was generated with Oz.

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

vercel Bot commented May 19, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 19, 2026 10:57pm

Request Review

@hongyi-chen hongyi-chen marked this pull request as ready for review May 19, 2026 23:00
@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented May 19, 2026

@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

Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

Overview

This PR syncs developers/agent-api-openapi.yaml from the canonical warp-server OpenAPI spec. The supplied pr_diff.txt shows the file changed, but GitHub did not provide a patch for the file.

Concerns

  • The only changed file is listed as patch-unavailable, so the review artifacts contain no annotated [NEW:n] or [OLD:n] lines to inspect. I cannot verify the regenerated OpenAPI content, security-relevant API surface changes, or spec alignment from the provided diff, and there are no valid lines for inline comments.

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

@hongyi-chen hongyi-chen merged commit c8d3b94 into main May 20, 2026
8 checks passed
@hongyi-chen hongyi-chen deleted the sync-openapi-spec/2026-05-19 branch May 20, 2026 15:48
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.

2 participants