Skip to content

docs: expose agent followups endpoint#151

Merged
captainsafia merged 1 commit into
mainfrom
oz-agent/expose-followups-api-docs
May 28, 2026
Merged

docs: expose agent followups endpoint#151
captainsafia merged 1 commit into
mainfrom
oz-agent/expose-followups-api-docs

Conversation

@captainsafia

Copy link
Copy Markdown
Contributor

Summary

Expose POST /agent/runs/{runId}/followups in the public Agent API reference as a focused one-off update.

This PR:

  • Removes /agent/runs/{runId}/followups from the OpenAPI sync exclusion policy.
  • Updates the sync policy reference to list the remaining intentionally hidden agent paths.
  • Regenerates developers/agent-api-openapi.yaml so Scalar renders the follow-up endpoint and RunFollowupRequest schema.

To keep this PR focused, the generated YAML was regenerated from the same warp-server source commit used by the last docs sync (810f9bce554ff3c276b308e4cf741f0f39bc954b) after removing only this exclusion, rather than pulling in unrelated current warp-server OpenAPI drift.

Related issues

Slack request to make POST /api/v1/agent/runs/{runId}/followups visible in docs.warp.dev/api#tag/agent.

Validation

  • python3 .agents/skills/sync-openapi-spec/scripts/sync_openapi.py --mode self-testself-test: OK
  • Regenerated developers/agent-api-openapi.yaml with --mode applyAll $refs resolve in the regenerated spec.
  • Verified submitRunFollowup, /agent/runs/{runId}/followups, and RunFollowupRequest are present in developers/agent-api-openapi.yaml.
  • npm ci
  • npm run build → 333 pages built successfully; only existing non-blocking prerender/header warnings were emitted.

Screenshots

Not included; this is an OpenAPI spec update rendered by Scalar.

Follow-ups

Current warp-server has additional OpenAPI drift beyond this endpoint (client-events, timeline, and schema changes). Those are intentionally out of scope for this one-off and can be handled by a separate full sync PR.

Conversation: https://staging.warp.dev/conversation/f637f93c-9eed-4ce7-8580-296680a9b963
Run: https://oz.staging.warp.dev/runs/019e6f6c-a0c5-7d55-bb00-70ecc0beea75
This PR was generated with Oz.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 28, 2026
@vercel

vercel Bot commented May 28, 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, Comment May 28, 2026 4:44pm

Request Review

@captainsafia captainsafia marked this pull request as ready for review May 28, 2026 16:47
@oz-for-oss

oz-for-oss Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

@captainsafia

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 updates the OpenAPI sync exclusion policy and regenerated Agent API OpenAPI document to expose POST /agent/runs/{runId}/followups and the RunFollowupRequest schema. I did not find correctness, documentation-structure, security, or spec-alignment issues in the attached diff.

Concerns

  • None.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@captainsafia captainsafia requested a review from hongyi-chen May 28, 2026 17:03
@captainsafia captainsafia merged commit afdf64b into main May 28, 2026
8 checks passed
@captainsafia captainsafia deleted the oz-agent/expose-followups-api-docs branch May 28, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants