GSoD 2020 - OpenMRS REST API Documentation

Community Google Season of Docs
341

ok then :raised_hand:

342

Hi @ayesh I saw recent changes you made to all the previous files and shortened the URL removing the refapp or demo server, will the examples still work or we will have to add a note to the user so that they can add specific server base url by themselves?

since I made the exaples to work well with the demo server thats why I included the base url of the server as well with which I had verified that particular example.

343

Hi @saurabh

Yes we have to point only the demo server not qa and demo both it’s confusing

344

@saurabh And the next thing I think it’s better if you start working on the main part of the project.

Try out options. Since we have already come in halfway I don’t think it’s good to add samples and move forward. It can be done easily with postman scripts. Let’s move on to the tryout part and make sure to have it before the end of the period.

Thanks a lot for the great and hard work done so far. Keep up the great work as always cheers

cc :- @burke @herbert24

2 Likes
345

@ayesh do you think we can pick up on a call three of us even tomorrow as you were suggesting?

346

sure I can tomorrow if it is possible for you two

1 Like
347

tommorrow 6pm EAT works for me

348

awesome it’s possible for me too

@saurabh ?

1 Like
349

sorry @ayesh I have a couple of exams this friday and saturday could you join us with the already decided call after the documentation survey . would that work for you?

1 Like
350

I prefer to have a weekly call every week. May be Monday would do. Or any-other day you prefer

351

@ayesh as burke said that we should generate as much content as possible for the static documentation and then all this content would be auto generated by merging it to swagger using edits made in javaDocs using some technical solution, so I thought I dont have to do the try out feature since swagger has an inbuilt one.

I had plans to complete the examples and description for the remaining period of GSOD. should I drop the examples and try merging swagger with the static docs?

352

Sure so here onwards lets focus on finalizing static documents. But let’s get in a call on next week. I don’t think a documentation call is a good place for project-related work. Please let us know a good time for you.

1 Like
353

sure @ayesh I am working on finalizing the static docs as much as I can, and as earlier decided by @herbert24 if you could have some time after the documentation call i.e. 8:00 PM IST we could have the call then or any time in the next week suitable to you and @herbert24.

1 Like
354

Cool . You have done a great job so far keep it up.

Sure will join on Tuesday at 8pm IST

1 Like
355

thanks @ayesh looking forward for the call :smiley:

356

I hope the time is fine for @herbert24 as well :slightly_smiling_face:

2 Likes
357

its ok with me :cowboy_hat_face:

1 Like
358

Awesome see you then

2 Likes
359

Hi @rainbow there is a redirection to the Getting started as a developer Guide here in static docs as well just let me know the url of the updated docs I will update it in this section or just Submit a PR if you like !! thanks.

capture
capture1366×416 30.8 KB

360

@ayesh @gcliff when I query the patient resource with the filtering param as gender i.e.

https://qa-refapp.openmrs.org/openmrs/ws/rest/v1/patient?gender=M&v=full I get an empty response from the server but when I query without filtering params,

https://qa-refapp.openmrs.org/openmrs/ws/rest/v1/patient?q=all&v=full I get patients with gender as “M” is there something wrong with my first request ?