search

swciitg / one-stop-2021

3 stars 13 forks source link

start API Documentation with onestop user api #133

Open heet434 opened 1 week ago

heet434 commented 1 week ago

Start API Documentation for OneStop. We will be using OpenAPI with json syntax and Swagger for automation. Create the file structure for the docs, add the basic info file, servers file, and under the 'users' tag, add the paths and schemas for oneStopUser endpoints. Here is an example: https://swc.iitg.ac.in/irbs/#introduction Refer to https://swagger.io/specification/ for details on OpenAPI structure and format.

heet434 commented 1 week ago

Note that Onestop user api, especially for verification and authentication, is used across many microservices integrated with Onestop, so it's documentation is crucial for developers working on projects within Onestop.

laladwesh commented 1 week ago

I'd like to work on this issue

heet434 commented 1 week ago

I'd like to work on this issue

alright, assigning it to you @laladwesh

heet434 commented 4 days ago

updates @laladwesh ?

Srayash commented 1 day ago

hey @heet434 can i work on this?

heet434 commented 1 day ago

hey @heet434 can i work on this?

Sure @Srayash , assigning you

Srayash commented 22 hours ago

hey @heet434 kindly review #139.