GSoD 2019: Improved REST API Documentation

batbrain7 · September 12, 2019, 6:18am

Likewise @burke I am also a bit confused regarding the same.

gcliff · September 12, 2019, 6:36am

cc @burke

…thanks

ayesh · September 15, 2019, 9:43am

Hi @burke

I went through the current data model used in the openMRS in the mean time

https://docs.openmrs.org/datamodel/#

When will be possible to have a call and move forward

tendomart · September 16, 2019, 6:43am

@ayesh , @batbrain7 can you guys suggest the best times of your availability , we can arrange a call and update @burke ,it may be hard for him like he earlier indicated , and we have a deadline to meet. Tomorrow (17th , 18th and 19th are ok with me) 3-4 or 4-5pm EAT (1-2pm UTC)

@dkayiwa are you available at those times and dates so that you help out with curation i would like schedule a call on calender ?

ayesh · September 16, 2019, 7:57am

Hi @tendomart

Yes 17,18,19 days are also ok for me.But can we make it little bit later (7pm,8pm EAT).Sounds good for me

Ayesh

batbrain7 · September 16, 2019, 8:45am

Hi @tendomart

17, 18, 19 are also fine by me, but I’d also prefer the timings to be a bit late. like 8pm EAT.

Thanks

tendomart · September 16, 2019, 8:49am

Alright we’ll wait for @dkayiwa @c.antwi @jennifer @gcliff @jwnasambu @irenyak1 to see if they can join us on call , we’ll have the final date later on today.

Please Do a DOODLE POLL

burke · September 16, 2019, 12:12pm

I am in clinic tomorrow & have a conflict Wed, but could make it Thursday at 8p EAT (i.e., following the S&O call).

tendomart · September 16, 2019, 1:10pm

Alright thanks @burke noted , we’ll then go with 19th 8pm EAT

ayesh · September 18, 2019, 8:51pm

@burke , @dkayiwa , @c.antwi , @gcliff

I was doing some experiment around the slate.And modified the template a little to suite openMRS are we finally trying to achieve something like this with more description and documentation ?

https://akayeshmantha.github.io/OpenMRS-docs/#welcome

gcliff · September 19, 2019, 1:42am

Thanks @ayesh for the update and good progress

tendomart · September 19, 2019, 8:02am

Hello Team , hope all is well , just a reminder , we’ll have a call today at 8pm EAT , just after the operations call to help divide concerns between the two Tech Writers .

cc @burke @ayesh @batbrain7 @gcliff @jennifer @c.antwi

c.antwi · September 19, 2019, 9:35am

Hi @tendomart Its included in the calendar as well

batbrain7 · September 19, 2019, 4:40pm

@tendomart where is the call scheduled?

ayesh · September 19, 2019, 5:00pm

Hi @tendomart

It’s the call time if am right?

ayesh · September 19, 2019, 5:06pm

Guys are we having the call ?

@batbrain7

batbrain7 · September 19, 2019, 5:09pm

@ayesh yes we are having a call link is : https://www.uberconference.com/openmrs

burke · September 19, 2019, 5:36pm

Let’s use this Google doc for planning/brainstorming and this repo for documentation (markdown).

tendomart · September 20, 2019, 2:07pm

Thanks , @c.antwi can you please share a link to the conference recording here ?

ayesh · September 21, 2019, 1:27pm

Hi @burke , @dkayiwa , @ssmusoke

I faced a small issue when trying to execute API from the swagger UI.

curl -X GET “https://qa-refapp.openmrs.org/openmrs/ws/rest/v1/app?limit=1&startIndex=2&v=full” -H “accept: application/json”

is this endpoint open? Means can we execute them without basic auth header?. Because without the header I was able to get results.

I can see in the swagger response codes it has user not logged in not authorized code as well.And in the wiki it says all endpoints except /session endpoints are secured.