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

Update API docs to use OAS 3 #2268

Open
DefiDebauchery opened this issue Oct 18, 2024 · 1 comment · May be fixed by #2280
Open

Update API docs to use OAS 3 #2268

DefiDebauchery opened this issue Oct 18, 2024 · 1 comment · May be fixed by #2280
Assignees
Labels
enhancement New feature or request

Comments

@DefiDebauchery
Copy link

The Transaction Service's Swagger docs currently use v2 of the OpenAPI Specification, which doesn't work with some of the modern generative tools that only target OAS3. Upgrading will make the API easier to work with for local code generation (querystring filter classes, etc).

@DefiDebauchery DefiDebauchery added the enhancement New feature or request label Oct 18, 2024
@Uxio0
Copy link
Member

Uxio0 commented Oct 21, 2024

Thanks for the suggestion. It seems that we will have to migrate our dependency drf-yasg: https://drf-yasg.readthedocs.io/en/stable/readme.html#openapi-3-0-note

@moisses89 moisses89 linked a pull request Oct 24, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@Uxio0 @moisses89 @DefiDebauchery and others