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

OpenAPI docs #7

Closed
17 tasks done
Mozzo1000 opened this issue Jul 16, 2024 · 0 comments
Closed
17 tasks done

OpenAPI docs #7

Mozzo1000 opened this issue Jul 16, 2024 · 0 comments
Labels
backend Backend related documentation Improvements or additions to documentation
Milestone

Comments

@Mozzo1000
Copy link
Owner

Mozzo1000 commented Jul 16, 2024

All API routes should be documented with the OpenAPI specification.
flasggr is a great tool for this, allowing the routes to be documented in code while also exporting an OpenAPI specification and UI.

The following routes needs to be documented:

Books

  • GET /v1/books
  • POST /v1/books
  • PATCH /v1/books/
  • DELETE /v1/books/
  • GET /v1/books//notes
  • POST /v1/books//notes

Notes

  • DELETE /v1/notes/
  • PATCH /v1/notes/

Profiles

  • GET /v1/profiles/<display_name>
  • GET /v1/profiles
  • POST /v1/profiles
  • PATCH /v1/profiles

Files

  • GET/v1/files/
  • GET/v1/files

Tasks

  • GET/v1/tasks/
  • POST /v1/tasks
  • POST /v1/tasks/retry
@Mozzo1000 Mozzo1000 added documentation Improvements or additions to documentation backend Backend related labels Jul 16, 2024
@Mozzo1000 Mozzo1000 mentioned this issue Jul 20, 2024
3 tasks
@Mozzo1000 Mozzo1000 added this to the Version 1.1 milestone Jul 22, 2024
Mozzo1000 added a commit that referenced this issue Aug 27, 2024
Mozzo1000 added a commit that referenced this issue Sep 6, 2024
Mozzo1000 added a commit that referenced this issue Sep 6, 2024
Mozzo1000 added a commit that referenced this issue Sep 6, 2024
Mozzo1000 added a commit that referenced this issue Sep 6, 2024
Mozzo1000 added a commit that referenced this issue Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Backend related documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant