build
build copied to clipboard
WIP: feat: add types for the open API spec methods
๐ 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:
- [ ] Open a bug/issue before writing your code ๐งโ๐ป. This ensures 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.
- [ ] Read the contribution guidelines ๐. This ensures your code follows our style guide and passes our tests.
- [ ] Update or add tests (if any source code was changed or added) ๐งช
- [ ] Update or add documentation (if features were changed or added) ๐
- [ ] Make sure the status checks below are successful โ
A picture of a cute animal (not mandatory, but encouraged)