GSoD 2019: Improved REST API Documentation

Community Google Season of Docs
102

https://demo.openmrs.org/openmrs/module/webservices/rest/apiDocs.htm

this link is returning a 404 error code for me, it is a major blocker, could any one assist me in this ?

103

I cannot access the share google doc, could you put my email ; kumar.mohit983■■■■■■■■■■ to give me the access

104

cc @burke kindly help out here

Thanks

105

am failing to access the demo server to,could it be down ? @dkayiwa

106

Reset the demo server by running this plan: https://ci.openmrs.org/browse/OENV-RD/latest

107

i have the command the command in the browser and its showing “Build:#1182 was successful Manual run by Daniel Kayiwa”

i clicked on reset demo server and its saying ‘No builds are currently running.’

108

Oh sorry about it! @dkayiwa can help

109

@batbrain7

You can use :- https://qa-refapp.openmrs.org/openmrs/login.htm till the demo server is up

User name :- admin Pwd :- Admin123

110

@gcliff @jwnasambu

To run the plan we need to have a bamboo account which you can request :slightly_smiling_face:

111

@ayesh It giving an error and this is the error log https://pastebin.com/rLDQjH2h. I have a bamboo account and when I follow the link it shows the server is up which is contrary to the output.

112

@ayesh , @gcliff and @batbrain7 finally the demo server is up.

2 Likes
113

Nice work @jwnasambu :slightly_smiling_face:

114

thanks @jwnasambu

115

@burke

I created the PR for slate integration.We have to add a new token generated for openmrs organization to travis project settings as an env variable.I created the travis.yml and tested out that in my local version it works fine.

116

It appears that someone had accidentally restricted the entire OpenMRS Public) folder to only Taiwo Adedeji, Vusumuzi Khoza, and people with OpenMRS accounts. I’ve corrected this, so you should have access again.

Excellent, @ayesh. I’ll get this merged and make a token.

1 Like
117

Thank you @burke

118

@burke @dkayiwa @gcliff @jwnasambu @tendomart

Hi all

I wanted to give a quick update on how the upcoming few weeks we will allocate our time slots on work.

We have these work left on our way

Users : todo (batbrain) Person :- done (batbrain) Patient :- done (batbrain) Visits :- done (ayesh) Encounters :- done (ayesh) Providers :- done (ayesh) Locations :- done (ayesh) Observations :- todo (batbrain) Orders : - todo (batbrain) Concepts :- todo (ayesh) Forms :- todo (ayesh)

We will target 14th latest to finish on object types :-

I am sure with my mate @batbrain7 who is doing a brilliant job currently we will be able to achieve the target.

Then from 14th -22nd We will target the overview doc section descriptive section. We already have an idea which @burke approved and praposed. which will look like below and most of the sections are already covered by me and @batbrain7

Outline

  1. Purpose of REST API
  2. Getting Started
  3. Authentication
  • How to authenticate
  1. Common Tasks
  • Get a patient
  • Get encounters & observations for a patient
  • Add an observation

  1. Overview

  2. Current version

  3. Resources

  4. Subresources

  5. Resources with Subtypes

  6. Common parameters

  7. Representations

  • Schema

    1. JSON
    2. XML

  • Pagination

  • Timezones

  • FHIR

    1. Status of FHIR support, relationship to REST API, where to learn more

  • Troubleshooting

    1. Common mistakes
    2. Where to go for help
1 Like
119

@ayesh thanks for the update we trust that you two will hit the target.

120

@ayesh Noted thanks.

121

@burke

Can we create the oauth token for Travis.And make the site up.

Hopefully will be able to get some feedback then :smiley:

I added the latest docs merged to master also to slate includes folder and did the modifications.