Skip to content

docs: drop the preview designation from retrieveTrace and processFromUrl #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rferreira merged 1 commit into from
Aug 31, 2026
Merged

docs: drop the preview designation from retrieveTrace and processFromUrl #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<ScaniiProcessingResult>` |
| `processFile(path, metadata?, callback?)` | `POST /files` | `Promise<ScaniiProcessingResult>` |
| `processFromUrl(location, options?)` | `POST /files` | `Promise<ScaniiProcessingResult>` (v2.2 preview) |
| `processFromUrl(location, options?)` | `POST /files` | `Promise<ScaniiProcessingResult>` |
| `processAsync(content, metadata?, callback?)` | `POST /files/async` | `Promise<ScaniiPendingResult>` |
| `processAsyncFile(path, metadata?, callback?)` | `POST /files/async` | `Promise<ScaniiPendingResult>` |
| `fetch(url, metadata?, callback?)` | `POST /files/fetch` | `Promise<ScaniiPendingResult>` |
| `retrieve(id)` | `GET /files/{id}` | `Promise<ScaniiProcessingResult>` |
| `retrieveTrace(id)` | `GET /files/{id}/trace` | `Promise<ScaniiTraceResult \| undefined>` (v2.2 preview) |
| `retrieveTrace(id)` | `GET /files/{id}/trace` | `Promise<ScaniiTraceResult \| undefined>` |
| `delete(id)` | `DELETE /files/{id}` | `Promise<boolean>` |
| `deleteTrace(id)` | `DELETE /files/{id}/trace` | `Promise<boolean>` |
| `ping()` | `GET /ping` | `Promise<boolean>` |
Expand Down
6 changes: 0 additions & 6 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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<ScaniiTraceResult | undefined> {
Expand All @@ -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(
Expand Down