fix(v2): drop stale extract params (markdown_ref, idempotency_key) & fix README drift#111
Merged
Merged
Conversation
A tech-writer review against aide surfaced SDK parameters that were dropped from the API: - Remove `markdown_ref` from `client.v2.extract` / `extract_jobs.create` (dropped in aide#951); extract now requires exactly one of `markdown` or `markdown_url`. Delete the README section documenting it. - Remove `idempotency_key` from the same methods (dropped in aide#944). - Fix the README jobs example to use `service_tier="priority"` — the code was already renamed from `priority` (aide#899) in #106, but the example still passed a nonexistent kwarg that raised TypeError. - Reword `files.upload` docstrings/api.md to stop referencing the removed `markdown_ref` (`/v1/files` itself is still in the spec). `password` on v2 parse is intentionally kept: it remains in the tracked spec (specs/v2-aide.json) as a placeholder until PDF decryption ships (aide#272, aide#390). No released-surface break: client.v2 shipped after v1.12.0 (griffe surface-lock clean). Full suite: 587 passed; ruff/mypy clean. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns the V2 extract SDK and documentation with the tracked API specification.
Changes:
- Removes stale
markdown_refandidempotency_keyparameters. - Updates Markdown-source validation and documentation.
- Corrects the README’s
service_tierexample.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
tests/api_resources/v2/test_extract.py |
Updates extract tests for removed parameters. |
src/landingai_ade/resources/v2/v2.py |
Removes stale facade parameters. |
src/landingai_ade/resources/v2/files.py |
Revises upload documentation. |
src/landingai_ade/resources/v2/extract.py |
Updates extract signatures and body construction. |
README.md |
Fixes the jobs example and removes stale guidance. |
api.md |
Updates the documented V2 API surface. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
A tech-writer review comparing the SDK against aide flagged four parameters. Verified each against the tracked spec (
specs/v2-aide.json, synced in #110):markdown_ref— dropped from aide (aide#951) but still in the SDK and README. Removed fromclient.v2.extract/extract_jobs.create(sync + async) and the request-body builder; the "exactly one markdown source" guard now acceptsmarkdownormarkdown_url. Deleted the README's "Uploading a file formarkdown_ref" section and updatedapi.md.idempotency_key— dropped from aide (aide#944) but still sent in the extract body. Removed from the same methods. (Theidempotency_keymachinery in_base_client.pyis the generic idempotency-header support, unrelated to this body field — left as is.)priority— the code was already renamed toservice_tierin feat(v2): align client.v2 with updated ADE spec (service_tier, billing) #106, but README's jobs example still passedpriority="priority", a nonexistent kwarg that raisesTypeError. Fixed toservice_tier="priority".password— intentionally kept: still present in the tracked spec as a deliberate placeholder until PDF decryption ships (aide#272, aide#390).Also kept
client.v2.files.upload(/v1/filesis still in the spec) but reworded its docstrings andapi.mdentry to stop referencing the removedmarkdown_ref.Breaking-change note
Removing
markdown_ref/idempotency_keydoes not break the released public API: the entireclient.v2surface landed after v1.12.0. Verified with the griffe surface-lock (clean against v1.12.0).Test plan
ruff check .clean; mypy clean; pyright errors identical to baseline (pre-existing)ruffen-docsrun over README.md / api.md🤖 Generated with Claude Code