GSoC


The goal of my project is to improve the living documentation of the OpenMRS REST API through improvements to how its Swagger Specification is generated. All my code goes in webservices.rest module. Commits Made to the Module github.com/openmrs/openmrs-module-webservices.rest/commits/master?author=gayanW   My GSoC Issues for the Summer RESTWS-560 – Create API Overview […]

GSoC 2017 – Improved REST API Documentation Project


Today I thought of giving a brief overview on some of my issues and how I’ve been tackling them. I’ll try describe each issue in simple terms and workarounds we’ve taken to solve them. RESTWS-560 – Create API Overview Docs The issue suggests that we add an overview (ie: description) […]

My GSoC Issues for the Summer


Here ends the second evaluation. I’m pleased to announce that I passed! The positive feedback received from Shreyans, my mentor, as always is very encouraging. To sum up my work for the week: Start working on RESTWS-560 – Create API Overview Docs Ready for Work Open Issue: LUI-126 Avoid universal […]

GSoC with OpenMRS – 2nd Evaluation Update



The second phase of Google summer of code evaluation is here!. The submission deadline due this coming Friday. So I have about two more issues to go. RESTWS-560 – Create API Overview Docs RESTWS-568 – Optimize Swagger Spec Creation I and my mentor have a discussion and it was decided […]

GSoC with OpenMRS – Week #8


We are getting closer to the end of the second work period. I think it’s time to give an update on my overall progress of the project. These are the list of issues that is being assigned to me, and I’m responsible for getting them done. Objectives Improve documentation RESTWS-560 […]

GSoC Progress Update


This guide focuses on creating a Swagger Spec by use of swagger-core which is one of the popular Java libraries for consuming and generating swagger specifications. However the typical means for generating the spec is by use of annotations. But the focus here is to create a spec directly by […]

Generating a Swagger Spec



OpenMRS REST Swagger Doc
This guide is for my own reference and for those who unfamilar with OpenMRS Swagger Spac and for he who is a starter yet willing to contribute to the spec. First to see the interactive api in action one could visit either one of the following urls https://qa-refapp.openmrs.org/openmrs/module/webservices/rest/apiDocs.htm https://demo.openmrs.org/openmrs/module/webservices/rest/apiDocs.htm (or […]

OpenMRS webservices.rest – Swagger Spec


Here ends the third week. My focus this week is to work on the task RESTWS-562 – To Improve Resource Definition Documentation I’ll try explain RESTWS-562 in brief. Swagger Doc (aka Spec, or just Swagger Json) of OpenMRS is generated programmatically. Typically Swagger Spec of an API is generated just […]

Third Week of Coding – GSoc with OpenMRS


Swagger Specification (aka OpenAPI Specification) is a way of defining and describing an RESTFul APIs. It provides means to compose components of an API, its endpoints, operations on those endpoints, return types of those operations in a plain text format into a single text file which is machine readable and […]

Converting Java Types to Swagger Types



It’s being quite a journey with RESTWS-562 which is about improving the resource definitions of the swagger spec. Despite the changes to the SwaggerSpecificationCreator which holds the main logic for generating the swagger json, I had to introduce three new methods to which all resource classs should override. They are […]

Here comes the 6th week