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.

Sign up for GitHub

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

Jump to bottom

Migrate API to use OpenAPI/Swagger #42

Closed
hwgilbert16 opened this issue Jul 27, 2023 · 2 comments
Closed

Migrate API to use OpenAPI/Swagger #42

hwgilbert16 opened this issue Jul 27, 2023 · 2 comments
Labels
upcoming feature This feature has been accepted and will be worked on

Comments

@hwgilbert16
Copy link
Owner

In hindsight, this should have been done from the beginning, but this can be moved over now. The API should ideally use the OpenAPI specification, especially considering the plan to publicize the API in #7.
@hwgilbert16 hwgilbert16 added the upcoming feature This feature has been accepted and will be worked on label Jul 27, 2023
@hwgilbert16 hwgilbert16 modified the milestone: v1.0.6 Jul 27, 2023
@hwgilbert16
Copy link
Owner Author

hwgilbert16 commented Aug 7, 2023 •
edited
Loading

Checklist:

  • Change API fail to responses to include more data than purely the HTTP code - custom errors?
  • Annotate all objects with proper descriptions
  • Change PUT methods to use PATCH
  • Add all user routes

@hwgilbert16
Copy link
Owner Author

Completed in v1.0.7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
upcoming feature This feature has been accepted and will be worked on
Projects
Scholarsome Development
Status: Done
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hwgilbert16