docs: drop the preview marking from GET /files/{id}/trace - #49
Merged
Merged
Conversation
The trace endpoint has been in production since 2.2 shipped and its shape has not moved. Carrying "API surface may shift before it's marked stable" in the contract keeps every SDK advertising a caveat we no longer mean, so it goes. Description text only — no path, schema or response change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Not requested — kept as its own commit so it can be dropped without touching
the preview removal. The 2.2 highlights listed the `location` parameter and the
trace endpoint but never picked up DELETE /files/{id} or
DELETE /files/{id}/trace, which landed later in the same version.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
rferreira
added a commit
to scanii/scanii-ruby
that referenced
this pull request
Aug 31, 2026
* feat: add delete and delete_trace; drop preview language (1.4.0) Final leg of the delete fan-out. Propagates the openapi v2.2 delete endpoints (scanii/openapi#46, superseded by #48), following the naming locked by scanii-java and the pattern shipped in dotnet, go, node, rust, php and python. - Scanii::Client#delete(id) — DELETE /v2.2/files/{id}; removes the processing result only, leaving the trace readable - Scanii::Client#delete_trace(id) — DELETE /v2.2/files/{id}/trace; removes the trace only, leaving the result readable - Both return true on 204, matching #delete_auth_token and Java's boolean, and raise Scanii::Error on 404 / Scanii::AuthError on 401,403 via raise_for_status Also drops the "v2.2 preview" designation from retrieve_trace and process_from_url (README, RDoc, TraceResult, test section comments). The spec only ever marked the trace GET as preview, and that marking has now been removed from the contract itself (scanii/openapi#49). Docs only — no behavior change. Historical CHANGELOG entries left intact. VERSION 1.3.1 -> 1.4.0. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix: encode path segments with encode_uri_component, not the form encoder Not part of the delete work — separated so it can be dropped independently. url_encode fed every id-taking method through URI.encode_www_form_component, which renders a space as "+". That is correct for a form body and wrong in a path, where "+" is a literal plus: delete("a b") requested /files/a+b, so the server would look up the id "a+b". URI.encode_uri_component gives %20. Surfaced by a url-encoding assertion added for #delete. Affects retrieve, retrieve_trace, delete, delete_trace, retrieve_auth_token and delete_auth_token equally. Not reachable with server-generated ids, which are hex. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This was referenced Aug 31, 2026
Merged
Merged
Merged
rferreira
added a commit
to scanii/scanii-rust
that referenced
this pull request
Aug 31, 2026
The v2.2 contract no longer marks GET /files/{id}/trace as preview
(scanii/openapi#49), and process_from_url 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 <noreply@anthropic.com>
rferreira
added a commit
to scanii/scanii-java
that referenced
this pull request
Aug 31, 2026
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: uvasoftware-skippy <30219621+uvasoftware-skippy@users.noreply.github.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
rferreira
added a commit
to scanii/scanii-dotnet
that referenced
this pull request
Aug 31, 2026
…Url (#49) 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: uvasoftware-skippy <30219621+uvasoftware-skippy@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
rferreira
added a commit
to scanii/scanii-go
that referenced
this pull request
Aug 31, 2026
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.
Godoc comments keep their "See https://scanii.github.io/openapi/v22/" links;
only the preview sentence is removed. Also drops the parenthetical from three
integration test comments.
Docs only — no signature, behavior or return-type change. No version bump;
this rides the next release.
Co-authored-by: uvasoftware-skippy <30219621+uvasoftware-skippy@users.noreply.github.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
rferreira
added a commit
to scanii/scanii-php
that referenced
this pull request
Aug 31, 2026
…Url (#143) 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 <noreply@anthropic.com>
rferreira
added a commit
to scanii/scanii-node
that referenced
this pull request
Aug 31, 2026
…Url (#9) 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 <noreply@anthropic.com>
rferreira
added a commit
to scanii/scanii-rust
that referenced
this pull request
Aug 31, 2026
The v2.2 contract no longer marks GET /files/{id}/trace as preview
(scanii/openapi#49), and process_from_url 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 <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
1 participant
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.
Two commits, separable.
1. Drop the preview marking (
e269954-equivalent, the requested change)The 2.2 highlights carried:
The endpoint has been in production since 2.2 shipped and its shape hasn't moved, so the caveat no longer reflects intent. Every SDK mirrors this wording into its README, docstrings and model classes, so the contract is the right place to fix it — the SDK cleanup follows.
Description text only. No path, schema, parameter or response changes. Verified the document still parses and both
/v2.2/files/{id}and/v2.2/files/{id}/traceretain theirgetanddeleteoperations.2. List the delete endpoints under "What's new in 2.2" (optional)
Not requested — kept as a separate commit so you can drop it independently. The highlights list mentioned the
locationparameter and the trace endpoint but never picked upDELETE /files/{id}orDELETE /files/{id}/trace, which landed later in the same version. Since I was already editing that list it seemed worth closing, but it's cleanly revertable if you'd rather keep this PR surgical.Note on the diff
The
info.descriptionis a YAML double-quoted scalar with escaped newlines and line continuations, so the raw diff is noisy. The rendered result is:Checked with a YAML parser rather than by eye, after an initial attempt where a line continuation silently ate a bullet's indentation.
Follow-on
scanii-pythonPR #3 already strips the corresponding preview language. The other 7 SDKs all carry it too and need the same sweep.