docs: drop the preview designation from the trace surface - #119
Merged
Merged
Conversation
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 <noreply@anthropic.com>
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
2 participants
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.
Part of a 6-SDK sweep removing the "v2.2 preview" language now that the contract itself has dropped it (scanii/openapi#49, merged).
Docs only — no signature, behavior or return-type change.
Changes
ScaniiClient#retrieveTrace— removed the<strong>Preview:</strong>javadoc paragraphScaniiTraceResult— same paragraph removed from the class javadoc(preview)tag from theretrieveTracerow[Unreleased]entry noting the changeWhy
The v2.2 spec only ever marked the trace GET as preview, and that marking is now gone from the contract. Java was the only SDK that didn't also mislabel
processFromUrl, so this change is narrower here than in the other five.Version
No version bump. This rides the next release rather than cutting a tag for comment changes. (Java's version is rewritten from the tag at publish time anyway, so there is nothing to bump.)
Verification
mvn -o compile— clean.Related
Python and Ruby are already clean. dotnet, go, node, php and rust get the same treatment in parallel PRs.