docs(api): surface the run followups endpoint in API & SDK reference#190
Draft
seemeroland wants to merge 1 commit into
Draft
docs(api): surface the run followups endpoint in API & SDK reference#190seemeroland wants to merge 1 commit into
seemeroland wants to merge 1 commit into
Conversation
The POST /agent/runs/{runId}/followups endpoint is available in the REST
API and the generated SDKs (runs.submit_followup), but the API & SDK
overview page only listed run/list/get as primary endpoints, so it was
hard to discover. Add the follow-up (and cancel) endpoints to the Key
Endpoints list, add RunFollowupRequest to the models list, and add a
next-steps pointer in the quickstart.
REMOTE-1889
Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
seemeroland
added
the
from-feedback-bot
Warp Dev Github Integration
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
1 participant
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.
Summary
Improves discoverability of the run follow-ups endpoint in the public Oz API & SDK docs.
REMOTE-1889 — a customer building a custom GitHub Actions integration could not find an API to send a follow-up message (the way the Linear/Slack integrations do). The capability is already exposed:
POST /agent/runs/{runId}/followups(documented in the Scalar reference at/api).warp-server/stainless/stainless.yml(agent.runs.submit_followup), and both OpenAPI specs already define the endpoint and theRunFollowupRequestschema.The gap was the human-readable overview page, which listed only
run/list/getas the "primary endpoints", so the follow-up endpoint was effectively hidden.Changes
reference/api-and-sdk/index.mdxPOST /agent/runs/{runId}/followups(andPOST /agent/runs/{runId}/cancel) to the Key Endpoints list, noting it is the same capability the Slack and Linear integrations use, and that it is available in the SDKs (runs.submit_followup).RunFollowupRequestto the Models Reference list.reference/api-and-sdk/quickstart.mdxNotes
stainless.ymlor OpenAPI changes were required — the endpoint is already exposed there. This PR is scoped to the remaining docs-discoverability gap called out in the issue.npm run build(337 pages built, no errors).Testing
npm run build— succeeds.Conversation: https://staging.warp.dev/conversation/67551d0d-4dd3-41c8-a959-ec5d77d24221
Run: https://oz.staging.warp.dev/runs/019ea832-5fd9-7656-ad84-5afdeb7f085e
This PR was generated with Oz.