Skip to content

feat!: adopt TS generator changes - #1896

Open
szuperaz wants to merge 4 commits into
release-v10from
open-api-latest-generator-changes
Open

szuperaz wants to merge 4 commits into
release-v10from
open-api-latest-generator-changes

Conversation

@szuperaz

@szuperaz szuperaz commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Breaking changes

  • API calls that contained path params changed their signature: path params are now in a separate object. Several API calls are affected; the migration guides in the repo have the full list of affected methods
  • With this change some hand-written wrapper types were changed/removed; these are also part of the migration guide.
  • All API calls that don't have query/body params got a placeholder request param to avoid future changes.

https://linear.app/stream/issue/REACT-1189/reduce-bundle-size-change-api-signature
https://linear.app/stream/issue/REACT-1205/ts-generator-avoid-potential-breaking-change-when-using-with-request

Description of the changes, What, Why and How?

  • Previously all path, query and body params were merged into a single object and all api calls had this merged param. With a TS generator update we can split path params into a separate object, and query + body params into another param. This change saves bundle size. The biggest consequence is that query/body params now sent API as-is, before only known parameters were sent.
  • Half-related fix: ReminderPaginator sent wrong key for pagination, this is now fixed
  • We added request options to API calls to allow canceling API requests. Since requestOptions should always be the last param of an API call, we can cause a breaking change if an API call that doesn't have query/body params today, gets new params because that would shift requestOptions arg position. To fix this issue we add a placeholder param to all API calls:
// before
client.getApp({signal: ''})

// after
client.getApp(undefined, {signal: ''})
// if getApp gets any new query/body params, it's ok, we won't have a breaking change

@szuperaz szuperaz changed the title feat!: TS generator changes feat!: adopt TS generator changes Oct 2, 2026
@szuperaz
szuperaz marked this pull request as ready for review October 2, 2026 19:22
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