WIP: feat: add types for the open API spec methods #5308
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.
🎉 Thanks for submitting a pull request! 🎉
Summary
Fixes #5307
I've taken a look at the ecosystem. There are some libraries that are responsible for generating OpenAPI types but sadly, they are not compatible with how we built and designed our API. If we want to make this a nonbreaking change without having the users update all usages, we have to write our own generation, sadly.
As we have a unique way of how parameters are converted into function parameters, this is crucial. IMHO, we should aim NOT to break the API surface as this library is so widely used in all places.
Therefore I've started writing our custom implementation for it. It's still super WIP.
For us to review and ship your PR efficiently, please perform the following steps:
we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or
something that`s on fire 🔥 (e.g. incident related), you can skip this step.
your code follows our style guide and passes our tests.
A picture of a cute animal (not mandatory, but encouraged)