Skip to content

docs(sdk): contain unrelated Platform regeneration #551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lilienblum merged 6 commits into from
Sep 10, 2026
Merged

docs(sdk): contain unrelated Platform regeneration #551

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f02ac8c
feat(sdk): expose operation schemas
lilienblum Aug 31, 2026
8dc17d4
Merge remote-tracking branch 'origin/main' into dan/alien-635-command…
lilienblum Sep 1, 2026
c7e95d5
docs(sdk): contain unrelated generator drift
lilienblum Sep 1, 2026
52a7a22
fix(sdk): preserve current Platform API contract
lilienblum Sep 1, 2026
782433f
Merge remote-tracking branch 'origin/main' into dan/alien-635-command…
lilienblum Sep 1, 2026
9041156
fix(sdk): keep generated clients reproducible
lilienblum Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions client-sdks/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,16 @@ pnpm run generate:platform-api # Regenerate platform TypeScript SDK from che

### Platform TypeScript SDK drift

Before including a platform TypeScript SDK regeneration in a feature PR,
inspect the generated diff from a clean worktree. If it rewrites endpoints or
models unrelated to the feature, keep the relevant OpenAPI and Rust inputs
produced by the supported generation pipeline and move the full TypeScript SDK
refresh to a dedicated PR. Do not manually edit or selectively patch generated
SDK code to force a smaller diff.
The supported Platform API generation pipeline copies the same contract to
`platform/openapi.json`, `platform/rust/openapi.json`, and
`platform/rust/openapi-3.0.json` before running Speakeasy.

Before including a Platform TypeScript SDK regeneration in a feature PR,
inspect the generated diff from a clean worktree. Keep generated models and
documentation caused by the feature. If Speakeasy also rewrites unrelated
endpoints or models, restore those unrelated files to their pre-generation
state and refresh them in a dedicated SDK-sync PR. Do not manually edit or
selectively patch generated SDK code to force a smaller diff.

## Don't

Expand Down
Loading