[Documentation]: Fix API documentation

[Jesulayomy]

Some routes in the API Documentation aren't properly setup (especially POST and PUT requests), if you have some experience writing flasgger documentation you can help with this. There are several files for all routes and you should address at least two files (or 1 folder, whichever is more) for a PR to be valid.

This Issue will act as a central control for the API routes. Please create your own issue with the title: "[API docs]: <files / folder to be addressed>" so I can assign it to you. If there is need for an API view itself to be changed please let me know too.

• [ ] Views

• [ ] admin

• [ ] admins

• [ ] course

• [ ] courses

• [ ] course_teacher

• [ ] department

• [ ] departments

• [ ] department_students

• [ ] student

• [ ] students

• [ ] student_courses

• [x] teacher

• [x] teachers

• [ ] teacher_courses

• [ ] Auths

• [ ] login

• [ ] logout

• [ ] auth_status

• [ ] verify-recovery

[pardeep-singh]

Hey @Jesulayomy I want to contribute to this. I have created 4 issues to handle docs for 4 different documentation folders:

• https://github.com/Jesulayomy/SCHub/issues/11
• https://github.com/Jesulayomy/SCHub/issues/12
• https://github.com/Jesulayomy/SCHub/issues/13
• https://github.com/Jesulayomy/SCHub/issues/14

Can you please assign these to me?

[Jesulayomy]

Okay, on it so you can get started, please make sure to test that it works too once you're done ⭐️

[Jesulayomy]

@pardeep-singh create your fork and when done, PR to the hacktoberfest branch