Creating the API documentation for ScholarX platform

The requirement of this ScholarX API documentation is to describe in detail what each call in our API does, each parameter, and all of their possible values, including their types so that I’ll help for frontend and backend developers know how to work with the APIs and how to get started.

This document will be delivered by 2020-08-15T18:30:00Z.

1 Like

Hi @anjisvj!
Thanks for creating the thread. Could you please edit it with describing the requirement, deliverables, and the key deadlines?

1 Like

Hi @jaye ! sure I will edit this.

As we discussed yesterday with @Gravewalker @jaye @piumal1999 @Gimhan_minion . We decided to use Postman API documentation feature for our purpose and we started creating draft endpoints according to the roles of the users.
This is the doc for APIs and this is the current version of the postman documentation.


This is impressive @anjisvj! :heart_eyes: Thanks for getting this done!! :hugs:

@YohanAvishke @shyamal @Gravewalker @piumal1999 could you please review it?


Thanks guys. all good except below two points

  1. admin APIs.

you would’t need to separate them as /admin/

instead gateway service should intercept the request and for certain APIs (configured to authenticated) should use auth/bearer token comes with the request (to query auth service to check ) authorization to the given action/resource path.

  1. use schemas to build powerful restful apis.

happy coding.!


Hi @shyamal thanks a lot for the awesome suggestion :heart_eyes: Shall we have a call to clarify this,

  • Tue, 18th July 19:00 IST
  • Wed, 19th July 19:00 IST
  • Thu, 20th July 19:00 IST
  • Fri, 21th July 19:00 IST

0 voters

@shyamal, @jaye or anyone else who want to join, please let me know if you are busy with all of the above options.

1 Like

Thanks @YohanAvishke voted for few options


Thanks all for voting. Let’s have the meeting 2020-08-18T13:30:00Z.
If anyone else want to join :

1 Like

Playing the devil’s advocate: Have we looked at GraphQL?

1 Like

Herd it for the first time! That seems interesting!! :heart_eyes: Thanks @akshika47!

btw, @YohanAvishke @piumal1999 How’s the progress of API development and choosing a gateway?

Hi I was unavailable from since 24th.
However I have updated the milestone with Admin APIs:

@piumal1999 let me know of your availability I will assign some issues.

@anjisvj why are there 2 endpoints to get programs(Admin and Custom). Can we use the custom API for both cases?

Let’s have the follow up call tomorrow for the gateway discussion will create a poll for this.

1 Like

We need to discuss further the available solutions for the Gateway. And I will explain how the Spring boot OAuth handles tokens from other providers.
@shyamal, @jaye, and others please vote for your availability.

  • Fri, 28 Aug 18:00 IST
  • Fri, 28 Aug 19:00 IST
  • Fri, 28 Aug 20:00 IST

0 voters

Im available on the weekends. I can start working on the APIs. @YohanAvishke

1 Like

Thanks all for voting. Let’s have the meeting 2020-08-28T13:30:00Z.
If anyone else wants to join :

Hi, I will be not able to join at 7 pm because I have another call from 6:30 pm to 7:30 pm. I will try to join early as possible if I get a chance to leave from that call, but don’t wait for me. :hugs:

1 Like

Also there are two APIs to get mentors of a given program. Do those give the same output? Or do we have to filter according to the user?

Hi, I checked the Postman API documentation and I’d like to clarify certain stuff. Hope to discuss in the call this week.

PS: Sorry for the late comment. Was busy with my thesis.


In this endpoint, the user applies to join a program? or to apply for a mentor?
Can users apply as mentees for a program without selecting a mentor?