docs: sync agent-api-openapi.yaml from warp-server - #499
Draft
hongyi-chen wants to merge 1 commit into
Draft
Conversation
Regenerates the Scalar-facing subset from warp-server @ b84a4127. Adds the three public endpoints missing from the docs copy (artifact download, run-by-external-reference, run scores), drops harness-support/transcript, and refreshes 21 modified schemas. Co-Authored-By: Warp Agent <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Regenerates
developers/agent-api-openapi.yaml(the file Scalar renders atdocs.warp.dev/api) from the canonical spec in warp-server. Opened from themissing_docsdrift-watch audit, which flagged three public endpoints present in the canonical spec but missing from the docs copy.Source:
warpdotdev/warp-server@b84a4127b8c437e29a0d85e6cfeeef3b20cd468aDrift resolved
Paths present in source but missing from target:
+ /agent/artifacts/{artifactUid}/download+ /agent/run-by-external-reference+ /agent/runs/{runId}/scoresPaths present in target but absent from the source subset:
- /harness-support/transcriptPaths whose operations differ:
~ /agent/artifacts/{artifactUid}~ /agent/identities~ /agent/runsSchemas added (16):
AgentAutoMemoryCreateConfig,AgentAutoMemoryResponse,AgentCredentialStrategy,AgentMemoryCreateConfig,AgentMemoryResponse,AgentMemoryUpdateConfig,AgentType,ExternalReferenceArtifact,ExternalReferenceArtifactData,MemoryStoreAttachmentResponse,ReportRunScoresRequest,ReportRunScoresResponse,ReportedRunScore,ReportedRunScoreOutcome,RunByExternalReferenceResponse,RunMetadata.Schemas modified (21):
AIRunTimelineEvent,AIRunTimelineEventType,AgentResponse,AmbientAgentConfig,ArtifactItem,CloudEnvironmentConfig,CreateAgentRequest,CreateScheduledAgentRequest,FileArtifactData,FileArtifactResponseData,Harness,MCPServerConfig,RequestUsage,RunAgentRequest,RunAgentResponse,RunItem,RunSourceType,RunStatusMessage,ScheduledAgentItem,UpdateAgentRequest,UpdateScheduledAgentRequest.No
!unclassified paths or tags, so the exclusion policy inscripts/sync_openapi.pyneeded no changes.Please confirm before merging
The regenerated subset pulls in memory-related schemas (
AgentMemoryCreateConfig,AgentAutoMemoryResponse,MemoryStoreAttachmentResponse, and friends). They arrive not because thememory_storestag was included — it is still excluded — but because public, non-x-internalagent operations reference them, so the$refwalker keeps them reachable.That mirrors warp-server's own public/internal classification, which this skill treats as the source of truth. Still worth a human check: Agent Memory is a research preview, so if these fields are not meant to be publicly visible on the agent endpoints yet, the fix belongs in warp-server's
public_api/openapi.yaml(mark themx-internal: true) rather than in this generated file. Left as a draft for that reason.Verification
--mode self-testpasses.--mode applyvalidated every$refin the output before writing.npm run buildpasses; Scalar parses the regenerated YAML.Related
Companion PRs from the same audit run: #493 (Warp Agent CLI slash commands) and #494 (surface map and snapshot bookkeeping, which lists this run's deferred findings).
Conversation: https://staging.warp.dev/conversation/7e6d979d-88a2-46f0-90e1-6404a7edc72e
Run: https://oz.staging.warp.dev/runs/019fec9e-026d-7b44-bc62-8d6c8e2ccf6b
This PR was generated with Oz.