You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2016/12/02 18:54:40 UTC

usergrid-qakka git commit: Link to interactive display of REST API docs via the swagger.io Swagger UI setup.

Repository: usergrid-qakka
Updated Branches:
  refs/heads/master 12bcd64da -> 2f855a341


Link to interactive display of REST API docs via the swagger.io Swagger UI setup.


Project: http://git-wip-us.apache.org/repos/asf/usergrid-qakka/repo
Commit: http://git-wip-us.apache.org/repos/asf/usergrid-qakka/commit/2f855a34
Tree: http://git-wip-us.apache.org/repos/asf/usergrid-qakka/tree/2f855a34
Diff: http://git-wip-us.apache.org/repos/asf/usergrid-qakka/diff/2f855a34

Branch: refs/heads/master
Commit: 2f855a3413e4f70ac7c29aea1ffd2b6565dd95a3
Parents: 12bcd64
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Dec 2 13:54:30 2016 -0500
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Dec 2 13:54:30 2016 -0500

----------------------------------------------------------------------
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/usergrid-qakka/blob/2f855a34/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 57e5c81..135b8c5 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,13 @@ You can learn more about Qakka internals by reading this [Google Slides presenta
 Qakka was developed as for this JIRA Issue: [USERGRID-1318](https://issues.apache.org/jira/browse/USERGRID-1318).
 
 
+## How to use Qakka
+
+We don't have any examples of Qakka REST API use yet, but we do have Swagger generated docs:
+
+* [Qakka REST API docs](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/apache/usergrid-qakka/master/docs/swagger.json)
+
+
 ## How to build Qakka
 
 Qakka is unreleased software and if you want to use it, you will have to built it. Here are the steps to build Qakka: