search

CS3219-AY2425S1 / cs3219-ay2425s1-project-g20

nus-cs3219-ay2425s1-cs3219-ay2425s1-project-project-template created by GitHub Classroom
MIT License
2 stars 1 forks source link

Update question docs with API specifics #46

Closed Cloud7050 closed 4 days ago

Cloud7050 commented 1 week ago

In the question README, list out each route and details like its expected request body and what the values mean, user/admin authentication requirements, and expected responses. Akin to the docs for user service.

Cloud7050 commented 1 week ago

See also #26

For technical document, we may be proceeding with markdown to keep everything in one place and reuse the existing docs we have in the README files.

Then for final submission, if they want the technical doc, we could look into exporting the markdown to PDF etc.

Cloud7050 commented 4 days ago

Subsumed under #26. #67 works towards this a bit.