GSoD 2020 - OpenMRS REST API Documentation

suthagar23 · June 10, 2020, 12:46am

@saurabh We had this resource in openmrs-1.8 as SystemInformation resource, which is directly fetching the system information from AdministrationService.

github.com

openmrs/openmrs-module-webservices.rest/blob/6299dc6e3b185deb0c45bf1afac562d9a7843f96/omod-1.8/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_8/SystemInformationResource1_8.java

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.module.webservices.rest.web.v1_0.resource.openmrs1_8;

import org.openmrs.api.impl.AdministrationServiceImpl;
import org.openmrs.api.context.Context;
import org.openmrs.module.webservices.rest.SimpleObject;
import org.openmrs.module.webservices.rest.web.ConversionUtil;
import org.openmrs.module.webservices.rest.web.RequestContext;
import org.openmrs.module.webservices.rest.web.RestConstants;
import org.openmrs.module.webservices.rest.web.annotation.Resource;
import org.openmrs.module.webservices.rest.web.resource.api.Listable;
import org.openmrs.module.webservices.rest.web.response.ResponseException;

This file has been truncated. show original

We refactored the Swagger documentation in early 2019 and it seems like this resource didn’t get updated with that change. That’s why we can’t get it over our Swagger documentation.

saurabh · June 10, 2020, 6:53am

thanks @suthagar23 for your reply

saurabh · June 10, 2020, 6:54pm

@ayesh I tested this endpoint /systeminformation for a GET request and it works so should I add this to the documentation as well along with small description of the “SystemInformation” that you suggested??

and @suthagar23 as far as I can infer from the code snippet you shared this resource just supports only one operation that is getAll , am I missing something ??

ayesh · June 11, 2020, 8:21am

@saurabh yes please go ahead.

And yes it supports one endpoint.Thats normal isnt it .

saurabh · June 12, 2020, 8:45am

@ayesh I have made a couple of more PRs please review them.

ayesh · June 12, 2020, 9:04am

nice sure will do

ayesh · June 12, 2020, 9:08am

@saurabh

Can you start working on the Java Samples now. I see that as a good thing to do at this moment.

saurabh · June 12, 2020, 9:17am

@ayesh sure I would first setup the SDK and then start working on this

saurabh · June 12, 2020, 9:19am

I will just be a bit irregular due to my end sems right now (they got delayed due to covid ), but I will continue working

ayesh · June 12, 2020, 9:21am

@saurabh @rainbow

thanks alot for the great work done so far . Appreciates alot.

Sure no worries take you’re time. I would prefer you to use the demo server I think you don’t need sdk setup.

rainbow · June 12, 2020, 2:55pm

@ayesh I have java code for Base64 authorization. It is in plain java. If you think it is usable. I can make a pr. I was trying to use openmrs SDK to build an OWA to make REST API requests, but I am have some difficulty.

ayesh · June 12, 2020, 11:06pm

so I think you got the idea wrong here.

We need java client samples calling the rest api we have not sdk samples. Here we are building a documentation web site not code playground so no sdk code it’s about simple java get post request froma client to the rest api

rainbow · June 13, 2020, 12:05am

Thanks, good to know.

saurabh · June 13, 2020, 2:42pm

@ayesh should we add proper curl examples as well since they can be easily derived fromt the current http calls and they are pretty easy to run for anyone straight from the command prompt ??

and as a part of testing the previous examples I have tested several of them uptill now so will it be useful to add them along the language tabs ?

ayesh · June 13, 2020, 3:37pm

@saurabh what do u mean by proper curl examples?

So if you look in most of the documentation of current opensource products they have documented the curl calls as we have in the examples. It’s a language-agnostic way of defining the endpoint for developers to understand.

I don’t see a need to change them to curl examples for now. The best would be to continue and achieve the same examples in java in the new tab that you are working currently.

saurabh · June 13, 2020, 3:41pm

okay @ayesh I would do that

saurabh · June 14, 2020, 7:58pm

@ayesh will it be good to add some code stubs that we removed from the examples here in this getting started section?? with some comments maybe.

ayesh · June 14, 2020, 8:09pm

Yes that would be cool

Please have a look on the new http samples. The new font color is not that clear it seems. Will it be possible to fix it first ?

saurabh · June 14, 2020, 9:02pm

yes @ayesh I was actually looking for a fix for its font color or ,even http console fix I will make a PR when that gets fixed first !!

saurabh · June 14, 2020, 10:13pm

actually @ayesh I looked up the languages that rouge supports that is eventually slate supports and I got that I should be using shell instead of http

it looks better I think , I will make a PR after you review.

shell