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

chore: Use utoipa to generate open-api schemas from the code #2203

Open
1 task
squadgazzz opened this issue Dec 21, 2023 · 3 comments · May be fixed by #2668
Open
1 task

chore: Use utoipa to generate open-api schemas from the code #2203

squadgazzz opened this issue Dec 21, 2023 · 3 comments · May be fixed by #2668
Assignees
Labels
E:3.4 Self-documenting Rest APIs See https://github.com/cowprotocol/pm/issues/23 for details help wanted Extra attention is needed

Comments

@squadgazzz
Copy link
Contributor

Background

Currently, the OpenAPI documentation is maintained manually with openapi.yml. This approach requires regular manual updates to ensure the API documentation stays in sync with the codebase, which is time-consuming and prone to human error.

Proposal

Migrating to utoipa for automatic generation of OpenAPI documentation directly from our code.

Acceptance criteria

  • OpenAPI files are generated automatically and e2e tests pass
@squadgazzz squadgazzz self-assigned this Dec 21, 2023
@mfw78 mfw78 added the E:3.4 Self-documenting Rest APIs See https://github.com/cowprotocol/pm/issues/23 for details label Dec 22, 2023
@squadgazzz
Copy link
Contributor Author

Discussion: cowprotocol/pm#23

@fleupold fleupold added the help wanted Extra attention is needed label Jan 17, 2024
@fleupold
Copy link
Contributor

@Flugplatz
Copy link

@fleupold I've raised an inital PR here for discussion: #2338

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E:3.4 Self-documenting Rest APIs See https://github.com/cowprotocol/pm/issues/23 for details help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants