Skip to content

fix: restore completed receipt release API mode - #881

Merged
alongubkin merged 3 commits into
mainfrom
alon/alien-1221-restore-release-mode
Oct 5, 2026
Merged

alongubkin merged 3 commits into
mainfrom
alon/alien-1221-restore-release-mode

Conversation

@alongubkin

@alongubkin alongubkin commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

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.

@alongubkin

Copy link
Copy Markdown
Member Author

@greptileai review

@greptile-apps

greptile-apps Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[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]
Loading

Reviews (3) · Last reviewed commit: "docs: include generated release mode ref..."

@greptile-apps

greptile-apps Bot commented Oct 5, 2026

Copy link
Copy Markdown

Comments Outside Diff

These findings could not be posted inline.

  • P1 TypeScript client drops release mode client-sdks/platform/openapi.json:1 ▶

    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.

@alongubkin

Copy link
Copy Markdown
Member Author

@greptileai review

Comment thread client-sdks/platform/typescript/docs/models/syncreleaserequest.md
@alongubkin

Copy link
Copy Markdown
Member Author

@greptileai review

@alongubkin
alongubkin merged commit 3d430de into main Oct 5, 2026
21 checks passed
@alongubkin
alongubkin deleted the alon/alien-1221-restore-release-mode branch October 5, 2026 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant