Repository navigation
docs(sdk): contain unrelated Platform regeneration - #551
Merged
Merged
Conversation
Greptile SummaryUpdates the client SDK contributor guidance to document the Platform API generation pipeline and how to isolate unrelated Speakeasy-generated drift into a dedicated SDK-sync PR.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| client-sdks/AGENTS.md | Clarifies Platform SDK generation and drift-handling guidance without changing runtime behavior. |
Reviews (5): Last reviewed commit: "fix(sdk): keep generated clients reprodu..." | Re-trigger Greptile
…s-operations # Conflicts: # client-sdks/platform/openapi.json # client-sdks/platform/rust/openapi-3.0.json # client-sdks/platform/rust/openapi.json
This was referenced Sep 2, 2026
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
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.
Adds repository guidance that keeps Platform TypeScript SDK generation reproducible and prevents unrelated Speakeasy churn from leaking into feature PRs.
The supported pipeline must first copy the same Platform OpenAPI contract into all three checked-in mirror files. Feature-owned generated models and docs stay with the feature; unrelated generator rewrites are restored and handled in a dedicated SDK-sync PR.
No generated SDK model is included here. The ALIEN-635 Platform schema is intentionally deferred until Platform and Alien have a generator-clean OpenAPI baseline; generating against mismatched mirrors would create output that the checked-in sources cannot reproduce.
Verification:
Linear: https://linear.app/alienplatform/issue/ALIEN-635/define-commands-vs-operations-and-add-typed-operation-schemas
Companion PRs: