Repository navigation
feat!: simplify Speakeasy TypeScript SDK arguments - #965
Merged
Merged
Conversation
|
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.
SDK methods with request bodies currently require nested operation objects, such as
createDeploymentGroupToken({ id, createDeploymentGroupTokenRequest: body }). GeneratecreateToken(id, body)and apply the same argument convention across both Speakeasy TypeScript SDKs.(parameter, body). Larger requests and query-only operations retain named request objects.Validation: the full
pnpm test:tscheck passes (19 tasks), all 180 core tests pass, both generated SDK builds pass, and all 33 SDK request/response tests pass, including encoded IDs, workspace selection, Date serialization, standalone functions, optional request headers, and structured errors. Generator scripts passbash -n;git diff --checkpasses.Generated with
pnpm run generate:platform-api(Speakeasy 1.799.0) andpnpm run generate:manager-api(Speakeasy 1.680.11). The first Platform generation reached its test step before the old callers were migrated; the migrated combined suite subsequently passed.The standalone example remains on its existing published SDK; its migration must ship with the new major release. Unrelated generated documentation changes were restored to avoid incorrect argument tables for unchanged methods.