fix: drop stale v2 extract params (markdown_ref, idempotency_key) - #76
Merged
Merged
Conversation
Verified against the live AIDE spec: /v2/extract and /v2/extract/jobs accept only schema / markdown / markdown_url / model / options (+ service_tier) — no markdown_ref, no idempotency_key. Remove both from client.v2.extract / extractJobs.create (mirrors landing-ai/ade-python#111). files.upload remains (/v1/files still in the spec) but its docstring and the README no longer claim it feeds extract as markdown_ref. Also drop idempotency_key from client.v2.workflow / workflowJobs.create — the spec's /v2/workflow* request bodies don't define it either. (ade-python#111 didn't cover workflow because that repo defers the workflow surface; ade-typescript ships it.) No released-surface break: client.v2 is unreleased (added after v2.7.0). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Removes stale request parameters from the unreleased client.v2 TypeScript surface to match the current live AIDE OpenAPI spec, and updates docs accordingly.
Changes:
- Removed
markdown_refandidempotency_keyfrom V2 extract request params and request-body construction. - Removed
idempotency_keyfrom V2 workflow params and request building (JSON + multipart). - Updated inline docs and README to reflect the supported inputs (
markdown/markdown_url) and removed the outdatedmarkdown_refstaging flow.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/resources/v2/workflow.ts | Drops idempotency_key from workflow params and from both JSON and multipart request bodies. |
| src/resources/v2/v2.ts | Updates v2.extract docs to reflect supported input parameters. |
| src/resources/v2/files.ts | Rewords files.upload docstring to remove the deprecated markdown_ref guidance. |
| src/resources/v2/extract.ts | Removes deprecated extract params from types and from buildExtractBody. |
| README.md | Updates V2 extract docs and removes the outdated “File staging” section for markdown_ref. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
yzld2002
approved these changes
Jul 14, 2026
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.
Mirrors landing-ai/ade-python#111. A check of
client.v2against the live AIDE spec surfaced request parameters the API no longer accepts.Verified against the live AIDE spec (
aide.landing.ai/openapi.json):/v2/extract&/v2/extract/jobs→schema(required),markdown,markdown_url,model,options(+service_tieron jobs). Nomarkdown_ref, noidempotency_key./v2/workflow&/v2/workflow/jobs→inputs,steps,output(+service_tier). Noidempotency_key.Changes
markdown_ref+idempotency_keyfromclient.v2.extract/extractJobs.create(V2ExtractParams,buildExtractBody).idempotency_keyfromclient.v2.workflow/workflowJobs.create. (ade-python#111 didn't touch workflow — that repo defers the workflow surface; ade-typescript ships it, so this is a TS-specific hit.)files.uploaddocstring and drop the README "File staging" section (both showed the removedmarkdown_refflow)./v1/files/files.uploaditself stays.password(parse),service_tier,output_save_urlare all in the spec → untouched.No released-surface break —
client.v2is unreleased (added afterv2.7.0). Typecheck clean; full suite 280 passed.Reference: landing-ai/ade-python#111.
🤖 Generated with Claude Code