From 8058cb10b04bfb8be82da99574805058a1f6bd6f Mon Sep 17 00:00:00 2001 From: uvasoftware-skippy <30219621+uvasoftware-skippy@users.noreply.github.com> Date: Mon, 31 Aug 2026 16:09:58 -0400 Subject: [PATCH] docs: drop the preview designation from the trace surface 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), so the SDK should stop advertising a caveat we no longer mean. Removes the Preview paragraph from ScaniiClient#retrieveTrace and ScaniiTraceResult, and the "(preview)" tag from the README API table. 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 | 2 +- src/main/java/com/scanii/ScaniiClient.java | 3 --- src/main/java/com/scanii/models/ScaniiTraceResult.java | 3 --- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a9091e5..992919e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [Unreleased] + +### Changed + +- Dropped the "preview" designation from `retrieveTrace` and `ScaniiTraceResult`. + The trace endpoint is no longer marked preview in the v2.2 contract; the method + itself is unchanged. + ## [8.4.0] — 2026-08-29 ### Added diff --git a/README.md b/README.md index d51b87f..8dff256 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ System.out.printf("findings: %s%n", result.getFindings()); | `retrieve(String id)` | Retrieve previous scan result | | `delete(String id)` | Delete a previous scan result | | `deleteTrace(String id)` | Delete the processing trace for a previous scan result | -| `retrieveTrace(String id)` | Retrieve ordered processing events for a result (preview) | +| `retrieveTrace(String id)` | Retrieve ordered processing events for a result | | `fetch(String location)` | Server-side async fetch-and-scan of a remote URL | | `ping()` | Health check | | `createAuthToken(int timeout, TimeUnit unit)` | Mint short-lived auth token | diff --git a/src/main/java/com/scanii/ScaniiClient.java b/src/main/java/com/scanii/ScaniiClient.java index 8377001..46d10f8 100644 --- a/src/main/java/com/scanii/ScaniiClient.java +++ b/src/main/java/com/scanii/ScaniiClient.java @@ -154,9 +154,6 @@ public interface ScaniiClient { * Retrieves the processing trace for a previously processed file. * Returns an ordered list of events describing each stage of the processing pipeline. * - *

Preview: the trace endpoint is marked preview in the v2.2 spec — - * the API surface may shift before it is marked stable. - * * @param id id of the previously processed content * @return optional {@link ScaniiTraceResult}, empty if the id is not found * @see spec diff --git a/src/main/java/com/scanii/models/ScaniiTraceResult.java b/src/main/java/com/scanii/models/ScaniiTraceResult.java index 61f355b..9e4e481 100644 --- a/src/main/java/com/scanii/models/ScaniiTraceResult.java +++ b/src/main/java/com/scanii/models/ScaniiTraceResult.java @@ -8,9 +8,6 @@ * Result of a {@link com.scanii.ScaniiClient#retrieveTrace(String)} call, * containing an ordered list of processing events for a given processing id. * - *

Preview: the trace endpoint ({@code GET /v2.2/files/{id}/trace}) - * is marked preview in the v2.2 spec — the API surface may shift before it is marked stable. - * * @see spec */ public class ScaniiTraceResult extends ScaniiResult {