Skip to content

Commit

Permalink
Merge pull request #35 from openmrs/purposeDocument
Browse files Browse the repository at this point in the history
Add the purpose section
  • Loading branch information
bmamlin committed Nov 27, 2019
2 parents 58b166c + fbca1c6 commit b91bba4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions source/includes/info.md
Expand Up @@ -27,6 +27,12 @@ from openMRS
[swagger documentation](https://demo.openmrs.org/openmrs/module/webservices/rest/apiDocs.htm) on the demo
server (username **admin**, password **Admin123**).

# Purpose

* The purpose of this documentation is to provide a brief and good taste and experience of the APIs that are used in OpenMRS community to the new developers so that can onboard in the projects within the org easily.

* The documentation also aims to assist the existing developers to get to know the conceptual context of the APIs and how they help the consumers during the interaction in the real world.

# Schema

All API access is over HTTPS, and can be accessed from `https://demo.openmrs.org/openmrs/ws/rest/v1`. All data is sent and received as JSON.
Expand Down

0 comments on commit b91bba4

Please sign in to comment.