Elaborate Documentation for API Endpoints

[devansh-shah-11]

Description

Write a detailed description for each endpoint (what are the inputs it expects, what does it do and what is the expected output, how are the various scenarios handled etc

Benefits

This will cover all the API endpoints and thus, will be easier for the frontend team to modify their code accordingly and will ensure proper readability, even in the future

[AnleaMJ]

Hello @devansh-shah-11. Are you a gssoc PA? I'd love to contribute. Please add the appropriate gssoc-ext labels and assign it to me.

[Devasy23]

sure, @AnleaMJ assigned it to you, good-luck

[anchalchaturvedi08]

Hello PA, I would like to work on this task. can you assign it to me?

[devansh-shah-11]

@anchalchaturvedi08 assigned you the task

[anchalchaturvedi08]

hi @devansh-shah-11
Could you please clarify whether I need to create a new file for API documentation?

[Devasy23]

@anchalchaturvedi08 yes that would be better and give reference of it in readme

[anchalchaturvedi08]

@Devasy23 I have updated the files and added the API documentation. Please review it