GSoD 2019: Improved REST API Documentation

Tags: #<Tag:0x00007fddec7537b8>

@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 ?

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

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

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

1 Like

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

1 Like

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

2 Likes

@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

1 Like

Thanks @ayesh for the update and good progress :+1:

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

2 Likes

Hi @tendomart Its included in the calendar as well

@tendomart where is the call scheduled?

Hi @tendomart

It’s the call time if am right?

Guys are we having the call ?

@batbrain7

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

1 Like

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

3 Likes

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

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.

Hi @burke , @dkayiwa , @ssmusoke , @mozzy

I am trying to get an idea about the encounters as far as I know when a patient visits a health center or hospital. For each electronic form completed for a patient, a new encounter is created.

And encounters can be of two types

  1. Location encounters
  2. Patient encounters

To find out the encounter belongs to a specific patient if am right I should send a get request to like below with the uuid of the patient.

curl -X GET \
  'https://demo.openmrs.org/openmrs/ws/rest/v1/encounter/fc6ee64e-9f64-4213-8716-ae0ba93bb71d/encounterprovider?limit=1&startIndex=0&v=full' \
  -H 'Authorization: Basic YWRtaW46QWRtaW4xMjM=' 

But am receiving an error message like below. Any idea about it

https://pastebin.com/8Q4MVV9R

Are these resources of help?

https://guide.openmrs.org/en/Getting%20Started/openmrs-information-model.html

2 Likes

Hi @dkayiwa

Thank you this will help alot :slightly_smiling_face: