search

Jesulayomy / SCHub

SCHub v0.1, A school data management system to allow School administration, Teachers manage students and courses data.
https://schub.jesulayomi.tech
MIT License
3 stars 10 forks source link

[API Docs]: admins docs #11

Open pardeep-singh opened 1 month ago

pardeep-singh commented 1 month ago

I want to contribute by updating docs for documentation/admins APIs

pardeep-singh commented 1 month ago

@Jesulayomy Updated /admins APIs doc in this PR: https://github.com/Jesulayomy/SCHub/pull/15

Can you please take a look at this? Also, can you please provide instructions on running the Swagger API Docs UI Locally?

Jesulayomy commented 1 month ago

Hi, I took a look at it and can see improvements, thanks! There are some things unhandled though, like PUT and POST requests which I think are the main features that aren't working. PUT requests should receive input data (It currently shows 415 un-supported media type since no request body is sent (should get an application/json body). So if you can handle these I can merge it, you can text me on discord too if you need anything since I can respond faster.

I have only run the API docs through the flask app, so the installation process in the README should suffice (skip the react installation)

pardeep-singh commented 1 month ago

@Jesulayomy Updated the PR with docs for other methods as well. Can you please check the updated changes?