From 631731bb49564c1b48346a51ef65b8db261310f8 Mon Sep 17 00:00:00 2001 From: Rafael Ferreira <36054+rferreira@users.noreply.github.com> Date: Mon, 31 Aug 2026 16:12:37 -0400 Subject: [PATCH] docs: drop the preview designation from retrieveTrace and processFromUrl MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The v2.2 contract no longer marks GET /files/{id}/trace as preview (scanii/openapi#49), and processFromUrl was never preview in the spec at all — that label was drift from the v2.2 propagation. Docs only — no signature, behavior or return-type change. No version bump; this rides the next release. Co-Authored-By: Claude Opus 5 --- CHANGELOG.md | 8 ++++++++ README.md | 4 ++-- src/client.ts | 6 ------ 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 27e180a..e9aa4a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ All notable changes to `@scanii/core` are documented here. Versions follow [SemVer](https://semver.org). +## [Unreleased] + +### Changed + +- Dropped the "v2.2 preview" designation from `retrieveTrace` and `processFromUrl`. + The trace endpoint is no longer marked preview in the contract, and `processFromUrl` + was never preview; the methods themselves are unchanged. + ## [1.4.1] — dependency refresh ## [1.5.0] — v2.2 delete endpoints split diff --git a/README.md b/README.md index cfdd0cd..c216467 100644 --- a/README.md +++ b/README.md @@ -52,12 +52,12 @@ For browser usage, prefer minting a short-lived auth token server-side and const |---|---|---| | `process(content, metadata?, callback?)` | `POST /files` | `Promise` | | `processFile(path, metadata?, callback?)` | `POST /files` | `Promise` | -| `processFromUrl(location, options?)` | `POST /files` | `Promise` (v2.2 preview) | +| `processFromUrl(location, options?)` | `POST /files` | `Promise` | | `processAsync(content, metadata?, callback?)` | `POST /files/async` | `Promise` | | `processAsyncFile(path, metadata?, callback?)` | `POST /files/async` | `Promise` | | `fetch(url, metadata?, callback?)` | `POST /files/fetch` | `Promise` | | `retrieve(id)` | `GET /files/{id}` | `Promise` | -| `retrieveTrace(id)` | `GET /files/{id}/trace` | `Promise` (v2.2 preview) | +| `retrieveTrace(id)` | `GET /files/{id}/trace` | `Promise` | | `delete(id)` | `DELETE /files/{id}` | `Promise` | | `deleteTrace(id)` | `DELETE /files/{id}/trace` | `Promise` | | `ping()` | `GET /ping` | `Promise` | diff --git a/src/client.ts b/src/client.ts index 2930b37..238bc99 100644 --- a/src/client.ts +++ b/src/client.ts @@ -266,9 +266,6 @@ export class ScaniiClient { * Returns `undefined` when the id is not found (HTTP 404). All other * error statuses throw a `ScaniiError` subclass as usual. * - * **Preview surface** — part of the v2.2 API; behavior may change in future - * releases. - * * @see {@link https://scanii.github.io/openapi/v22/} — `GET /files/{id}/trace` */ async retrieveTrace(id: string): Promise { @@ -291,9 +288,6 @@ export class ScaniiClient { * 201). The `location` parameter is a plain string URL — not a `URL` object * — matching the convention established by {@link fetch}. * - * **Preview surface** — part of the v2.2 API; behavior may change in future - * releases. - * * @see {@link https://scanii.github.io/openapi/v22/} — `POST /files` */ async processFromUrl(