Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: feat: add types for the open API spec methods #5308

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lukasholzer
Copy link
Contributor

@lukasholzer lukasholzer commented Oct 2, 2023

πŸŽ‰ 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)

@lukasholzer lukasholzer self-assigned this Oct 2, 2023
@github-actions github-actions bot added the stale label Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create types for the OpenAPI specification based on the swagger.json
1 participant