You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
fix: restore completed receipt release API mode - #881
A later API spec refresh removed the optional completed-receipt release mode introduced in #873. Restore that generated contract so typed clients can send acknowledge-completed without dropping the field.
The spec restores only the optional mode and the release response description. Regenerated the TypeScript release model and related documentation so its outbound serializer preserves the mode. Existing ordinary release requests remain valid. All three OpenAPI copies are identical and were copied from the source API generator output; no generated schema was hand-edited.
Generation: SPEAKEASY_BIN=<temporary CLI 1.799.0> pnpm run generate:platform-api. Unrelated generated SDK changes were restored as required by the SDK guidelines.
Validation: structural comparison shows only those two spec changes; git diff --check passes. All 27 existing SDK tests passed, and direct outbound serialization verifies that completion mode is retained and omitted mode stays omitted. The completed-receipt behavior was validated in #873. ALIEN-1221.
[Critical risk] Modifies the public API contract for a core release operation.
The PR appears safe to merge; no new actionable issue or outstanding previous finding remains.
Summary
The PR restores the optional completed-receipt release mode in the aligned Platform OpenAPI contracts and generated TypeScript client. The latest change adds the missing enum documentation page.
The new page resolves the link in the request documentation.
The generated request schema retains the optional mode for outbound serialization.
Diagram
%%{init: {'theme': 'neutral'}}%%
flowchart LR
A[Platform OpenAPI contract] --> B[TypeScript release request model]
A --> C[Rust OpenAPI inputs]
B --> D[Outbound release request]
B --> E[Release-mode documentation]
When a caller passes mode: "acknowledge-completed" to syncRelease, the checked-in TypeScript request type does not expose the field, and its outbound schema strips it before sending the request. The server receives an ordinary release request instead, so this contract change does not restore completed-receipt acknowledgment for users of the typed TypeScript client. Regenerate that client from the updated contract.
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
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.
A later API spec refresh removed the optional completed-receipt release mode introduced in #873. Restore that generated contract so typed clients can send
acknowledge-completedwithout dropping the field.The spec restores only the optional mode and the release response description. Regenerated the TypeScript release model and related documentation so its outbound serializer preserves the mode. Existing ordinary release requests remain valid. All three OpenAPI copies are identical and were copied from the source API generator output; no generated schema was hand-edited.
Generation:
SPEAKEASY_BIN=<temporary CLI 1.799.0> pnpm run generate:platform-api. Unrelated generated SDK changes were restored as required by the SDK guidelines.Validation: structural comparison shows only those two spec changes;
git diff --checkpasses. All 27 existing SDK tests passed, and direct outbound serialization verifies that completion mode is retained and omitted mode stays omitted. The completed-receipt behavior was validated in #873. ALIEN-1221.