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 2015/07/30 19:18:15 UTC
[1/3] incubator-usergrid git commit: Adding REST End-point and Entity
tables in tab-delimited text files and a Groovy script that turns them into
Markdown with HTML tables.
Repository: incubator-usergrid
Updated Branches:
refs/heads/ug2-doc-update 080f911cd -> 169c2e2a4
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/activities.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/activities.md b/docs/rest-endpoints/activities.md
new file mode 100644
index 0000000..021406e
--- /dev/null
+++ b/docs/rest-endpoints/activities.md
@@ -0,0 +1,26 @@
+# activities
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Content-type</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users/ {uuid|username}/activities</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create an activity</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/groups/ {uuid|groupname}/activities</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Post an activity to a group</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/admin-users.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/admin-users.md b/docs/rest-endpoints/admin-users.md
new file mode 100644
index 0000000..3421170
--- /dev/null
+++ b/docs/rest-endpoints/admin-users.md
@@ -0,0 +1,75 @@
+# admin-users
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Content-type</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/management/users</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create an admin user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/users/{user|username|email|uuid}</td>
+ <td>PUT</td>
+ <td>application/json</td>
+ <td>Update an admin user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/users/{user|username|email|uuid}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get an admin user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/users/{user|username|email|uuid}/ password</td>
+ <td>PUT</td>
+ <td>application/json</td>
+ <td>Set an admin user's password</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/managementusers/resetpw</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Initiate the reset of an admin user's password</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/users/resetpw</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Complete the reset of an admin user's password</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/users/{user|username|email|uuid}/activate? token={token}&confirm={confirm_email}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Activate an admin user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/users/{user|username|email|uuid}/reactivate</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Reactivate an admin user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/users/{user|username|email|uuid}/feed</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get an admin user's feed</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/collections.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/collections.md b/docs/rest-endpoints/collections.md
new file mode 100644
index 0000000..a3b9c0b
--- /dev/null
+++ b/docs/rest-endpoints/collections.md
@@ -0,0 +1,82 @@
+# collections
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Content-type</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Retrieve all collections</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create a new entity or collection</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/ {uuid|name}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Retrieve an entity</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/ {uuid|name}</td>
+ <td>PUT</td>
+ <td>application/json</td>
+ <td>Update an entity</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/ {uuid|name}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Delete an entity</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}?{query}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Query a collection</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}?{query}</td>
+ <td>PUT</td>
+ <td>application/json</td>
+ <td>Update a collection by query</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/{entity_id}/ {relationship}?{query}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Query an entity's collections or connections</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id}</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Add an entity to a collection or create a connection</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Remove an entity from a collection or delete a connection</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/events.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/events.md b/docs/rest-endpoints/events.md
new file mode 100644
index 0000000..d3cac47
--- /dev/null
+++ b/docs/rest-endpoints/events.md
@@ -0,0 +1,19 @@
+# events
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Content-type</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/events</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create an event</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/groups.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/groups.md b/docs/rest-endpoints/groups.md
new file mode 100644
index 0000000..0940ee9
--- /dev/null
+++ b/docs/rest-endpoints/groups.md
@@ -0,0 +1,54 @@
+# groups
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Content-type</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/groups</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create a new group</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username}</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Add a user to a group</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/groups/ {uuid|groupname}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get a group</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}{app_id}/groups/ {uuid|groupname}</td>
+ <td>PUT</td>
+ <td>application/json</td>
+ <td>Update a group</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Delete user from a group</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/groups/ {uuid|groupname}/feed</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get a group's feed</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/organizations.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/organizations.md b/docs/rest-endpoints/organizations.md
new file mode 100644
index 0000000..75e50c5
--- /dev/null
+++ b/docs/rest-endpoints/organizations.md
@@ -0,0 +1,109 @@
+# organizations
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create an organization</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Retrieve an organization</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ activate?token={token}&confirm={confirm_email}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Activate an organization</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ reactivate</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Reactivate an organization</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ credentials</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Generate organization client credentials</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ credentials</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Retrieve organization client credentials</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ feed</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Retrieve an organization's activity feed</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{org_uuid}/ apps</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create an organization application</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ applications|apps/{app_name}|{uuid}/ credentials</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Generate credentials for an organization application</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ applications|apps/ {app_name}|{uuid}/credentials</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get credentials for an organization application</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{uuid}/ applications|apps</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get the applications in an organization</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{org_uuid}/ users/{username|email|uuid}</td>
+ <td>PUT</td>
+ <td>application/json</td>
+ <td>Adding an admin user to an organization</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{org_uuid}/ users</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Getting the admin users in an organization</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/management/organizations|orgs/{org_name}|{org_uuid}/ users/{username|email|uuid}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Removing an admin user from an organization</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/roles.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/roles.md b/docs/rest-endpoints/roles.md
new file mode 100644
index 0000000..2bdd5f7
--- /dev/null
+++ b/docs/rest-endpoints/roles.md
@@ -0,0 +1,74 @@
+# roles
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create a new role</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get the roles in an application</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles/{rolename}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Delete a role</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles/ {rolename|role_id}/permissions</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get permissions for a role</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles/ {rolename|role_id}/permissions</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Add permissions to a role</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>{org_id}/{app_id}/roles/ {rolename|role_id}/permissions? permission={grant_url_pattern}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Delete permissions from a role</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles/{role_id}/ users/{uuid|username} or /{org_id}/{app_id}/users/ {uuid|username}/roles/{role_id}</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Add a user to a role</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles/{role_id}/ users</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get the users in a role</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/roles/{role_id}/ users/{uuid|username}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Delete a user from a role</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/access-token.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/access-token.txt b/docs/rest-endpoints/sources/access-token.txt
new file mode 100644
index 0000000..027bbae
--- /dev/null
+++ b/docs/rest-endpoints/sources/access-token.txt
@@ -0,0 +1 @@
+End-Point Method Content-type Description Detail
"/management/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'" POST application/json Obtain an access token (access type = organization) Detail
"/management/token '{"grant_type":"password","username":"{username}",:"password":"{password}"}'" POST application/json Obtain an access token (access type = admin user) Detail
"/{org_id}/{app_id}/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'" POST application/json Obtain an access token (access type = application) Detail
"/{org_id}/{app_id}/token '{"grant_type":"password","username":"{username}","password":"{password}"}'" POST application/json Obtain an access token (access type = application user) Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/activities.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/activities.txt b/docs/rest-endpoints/sources/activities.txt
new file mode 100644
index 0000000..e4c0d2e
--- /dev/null
+++ b/docs/rest-endpoints/sources/activities.txt
@@ -0,0 +1 @@
+End-Point Method Content-type Description Detail
/{org_id}/{app_id}/users/ {uuid|username}/activities POST application/json Create an activity Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/activities POST application/json Post an activity to a group Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/admin-users.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/admin-users.txt b/docs/rest-endpoints/sources/admin-users.txt
new file mode 100644
index 0000000..711644c
--- /dev/null
+++ b/docs/rest-endpoints/sources/admin-users.txt
@@ -0,0 +1 @@
+End-Point Method Content-type Description Detail
/management/users POST application/json Create an admin user Detail
/management/users/{user|username|email|uuid} PUT application/json Update an admin user Detail
/management/users/{user|username|email|uuid} GET application/json Get an admin user Detail
/management/users/{user|username|email|uuid}/ password PUT application/json Set an admin user's password Detail
/managementusers/resetpw GET application/json Initiate the reset of an admin user's password Detail
/management/users/resetpw POST application/json Complete the reset of an admin user's password Detail
/management/users/{user|username|email|uuid}/activate? token={token}&confirm={confirm_email} GET application/json Activate an admin user Detail
/management/users/{user|username|email|uuid}/reactivate GET application/json Reactivate an admin user Detail
/management/users/{user|username|email|uuid}/feed GET application/json Get an admin user's feed Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/collections.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/collections.txt b/docs/rest-endpoints/sources/collections.txt
new file mode 100644
index 0000000..6b1ffd8
--- /dev/null
+++ b/docs/rest-endpoints/sources/collections.txt
@@ -0,0 +1 @@
+End-Point Method Content-type Description Detail
/{org_id}/{app_id}/ GET application/json Retrieve all collections Detail
/{org_id}/{app_id}/{collection} POST application/json Create a new entity or collection Detail
/{org_id}/{app_id}/{collection}/ {uuid|name} GET application/json Retrieve an entity Detail
/{org_id}/{app_id}/{collection}/ {uuid|name} PUT application/json Update an entity Detail
/{org_id}/{app_id}/{collection}/ {uuid|name} DELETE application/json Delete an entity Detail
/{org_id}/{app_id}/{collection}?{query} GET application/json Query a collection Detail
/{org_id}/{app_id}/{collection}?{query} PUT application/json Update a collection by query Detail
/{org_id}/{app_id}/{collection}/{entity_id}/ {relationship}?{query} GET application/json Query an entity's collections or connections Detail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{se
cond_entity_id} POST application/json Add an entity to a collection or create a connection Detail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id} DELETE application/json Remove an entity from a collection or delete a connection Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/csv2md.groovy
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/csv2md.groovy b/docs/rest-endpoints/sources/csv2md.groovy
new file mode 100644
index 0000000..070ea5e
--- /dev/null
+++ b/docs/rest-endpoints/sources/csv2md.groovy
@@ -0,0 +1,40 @@
+def dir = new File(".");
+def files = dir.list();
+files.each() { fileName ->
+ if ( fileName.endsWith(".txt") ) {
+
+ def baseName = fileName.substring(0, fileName.length() - 4);
+
+ def outputFile = new File("../" + baseName + ".md");
+ outputFile.withWriter('utf-8') { writer ->
+
+ def inputFile = new File(fileName);
+ def count = 0;
+ writer.writeLine "# ${baseName}"
+ writer.writeLine ""
+ writer.writeLine "<!-- DO NOT EDIT THIS GENERATED FILE -->";
+ writer.writeLine "<table class='usergrid-table rest-endpoints-table'>";
+
+ inputFile.eachLine { line ->
+ def parts = line.split("\\t")
+ if ( count == 0 ) {
+ writer.writeLine " <tr>";
+ parts.each() { part ->
+ writer.writeLine " <th>" + part + "</th>";
+ }
+ writer.writeLine " </tr>";
+ } else {
+ writer.writeLine " <tr>";
+ parts.each() { part ->
+ writer.writeLine " <td>" + part + "</td>";
+ }
+ writer.writeLine " </tr>";
+ }
+ count++;
+ }
+ writer.writeLine "</table>";
+
+ }
+ }
+}
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/events.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/events.txt b/docs/rest-endpoints/sources/events.txt
new file mode 100644
index 0000000..20a4178
--- /dev/null
+++ b/docs/rest-endpoints/sources/events.txt
@@ -0,0 +1 @@
+End-Point Method Content-type Description Detail
/{org_id}/{app_id}/events POST application/json Create an event Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/groups.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/groups.txt b/docs/rest-endpoints/sources/groups.txt
new file mode 100644
index 0000000..649a965
--- /dev/null
+++ b/docs/rest-endpoints/sources/groups.txt
@@ -0,0 +1 @@
+End-Point Method Content-type Description Detail
/{org_id}/{app_id}/groups POST application/json Create a new group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username} POST application/json Add a user to a group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname} GET application/json Get a group Detail
/{org_id}{app_id}/groups/ {uuid|groupname} PUT application/json Update a group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username} DELETE application/json Delete user from a group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/feed GET application/json Get a group's feed Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/organizations.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/organizations.txt b/docs/rest-endpoints/sources/organizations.txt
new file mode 100644
index 0000000..3afa5b3
--- /dev/null
+++ b/docs/rest-endpoints/sources/organizations.txt
@@ -0,0 +1 @@
+End-Point Method Description Detail
/management/organizations|orgs POST application/json Create an organization Detail
/management/organizations|orgs/{org_name}|{uuid} GET application/json Retrieve an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/ activate?token={token}&confirm={confirm_email} GET application/json Activate an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/ reactivate GET application/json Reactivate an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/ credentials POST application/json Generate organization client credentials Detail
/management/organizations|orgs/{org_name}|{uuid}/ credentials GET application/json Retrieve organization client credentials Detail
/management/organizations|orgs/{org_name}|{uuid}/ feed GET application/json Retrieve an organization's activity feed Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ apps POST application/json Create an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/ applications|apps/{app_name}|{uuid}/ credentials POST application/json Generate credentials for an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/ applications|apps/ {app_name}|{uuid}/credentials GET application/json Get credentials for an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/ applications|apps GET application/json Get the applications in an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ users/{username|email|uuid} PUT application/json Adding an admin user to an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ users GET application/json Getting the admin users in an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ users/{username|email|uuid} DELETE application/json Removing an admin user from an organization Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/roles.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/roles.txt b/docs/rest-endpoints/sources/roles.txt
new file mode 100644
index 0000000..065511d
--- /dev/null
+++ b/docs/rest-endpoints/sources/roles.txt
@@ -0,0 +1 @@
+End-Point Method Description Detail
/{org_id}/{app_id}/roles POST application/json Create a new role Detail
/{org_id}/{app_id}/roles GET application/json Get the roles in an application Detail
/{org_id}/{app_id}/roles/{rolename} DELETE application/json Delete a role Detail
/{org_id}/{app_id}/roles/ {rolename|role_id}/permissions GET application/json Get permissions for a role Detail
/{org_id}/{app_id}/roles/ {rolename|role_id}/permissions POST application/json Add permissions to a role Detail
{org_id}/{app_id}/roles/ {rolename|role_id}/permissions? permission={grant_url_pattern} DELETE application/json Delete permissions from a role Detail
/{org_id}/{app_id}/roles/{role_id}/ users/{uuid|username} or /{org_id}/{app_id}/users/ {uuid|username}/roles/{role_id} POST application/json Add a user to a role Detail
/{org_id}/{app_id}/roles/{role_id}/ users GET application/json Get the users in a role Detail
/{org_id}/{app_id}/roles/{role_id}/ users/{uuid|username} DELETE application/json Del
ete a user from a role Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/sources/users.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/users.txt b/docs/rest-endpoints/sources/users.txt
new file mode 100644
index 0000000..7debd51
--- /dev/null
+++ b/docs/rest-endpoints/sources/users.txt
@@ -0,0 +1 @@
+End-Point Method Description Detail
/{org_id}/{app_id}/users POST application/json Create a user in the users collection Detail
/{org_id}/{app_id}/users/{user}/ password POST application/json Set a user's password or reset the user's existing password Detail
/{org_id}/{app_id}/users/ {uuid|username|email_address} GET application/json Retrieve a user Detail
/{org_id}/{app_id}/users/ {uuid|username} PUT application/json Update a user Detail
/{org_id}/{app_id}/users/{uuid|username} DELETE application/json Delete a user Detail
/{org_id}/{app_id}/users?{query} GET application/json Query to get users Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username} POST application/json Add a user to a group Detail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id} POST application/json Add a user to a collection or create a connection De
tail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id} DELETE application/json Remove a user from a collection or delete a connection Detail
/{org_id}/{app_id}/users/{uuid|username}/ {relationship}?{query} GET application/json Query a user's collections or connections Detail
/{org_id}/{app_id}/users/ {uuid|username}/feed GET application/json Get a user's feed Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/users.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/users.md b/docs/rest-endpoints/users.md
new file mode 100644
index 0000000..2b6c0c8
--- /dev/null
+++ b/docs/rest-endpoints/users.md
@@ -0,0 +1,88 @@
+# users
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Create a user in the users collection</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users/{user}/ password</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Set a user's password or reset the user's existing password</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users/ {uuid|username|email_address}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Retrieve a user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users/ {uuid|username}</td>
+ <td>PUT</td>
+ <td>application/json</td>
+ <td>Update a user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users/{uuid|username}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Delete a user</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users?{query}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Query to get users</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username}</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Add a user to a group</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id}</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Add a user to a collection or create a connection</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id}</td>
+ <td>DELETE</td>
+ <td>application/json</td>
+ <td>Remove a user from a collection or delete a connection</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users/{uuid|username}/ {relationship}?{query}</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Query a user's collections or connections</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>/{org_id}/{app_id}/users/ {uuid|username}/feed</td>
+ <td>GET</td>
+ <td>application/json</td>
+ <td>Get a user's feed</td>
+ <td>Detail</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/sdks/ios.md
----------------------------------------------------------------------
diff --git a/docs/sdks/ios.md b/docs/sdks/ios.md
index e69de29..328b09a 100644
--- a/docs/sdks/ios.md
+++ b/docs/sdks/ios.md
@@ -0,0 +1 @@
+# iOS SDK
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/sdks/java.md
----------------------------------------------------------------------
diff --git a/docs/sdks/java.md b/docs/sdks/java.md
index e69de29..a2a5086 100644
--- a/docs/sdks/java.md
+++ b/docs/sdks/java.md
@@ -0,0 +1 @@
+# Java SDK
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/sdks/javascript.md
----------------------------------------------------------------------
diff --git a/docs/sdks/javascript.md b/docs/sdks/javascript.md
index 28e490a..685d42d 100644
--- a/docs/sdks/javascript.md
+++ b/docs/sdks/javascript.md
@@ -1,24 +1,3 @@
-iOS SDK
-==================================================
+# JavaScript/HTML5 SDK
+
-.. toctree::
- ios/create-a-collection
- ios/retrieve-a-collection
- ios/update-a-collection
- ios/delete-a-collection
- ios/create-an-entity
- ios/retrieve-an-entity
- ios/update-an-entity
- ios/delete-an-entity
- ios/query-your-data
- ios/connecting-entities
- ios/retrieving-connections
- ios/disconnecting-entities
- ios/assigning-permissions
- ios/creating-roles
- ios/assigning-roles
- ios/application-user-auth
- ios/application-client-auth
- ios/admin-user-auth
- ios/revoking-tokens
-
[2/3] incubator-usergrid git commit: Adding REST End-point and Entity
tables in tab-delimited text files and a Groovy script that turns them into
Markdown with HTML tables.
Posted by sn...@apache.org.
Adding REST End-point and Entity tables in tab-delimited text files and a Groovy script that turns them into Markdown with HTML tables.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/d2c7b377
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/d2c7b377
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/d2c7b377
Branch: refs/heads/ug2-doc-update
Commit: d2c7b377267c4945cc90834fcb665cf3c8590dc9
Parents: 080f911
Author: Dave Johnson <sn...@apache.org>
Authored: Thu Jul 30 12:14:25 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Thu Jul 30 12:14:25 2015 -0400
----------------------------------------------------------------------
docs/conf.py | 12 +-
docs/data-queries/operators-and-types.md | 212 +++++++++----------
docs/data-queries/query-parameters.md | 183 ++++++++--------
docs/data-storage/data-store-dbms.md | 53 +++--
docs/data-storage/entities.md | 3 -
docs/default-entities/activity.md | 75 +++++++
docs/default-entities/application.md | 90 ++++++++
docs/default-entities/asset.md | 50 +++++
docs/default-entities/device.md | 35 +++
docs/default-entities/event.md | 60 ++++++
docs/default-entities/folder.md | 45 ++++
docs/default-entities/group.md | 40 ++++
docs/default-entities/notification.md | 50 +++++
docs/default-entities/notifier.md | 45 ++++
docs/default-entities/receipt.md | 45 ++++
docs/default-entities/role.md | 50 +++++
docs/default-entities/sources/activity.txt | 1 +
docs/default-entities/sources/application.txt | 1 +
docs/default-entities/sources/asset.txt | 1 +
docs/default-entities/sources/csv2md.groovy | 40 ++++
docs/default-entities/sources/device.txt | 1 +
docs/default-entities/sources/event.txt | 1 +
docs/default-entities/sources/folder.txt | 1 +
docs/default-entities/sources/group.txt | 1 +
docs/default-entities/sources/notification.txt | 1 +
docs/default-entities/sources/notifier.txt | 1 +
docs/default-entities/sources/receipt.txt | 1 +
docs/default-entities/sources/role.txt | 1 +
docs/default-entities/sources/user.txt | 1 +
docs/default-entities/user.md | 40 ++++
docs/geolocation/geolocation.md | 2 +
docs/index.md | 144 -------------
docs/index.rst | 193 +++++++++++++++++
docs/installation/get-up-and-running-locally.md | 72 +++++++
.../getting-up-and-running-locally.md | 72 -------
docs/rest-endpoints/access-token.md | 40 ++++
docs/rest-endpoints/activities.md | 26 +++
docs/rest-endpoints/admin-users.md | 75 +++++++
docs/rest-endpoints/collections.md | 82 +++++++
docs/rest-endpoints/events.md | 19 ++
docs/rest-endpoints/groups.md | 54 +++++
docs/rest-endpoints/organizations.md | 109 ++++++++++
docs/rest-endpoints/roles.md | 74 +++++++
docs/rest-endpoints/sources/access-token.txt | 1 +
docs/rest-endpoints/sources/activities.txt | 1 +
docs/rest-endpoints/sources/admin-users.txt | 1 +
docs/rest-endpoints/sources/collections.txt | 1 +
docs/rest-endpoints/sources/csv2md.groovy | 40 ++++
docs/rest-endpoints/sources/events.txt | 1 +
docs/rest-endpoints/sources/groups.txt | 1 +
docs/rest-endpoints/sources/organizations.txt | 1 +
docs/rest-endpoints/sources/roles.txt | 1 +
docs/rest-endpoints/sources/users.txt | 1 +
docs/rest-endpoints/users.md | 88 ++++++++
docs/sdks/ios.md | 1 +
docs/sdks/java.md | 1 +
docs/sdks/javascript.md | 25 +--
57 files changed, 1793 insertions(+), 473 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/conf.py
----------------------------------------------------------------------
diff --git a/docs/conf.py b/docs/conf.py
index 1a385fb..db1c4fe 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -25,6 +25,9 @@
import sys, os
+# CommonMarkParser causes all sorts of problems
+#from recommonmark.parser import CommonMarkParser
+
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -47,8 +50,10 @@ extensions = [
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
-# The suffix of source filenames.
-source_suffix = '.md'
+#source_parsers = {
+# '.md': CommonMarkParser,
+#}
+source_suffix = ['.md','.rst']
# The encoding of source files.
#source_encoding = 'utf-8-sig'
@@ -270,4 +275,5 @@ sys.path.insert(0, os.path.abspath('./lib'))
extensions += ["sphinxcontrib_markdown"]
markdown_title = 'Apache Usergrid Documentation'
-source_suffix = '.md'
+
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/data-queries/operators-and-types.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/operators-and-types.md b/docs/data-queries/operators-and-types.md
index 2029ce5..c67ccd1 100644
--- a/docs/data-queries/operators-and-types.md
+++ b/docs/data-queries/operators-and-types.md
@@ -1,62 +1,61 @@
-# Supported query operators & data types
+# Query operators & data types
The following operators and data types are supported by the SQL-like query language in Usergrid.
## Operators
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td>Operator</td>
- <td>Purpose</td>
- <td>Example</td>
- </tr>
- <tr>
- <td>'<' or 'lt'</td>
- <td>Less than</td>
- <td>select * where quantity > '1000'</td>
- </tr>
- <tr>
- <td>'<=' or 'lte'</td>
- <td>Less than or equal to</td>
- <td>Example</td>
- </tr>
- <tr>
- <td>'=' or 'eq'</td>
- <td>Equals</td>
- <td>select * where price = '20.00'</td>
- </tr>
- <tr>
- <td>'>=' or 'gte'</td>
- <td>Greater than or equal to </td>
- <td>select * where quantity >= '1000'</td>
- </tr>
- <tr>
- <td>'>' or 'gt'</td>
- <td>Greater than</td>
- <td>select * where quantity > '1000'</td>
- </tr>
- <tr>
- <td>not <some_expression></td>
- <td>Subtraction of results</td>
- <td>select * where quantity < '4000' and not quantity = '2000'</td>
- </tr>
- <tr>
- <td>and</td>
- <td>Union of results</td>
- <td>select * where quantity > '1000' and quantity < '4000'</td>
- </tr>
- <tr>
- <td>or</td>
- <td>Intersection of results</td>
- <td>select * where quantity = '1000' or quantity = '4000'</td>
- </tr>
- <tr>
- <td>contains</td>
- <td>Narrow by contained text</td>
- <td>select * where title contains 'tale'</td>
- </tr>
- </table>
+<table class="usergrid-table">
+ <tr>
+ <td>Operator</td>
+ <td>Purpose</td>
+ <td>Example</td>
+ </tr>
+ <tr>
+ <td>'<' or 'lt'</td>
+ <td>Less than</td>
+ <td>select * where quantity > '1000'</td>
+ </tr>
+ <tr>
+ <td>'<=' or 'lte'</td>
+ <td>Less than or equal to</td>
+ <td>Example</td>
+ </tr>
+ <tr>
+ <td>'=' or 'eq'</td>
+ <td>Equals</td>
+ <td>select * where price = '20.00'</td>
+ </tr>
+ <tr>
+ <td>'>=' or 'gte'</td>
+ <td>Greater than or equal to </td>
+ <td>select * where quantity >= '1000'</td>
+ </tr>
+ <tr>
+ <td>'>' or 'gt'</td>
+ <td>Greater than</td>
+ <td>select * where quantity > '1000'</td>
+ </tr>
+ <tr>
+ <td>not <some_expression></td>
+ <td>Subtraction of results</td>
+ <td>select * where quantity < '4000' and not quantity = '2000'</td>
+ </tr>
+ <tr>
+ <td>and</td>
+ <td>Union of results</td>
+ <td>select * where quantity > '1000' and quantity < '4000'</td>
+ </tr>
+ <tr>
+ <td>or</td>
+ <td>Intersection of results</td>
+ <td>select * where quantity = '1000' or quantity = '4000'</td>
+ </tr>
+ <tr>
+ <td>contains</td>
+ <td>Narrow by contained text</td>
+ <td>select * where title contains 'tale'</td>
+ </tr>
+</table>
## Data types
@@ -67,56 +66,55 @@ For example, if you create an entity with a price property with a value of 100.0
For a list of property data types for each default entities, see Default Data Entity Types.
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td>string</td>
- <td><pre>'value', unicode '\uFFFF', octal '\0707'</pre></td>
- </tr>
- <tr>
- <td>long</td>
- <td><pre>1357412326021</pre> <br> Timestamps are typically stored as long values.</td>
- </tr>
- <tr>
- <td>float</td>
- <td><pre>10.1, -10.1, 10e10, 10e-10, 10E10, 10E-10</pre> <br>
- Your query must be specific about the value you're looking for, down to the value
- (if any) after the decimal point.</td>
- </tr>
- <tr>
- <td>boolean</td>
- <td><pre>true | false</pre></td>
- </tr>
- <tr>
- <td>UUID</td>
- <td><pre>ee912c4b-5769-11e2-924d-02e81ac5a17b</pre></td>
- </tr>
- <tr>
- <td>Array</td>
- <td><pre>["boat", "car", "bike"]</pre></td>
- </tr>
- <tr>
- <td>object</td>
- <td><p>For a JSON object like this one:</p>
- <pre>
- {
- "items": [
- {
- "name": "rocks"
- },
- {
- "name": "boats"
- }
- ]
- }
- </pre>
- <p>you can use dot notation to reach property values in the object:</p>
- <pre>
- /mycollection/thing?ql="select * where items.name = 'rocks'"
- </pre>
- <p>Objects are often used to contain entity metadata, such as the activities
- associated with a user, the users associated with a role, and so on.</p>
- <p>Please note that object properties are not indexed. This means queries
- using dot-notation will be much slower than queries on indexed entity properties.</p></td>
- </tr>
- </table>
+<table class="usergrid-table">
+ <tr>
+ <td>string</td>
+ <td><pre>'value', unicode '\uFFFF', octal '\0707'</pre></td>
+ </tr>
+ <tr>
+ <td>long</td>
+ <td><pre>1357412326021</pre> <br> Timestamps are typically stored as long values.</td>
+ </tr>
+ <tr>
+ <td>float</td>
+ <td><pre>10.1, -10.1, 10e10, 10e-10, 10E10, 10E-10</pre> <br>
+ Your query must be specific about the value you're looking for, down to the value
+ (if any) after the decimal point.</td>
+ </tr>
+ <tr>
+ <td>boolean</td>
+ <td><pre>true | false</pre></td>
+ </tr>
+ <tr>
+ <td>UUID</td>
+ <td><pre>ee912c4b-5769-11e2-924d-02e81ac5a17b</pre></td>
+ </tr>
+ <tr>
+ <td>Array</td>
+ <td><pre>["boat", "car", "bike"]</pre></td>
+ </tr>
+ <tr>
+ <td>object</td>
+ <td><p>For a JSON object like this one:</p>
+ <pre>
+ {
+ "items": [
+ {
+ "name": "rocks"
+ },
+ {
+ "name": "boats"
+ }
+ ]
+ }
+ </pre>
+ <p>you can use dot notation to reach property values in the object:</p>
+ <pre>
+ /mycollection/thing?ql="select * where items.name = 'rocks'"
+ </pre>
+ <p>Objects are often used to contain entity metadata, such as the activities
+ associated with a user, the users associated with a role, and so on.</p>
+ <p>Please note that object properties are not indexed. This means queries
+ using dot-notation will be much slower than queries on indexed entity properties.</p></td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/data-queries/query-parameters.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/query-parameters.md b/docs/data-queries/query-parameters.md
index 9446412..5c4cca8 100644
--- a/docs/data-queries/query-parameters.md
+++ b/docs/data-queries/query-parameters.md
@@ -22,48 +22,46 @@ __Note__: Not all string properties of the default entities are indexed for sear
The following table lists a few examples of the kind of searches you can do in queries.
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td>Goal</td>
- <td>Example</td>
- <td>Notes</td>
- </tr>
- <tr>
- <td>Find books whose 'title' property contains the full word "tale".</td>
- <td><pre>/books?ql=select * where title contains 'tale'</pre></td>
- <td>containslooks for the occurrence of a full word anywhere in the searched property. Note that contains will not work on the 'name' property, since it is not full-text indexed in the database.</td>
- </tr>
- <tr>
- <td>Find books whose 'title' property contains a word that starts with "ta".</td>
- <td><pre>/books?ql=select * where title contains 'ta*'</pre></td>
- <td>containswill look for partial words if you include a wildcard.</td>
- </tr>
- <tr>
- <td>Find books whose title property is exactly and only "A Tale of Two Cities".</td>
- <td><pre>/books?ql=select * where title = 'A Tale of Two Cities'</pre></td>
- <td>The = operator is looking for a match in the entire searched property value. Use a * wildcard to look for some set of the first characters only.</td>
- </tr>
- </table>
+<table class="usergrid-table">
+ <tr>
+ <td>Goal</td>
+ <td>Example</td>
+ <td>Notes</td>
+ </tr>
+ <tr>
+ <td>Find books whose 'title' property contains the full word "tale".</td>
+ <td><pre>/books?ql=select * where title contains 'tale'</pre></td>
+ <td>containslooks for the occurrence of a full word anywhere in the searched property. Note that contains will not work on the 'name' property, since it is not full-text indexed in the database.</td>
+ </tr>
+ <tr>
+ <td>Find books whose 'title' property contains a word that starts with "ta".</td>
+ <td><pre>/books?ql=select * where title contains 'ta*'</pre></td>
+ <td>containswill look for partial words if you include a wildcard.</td>
+ </tr>
+ <tr>
+ <td>Find books whose title property is exactly and only "A Tale of Two Cities".</td>
+ <td><pre>/books?ql=select * where title = 'A Tale of Two Cities'</pre></td>
+ <td>The = operator is looking for a match in the entire searched property value. Use a * wildcard to look for some set of the first characters only.</td>
+ </tr>
+</table>
### Location
If you've stored location data with your entities, you can query for the proximity of the geographical locations those entities represent. For more information on geolocation, see Geolocation.
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td>Goal</td>
- <td>Example</td>
- <td>Notes</td>
- </tr>
- <tr>
- <td>Find stores whose locations are within the specified longitude and latitude.</td>
- <td><pre>/stores?ql=location within 500 of 40.042016, -86.900749</pre></td>
- <td>within will test for values within the value you specify. The within value is expressed as a number of meters.<br>The return results are sorted in order of nearest to furthest. If there are multiple entries at the same location, they're returned in the order they were added to the database.<br> For more on geolocation queries, see Geolocation.</td>
- </tr>
- </table>
+<table class="usergrid-table">
+ <tr>
+ <td>Goal</td>
+ <td>Example</td>
+ <td>Notes</td>
+ </tr>
+ <tr>
+ <td>Find stores whose locations are within the specified longitude and latitude.</td>
+ <td><pre>/stores?ql=location within 500 of 40.042016, -86.900749</pre></td>
+ <td>within will test for values within the value you specify. The within value is expressed as a number of meters.<br>The return results are sorted in order of nearest to furthest. If there are multiple entries at the same location, they're returned in the order they were added to the database.<br> For more on geolocation queries, see Geolocation.</td>
+ </tr>
+</table>
### Order by
@@ -73,25 +71,24 @@ You can return query results that are sorted in the order you specify. Use the o
The following table includes a few examples:
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td>Goal</td>
- <td>Example</td>
- </tr>
- <tr>
- <td>Sort by first name in ascending order</td>
- <td>/users?ql=select * where lastname = 'Smith' order by firstname asc</td>
- </tr>
- <tr>
- <td>Sort by first name in descending order</td>
- <td>/users?ql=select * where lastname = 'Smith' order by firstname desc</td>
- </tr>
- <tr>
- <td>Sort by last name, then first name in ascending orderl</td>
- <td>/users?ql=select * where lastname contains 'Sm*' order by lastname asc, firstname asc</td>
- </tr>
- <table>
+<table class="usergrid-table">
+ <tr>
+ <td>Goal</td>
+ <td>Example</td>
+ </tr>
+ <tr>
+ <td>Sort by first name in ascending order</td>
+ <td>/users?ql=select * where lastname = 'Smith' order by firstname asc</td>
+ </tr>
+ <tr>
+ <td>Sort by first name in descending order</td>
+ <td>/users?ql=select * where lastname = 'Smith' order by firstname desc</td>
+ </tr>
+ <tr>
+ <td>Sort by last name, then first name in ascending orderl</td>
+ <td>/users?ql=select * where lastname contains 'Sm*' order by lastname asc, firstname asc</td>
+ </tr>
+<table>
### Limit
@@ -102,32 +99,31 @@ For example, you might execute a query that could potentially return hundreds of
You would use the following parameters in your query:
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td>Parameter</td>
- <td>Type</td>
- <td>Description</td>
- </tr>
- <tr>
- <td>limit</td>
- <td>integer</td>
- <td><p>Number of results to return. The maximum number of results is 1,000.
- Specifying a limit greater than 1,000 will result in a limit of 1,000.</p>
- <p>You can also use the limit parameter on a request without a query string.
- The following example is shorthand for selecting all books and limiting by 100 at a time:</p>
- <pre>/books?limit=100</pre>
- <p>Using a limit on a DELETE can help you manage the amount of time it takes
- to delete data. For example you can delete all of the books, 1000 at a time,
- with the following:</p>
- <pre>DELETE /books?limit=1000</pre>
- <p> Keep in mind that DELETE operations can take longer to execute.
- Yet even though the DELETE query call might time out (such as with a
- very large limit), the operation will continue on the server even if
- the client stops waiting for the result.</p>
- </td>
- </tr>
- </table>
+<table class="usergrid-table">
+ <tr>
+ <td>Parameter</td>
+ <td>Type</td>
+ <td>Description</td>
+ </tr>
+ <tr>
+ <td>limit</td>
+ <td>integer</td>
+ <td><p>Number of results to return. The maximum number of results is 1,000.
+ Specifying a limit greater than 1,000 will result in a limit of 1,000.</p>
+ <p>You can also use the limit parameter on a request without a query string.
+ The following example is shorthand for selecting all books and limiting by 100 at a time:</p>
+ <pre>/books?limit=100</pre>
+ <p>Using a limit on a DELETE can help you manage the amount of time it takes
+ to delete data. For example you can delete all of the books, 1000 at a time,
+ with the following:</p>
+ <pre>DELETE /books?limit=1000</pre>
+ <p> Keep in mind that DELETE operations can take longer to execute.
+ Yet even though the DELETE query call might time out (such as with a
+ very large limit), the operation will continue on the server even if
+ the client stops waiting for the result.</p>
+ </td>
+ </tr>
+</table>
For example:
@@ -138,19 +134,18 @@ Select all users whose name starts with fred, and returns the first 50 results:
### Cursor
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td>Parameter</td>
- <td>Type</td>
- <td>Description</td>
- </tr>
- <tr>
- <td>cursor</td>
- <td>string</td>
- <td>An encoded representation of the query position pointing to a set of results. To retrieve the next set of results, pass the cursor with your next call for most results./td>
- </tr>
- </table>
+<table class="usergrid-table">
+ <tr>
+ <td>Parameter</td>
+ <td>Type</td>
+ <td>Description</td>
+ </tr>
+ <tr>
+ <td>cursor</td>
+ <td>string</td>
+ <td>An encoded representation of the query position pointing to a set of results. To retrieve the next set of results, pass the cursor with your next call for most results./td>
+ </tr>
+</table>
Retrieve the next batch of users whose name is "fred", passing the cursor received from the last request to specify where the next set of results should begin:
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/data-storage/data-store-dbms.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/data-store-dbms.md b/docs/data-storage/data-store-dbms.md
index 300a376..3e09d99 100644
--- a/docs/data-storage/data-store-dbms.md
+++ b/docs/data-storage/data-store-dbms.md
@@ -17,33 +17,32 @@ Fast writes to the data store.
If you have experience with relational databases and are unfamiliar with "NoSQL" databases, the following table might be a helpful start. It maps the high-level concepts of an RDBMS’s data model both to Cassandra’s and to the Usergrid, which is backed by Cassandra.
-.. raw:: html
- <table class="usergrid-table">
- <tr>
- <td></td>
- <td>RDBMS</td>
- <td>Cassandra</td>
- <td>Usergrid</td>
- </tr>
- <tr>
- <td>Each tuple is modeled as</td>
- <td>A row.</td>
- <td>A row.</td>
- <td>An entity. Written and retrieved as JSON, an entity contains values for all of its properties in the way a row has values for columns.</td>
- </tr>
- <tr>
- <td>Each data attribute is modeled as</td>
- <td>A column.</td>
- <td>A column. Many thousands of columns are supported.</td>
- <td>A entity property. An entity has a default set of properties, including the entity’s UUID. You can add many more to support your application.</td>
- </tr>
- <tr>
- <td>Each group of attributes is modeled as</td>
- <td>A table.</td>
- <td>A column family. Unlike rows in tables, rows in a column family can have differing numbers of columns. Because you’re not using a schema to define the model, you can update the column list for a row at any time.</td>
- <td>An entity collection. As with its underlying Cassandra column family, a collection can have entities with differing numbers of properties. In other words, just because one entity has an authorId property doesn’t mean that other entities in its collection need to.</td>
- </tr>
- </table>
+<table class="usergrid-table">
+<tr>
+ <td></td>
+ <td>RDBMS</td>
+ <td>Cassandra</td>
+ <td>Usergrid</td>
+</tr>
+<tr>
+ <td>Each tuple is modeled as</td>
+ <td>A row.</td>
+ <td>A row.</td>
+ <td>An entity. Written and retrieved as JSON, an entity contains values for all of its properties in the way a row has values for columns.</td>
+</tr>
+<tr>
+ <td>Each data attribute is modeled as</td>
+ <td>A column.</td>
+ <td>A column. Many thousands of columns are supported.</td>
+ <td>A entity property. An entity has a default set of properties, including the entity’s UUID. You can add many more to support your application.</td>
+</tr>
+<tr>
+ <td>Each group of attributes is modeled as</td>
+ <td>A table.</td>
+ <td>A column family. Unlike rows in tables, rows in a column family can have differing numbers of columns. Because you’re not using a schema to define the model, you can update the column list for a row at any time.</td>
+ <td>An entity collection. As with its underlying Cassandra column family, a collection can have entities with differing numbers of properties. In other words, just because one entity has an authorId property doesn’t mean that other entities in its collection need to.</td>
+</tr>
+</table>
The following examples from a product database provide simple illustrations of these differences.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/data-storage/entities.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/entities.md b/docs/data-storage/entities.md
index 22d8f18..8a53923 100644
--- a/docs/data-storage/entities.md
+++ b/docs/data-storage/entities.md
@@ -250,7 +250,6 @@ Response:
"applicationName" : "sandbox"
}
-
### Retrieving multiple entities
This example describes how to retrieve multiple entities by UUID. You can also retrieve a set of entities by using a query string. For more information on querying your data, see Querying your data.
@@ -451,8 +450,6 @@ Response:
"applicationName" : "your-app"
}
-.. --------------------------------------------------------------------------------
-
## Deleting Data Entities
This article describes how to delete data entities.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/activity.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/activity.md b/docs/default-entities/activity.md
new file mode 100644
index 0000000..c6642db
--- /dev/null
+++ b/docs/default-entities/activity.md
@@ -0,0 +1,75 @@
+# activity
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'activity'</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>actor</td>
+ <td>ActivityObject</td>
+ <td>Required. Entity that performed the 'action' of the activity (see JSON Activity Streams 1.0 specification). By default, the UUID of the user who performed the action is recorded as the value of the 'uuid' property of this object.</td>
+ </tr>
+ <tr>
+ <td>verb</td>
+ <td>string</td>
+ <td>Required. The action performed by the user (for example, post)</td>
+ </tr>
+ <tr>
+ <td>published</td>
+ <td>long</td>
+ <td>Required. UTC timestamp in milliseconds of when the activity was published</td>
+ </tr>
+ <tr>
+ <td>content</td>
+ <td>string</td>
+ <td>Optional. Description of the activity</td>
+ </tr>
+ <tr>
+ <td>icon</td>
+ <td>MediaLink</td>
+ <td>Optional. Visual representation of a media link resource (see JSON Activity Streams 1.0 specification)</td>
+ </tr>
+ <tr>
+ <td>category</td>
+ <td>string</td>
+ <td>Optional. Category used to organize activities</td>
+ </tr>
+ <tr>
+ <td>published</td>
+ <td>long</td>
+ <td>Optional. UTC timestamp in milliseconds when the activity was published</td>
+ </tr>
+ <tr>
+ <td>object</td>
+ <td>ActivityObject</td>
+ <td>Optional. Object on which the action is performed (see JSON Activity Streams 1.0 specification)</td>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>string</td>
+ <td>Optional. Title or headline for the activity</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the activity entity, as well as additional data entities associated with the activity. The following properties are included in metadata: path: Path to retrieve the activity entity, including the UUID of the user entity associated with the activity and the UUID of the activity entity</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/application.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/application.md b/docs/default-entities/application.md
new file mode 100644
index 0000000..72774a4
--- /dev/null
+++ b/docs/default-entities/application.md
@@ -0,0 +1,90 @@
+# application
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>String</td>
+ <td>Type of entity, in this case 'application'</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>Optional. Application name</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>accesstokenttl</td>
+ <td>long</td>
+ <td>Optional. Time to live value for an access token obtained within the application</td>
+ </tr>
+ <tr>
+ <td>organizationName</td>
+ <td>string</td>
+ <td>Name of the organization the application belongs to</td>
+ </tr>
+ <tr>
+ <td>applicationName</td>
+ <td>string</td>
+ <td>Name of the application</td>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>string</td>
+ <td>Optional. Application title</td>
+ </tr>
+ <tr>
+ <td>description</td>
+ <td>string</td>
+ <td>Optional. Application description</td>
+ </tr>
+ <tr>
+ <td>activated</td>
+ <td>boolean</td>
+ <td>Optional. Whether application is activated</td>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>Optional. Whether application is administratively disabled</td>
+ </tr>
+ <tr>
+ <td>allowOpenRegistration</td>
+ <td>boolean</td>
+ <td>Optional. Whether application allows any user to register</td>
+ </tr>
+ <tr>
+ <td>registrationRequiresEmailConfirmation</td>
+ <td>boolean</td>
+ <td>Optional. Whether registration requires email confirmation</td>
+ </tr>
+ <tr>
+ <td>registrationRequiresAdminApproval</td>
+ <td>boolean</td>
+ <td>Optional. Whether registration requires admin approval</td>
+ </tr>
+ <tr>
+ <td>notify_admin_of_new_users</td>
+ <td>boolean</td>
+ <td>Optional. Whether application admins should be notified of new users</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides a 'collections' object with the relative paths to all entity collections associated with the application. The following collections are included in metadata by default: users: Path to retrieve the /users collection groups: Path to retrieve the /groups collection folders: Path to retrieve the /folders collection events: Path to retrieve the /events collection assets: Path to retrieve the /assets collection activities: Path to retrieve the /activities collection devices: Path to retrieve the /devices collection notifiers: Path to retrieve the /notifiers collection notifications: Path to retrieve the /notifications collection receipts: Path to retrieve the /receipts collection</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/asset.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/asset.md b/docs/default-entities/asset.md
new file mode 100644
index 0000000..a5f1b20
--- /dev/null
+++ b/docs/default-entities/asset.md
@@ -0,0 +1,50 @@
+# asset
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'asset'</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>Optional. Asset name</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>owner</td>
+ <td>UUID</td>
+ <td>Required. UUID of the user entity that owns the asset</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>string</td>
+ <td>Required. Relative path to the asset</td>
+ </tr>
+ <tr>
+ <td>content-type</td>
+ <td>string</td>
+ <td>MIME media type that describes the asset (see media types)</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the asset entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the asset entity</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/device.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/device.md b/docs/default-entities/device.md
new file mode 100644
index 0000000..ec6ac8c
--- /dev/null
+++ b/docs/default-entities/device.md
@@ -0,0 +1,35 @@
+# device
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'device'</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>Optional. Device name</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the device entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the device entity, including the device UUID collections: Nested object that contains paths to data entity collections associated with the device. receipts: Receipt entities associated with the device users: User entities associated with the device</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/event.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/event.md b/docs/default-entities/event.md
new file mode 100644
index 0000000..bcbc3fc
--- /dev/null
+++ b/docs/default-entities/event.md
@@ -0,0 +1,60 @@
+# event
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>String</td>
+ <td>Type of entity, in this case 'event'</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>timestamp</td>
+ <td>long</td>
+ <td>Required. UTC timestamp in milliseconds of when the application event occurred</td>
+ </tr>
+ <tr>
+ <td>user</td>
+ <td>UUID</td>
+ <td>Optional. UUID of application user that posted the event</td>
+ </tr>
+ <tr>
+ <td>group</td>
+ <td>UUID</td>
+ <td>Optional. UUID of application group that posted the event</td>
+ </tr>
+ <tr>
+ <td>category</td>
+ <td>string</td>
+ <td>Optional. Category used for organizing similar events</td>
+ </tr>
+ <tr>
+ <td>counters</td>
+ <td>map</td>
+ <td>Optional. Counter used for tracking number of similar events</td>
+ </tr>
+ <tr>
+ <td>message</td>
+ <td>string</td>
+ <td>Optional. Message describing event. Will be null if no message is specified</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the event entity, as well as additional data entities associated with the event. The following properties are included in metadata: path: Path to retrieve the event entity</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/folder.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/folder.md b/docs/default-entities/folder.md
new file mode 100644
index 0000000..04a08ed
--- /dev/null
+++ b/docs/default-entities/folder.md
@@ -0,0 +1,45 @@
+# folder
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'folder'</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>Optional. Folder name</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>owner</td>
+ <td>UUID</td>
+ <td>Required. UUID of the folder's owner</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>string</td>
+ <td>Required. Relative path to the folder</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the folder entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the folder entity</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/group.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/group.md b/docs/default-entities/group.md
new file mode 100644
index 0000000..dbe59b8
--- /dev/null
+++ b/docs/default-entities/group.md
@@ -0,0 +1,40 @@
+# group
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity UUID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'group'</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>string</td>
+ <td>Required. Relative path where the group can be retrieved</td>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>string</td>
+ <td>Optional. Display name for the group entity</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the group entity, as well as additional data entities associated with the group. The following properties are included in metadata: path: Path to retrieve the group entity, including the group UUID sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Path to retrieve a list of roles associated with the group. permissions: Path to retrieve a list of all permissions directly associated with the group. If the group is associated with a role, the list will not include permissions associated with the role entity. collections: Nested object that contains paths to data entity collections associated with the group. activities: Activity entities associated with the group feed: A feed of all activities published by users associated with the group roles: Role entities associated with the group users: User entities associated with the group</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/notification.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/notification.md b/docs/default-entities/notification.md
new file mode 100644
index 0000000..4332ad7
--- /dev/null
+++ b/docs/default-entities/notification.md
@@ -0,0 +1,50 @@
+# notification
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'notification'</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>payloads</td>
+ <td>string</td>
+ <td>Required. The push notifications to be delivered, formatted as key-value pairs of notifier entities and messages (<notifier_name1>:<message1>, <notifier_name2>:<message2>, ...)</td>
+ </tr>
+ <tr>
+ <td>errorMessage</td>
+ <td>string</td>
+ <td>Error message returned by the notification service (APNs or GCM) if the notification fails entirely</td>
+ </tr>
+ <tr>
+ <td>scheduled</td>
+ <td>bool</td>
+ <td>Whether the notification is currently scheduled for delivery</td>
+ </tr>
+ <tr>
+ <td>state</td>
+ <td>string</td>
+ <td>The current delivery status of the notification: FINISHED, SCHEDULED or CANCELED.</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the notification entity, as well as additional data entities associated with the notification. The following properties are included in metadata: path: Path to retrieve the notification object collections: Nested object that contains paths to data entity collections associated with the notification. queue: Device entities scheduled to receive the push notification receipts: Receipt entities for delivery attempts</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/notifier.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/notifier.md b/docs/default-entities/notifier.md
new file mode 100644
index 0000000..bb3a932
--- /dev/null
+++ b/docs/default-entities/notifier.md
@@ -0,0 +1,45 @@
+# notifier
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'notifier'</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>Optional. Notifier display name</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>provider</td>
+ <td>string</td>
+ <td>Required. Push notification provider: apple or google</td>
+ </tr>
+ <tr>
+ <td>environment</td>
+ <td>string</td>
+ <td>Required. The environment that corresponds to your app: development or production</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/receipt.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/receipt.md b/docs/default-entities/receipt.md
new file mode 100644
index 0000000..342af77
--- /dev/null
+++ b/docs/default-entities/receipt.md
@@ -0,0 +1,45 @@
+# receipt
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'notifier'</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>Optional. Notifier display name</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>provider</td>
+ <td>string</td>
+ <td>Required. Push notification provider: apple or google</td>
+ </tr>
+ <tr>
+ <td>environment</td>
+ <td>string</td>
+ <td>Required. The environment that corresponds to your app: development or production</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/role.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/role.md b/docs/default-entities/role.md
new file mode 100644
index 0000000..b2529ff
--- /dev/null
+++ b/docs/default-entities/role.md
@@ -0,0 +1,50 @@
+# role
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'role'</td>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>string</td>
+ <td>Optional. Unique name that identifies the role</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>roleName</td>
+ <td>string</td>
+ <td>Identical to the value of the 'name' property by default</td>
+ </tr>
+ <tr>
+ <td>title</td>
+ <td>string</td>
+ <td>Identical to the value of the 'name' property by default</td>
+ </tr>
+ <tr>
+ <td>inactivity</td>
+ <td>string</td>
+ <td>The amount of time, in milliseconds, that a user or group associated with the role can be inactive before they lose the permissions associated with that role. By default, 'inactivity' is set to 0 so that the user/group never loses the role.</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the role entity, as well as additional data entities associated with the role. The following properties are included in metadata: path: Path to retrieve the role entity sets: Nested object that contains the 'permissions' property. permissions: Path to retrieve a list of all permissions associated with the role. collections: Nested object that contains paths to data entity collections associated with the role. groups: Group entities associated with the role users: User entities associated with the role</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/activity.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/activity.txt b/docs/default-entities/sources/activity.txt
new file mode 100644
index 0000000..a8237f2
--- /dev/null
+++ b/docs/default-entities/sources/activity.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'activity'
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
actor ActivityObject Required. Entity that performed the 'action' of the activity (see JSON Activity Streams 1.0 specification). By default, the UUID of the user who performed the action is recorded as the value of the 'uuid' property of this object.
verb string Required. The action performed by the user (for example, post)
published long Required. UTC timestamp in milliseconds of when the activity was published
content string Optional. Description of the activity
icon MediaLink Optional. Visual representation of a media link resource (see JSON Activity Streams 1.0 specification)
category string Optional. Category used to organize activities
published long Optional. UTC timestamp in milliseconds when the activity was published
object ActivityObject Opti
onal. Object on which the action is performed (see JSON Activity Streams 1.0 specification)
title string Optional. Title or headline for the activity
metadata object A nested, JSON-formatted object that provides the relative path to the activity entity, as well as additional data entities associated with the activity. The following properties are included in metadata: path: Path to retrieve the activity entity, including the UUID of the user entity associated with the activity and the UUID of the activity entity
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/application.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/application.txt b/docs/default-entities/sources/application.txt
new file mode 100644
index 0000000..fde95f1
--- /dev/null
+++ b/docs/default-entities/sources/application.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type String Type of entity, in this case 'application'
name string Optional. Application name
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
accesstokenttl long Optional. Time to live value for an access token obtained within the application
organizationName string Name of the organization the application belongs to
applicationName string Name of the application
title string Optional. Application title
description string Optional. Application description
activated boolean Optional. Whether application is activated
disabled boolean Optional. Whether application is administratively disabled
allowOpenRegistration boolean Optional. Whether application allows any user to register
registrationRequiresEmailConfirmation boolean Optional. Whether registration requires email confirmation
registrationRequiresAdminApproval boolean Optional. Whether registration
requires admin approval
notify_admin_of_new_users boolean Optional. Whether application admins should be notified of new users
metadata object A nested, JSON-formatted object that provides a 'collections' object with the relative paths to all entity collections associated with the application. The following collections are included in metadata by default: users: Path to retrieve the /users collection groups: Path to retrieve the /groups collection folders: Path to retrieve the /folders collection events: Path to retrieve the /events collection assets: Path to retrieve the /assets collection activities: Path to retrieve the /activities collection devices: Path to retrieve the /devices collection notifiers: Path to retrieve the /notifiers collection notifications: Path to retrieve the /notifications collection receipts: Path to retrieve the /receipts collection
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/asset.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/asset.txt b/docs/default-entities/sources/asset.txt
new file mode 100644
index 0000000..463fe44
--- /dev/null
+++ b/docs/default-entities/sources/asset.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'asset'
name string Optional. Asset name
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
owner UUID Required. UUID of the user entity that owns the asset
path string Required. Relative path to the asset
content-type string MIME media type that describes the asset (see media types)
metadata object A nested, JSON-formatted object that provides the relative path to the asset entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the asset entity
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/csv2md.groovy
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/csv2md.groovy b/docs/default-entities/sources/csv2md.groovy
new file mode 100644
index 0000000..9113c35
--- /dev/null
+++ b/docs/default-entities/sources/csv2md.groovy
@@ -0,0 +1,40 @@
+def dir = new File(".");
+def files = dir.list();
+files.each() { fileName ->
+ if ( fileName.endsWith(".txt") ) {
+
+ def baseName = fileName.substring(0, fileName.length() - 4);
+
+ def outputFile = new File("../" + baseName + ".md");
+ outputFile.withWriter('utf-8') { writer ->
+
+ def inputFile = new File(fileName);
+ def count = 0;
+ writer.writeLine "# ${baseName}"
+ writer.writeLine ""
+ writer.writeLine "<!-- DO NOT EDIT THIS GENERATED FILE -->";
+ writer.writeLine "<table class='usergrid-table rest-endpoints-table'>";
+
+ inputFile.eachLine { line ->
+ def parts = line.split("\\t")
+ if ( count == 0 ) {
+ writer.writeLine " <tr>";
+ parts.each() { part ->
+ writer.writeLine " <th>" + part + "</th>";
+ }
+ writer.writeLine " </tr>";
+ } else {
+ writer.writeLine " <tr>";
+ parts.each() { part ->
+ writer.writeLine " <td>" + part + "</td>";
+ }
+ writer.writeLine " </tr>";
+ }
+ count++;
+ }
+ writer.writeLine "</table>";
+
+ }
+ }
+}
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/device.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/device.txt b/docs/default-entities/sources/device.txt
new file mode 100644
index 0000000..a65adec
--- /dev/null
+++ b/docs/default-entities/sources/device.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'device'
name string Optional. Device name
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
metadata object A nested, JSON-formatted object that provides the relative path to the device entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the device entity, including the device UUID collections: Nested object that contains paths to data entity collections associated with the device. receipts: Receipt entities associated with the device users: User entities associated with the device
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/event.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/event.txt b/docs/default-entities/sources/event.txt
new file mode 100644
index 0000000..c4dbcb3
--- /dev/null
+++ b/docs/default-entities/sources/event.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type String Type of entity, in this case 'event'
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
timestamp long Required. UTC timestamp in milliseconds of when the application event occurred
user UUID Optional. UUID of application user that posted the event
group UUID Optional. UUID of application group that posted the event
category string Optional. Category used for organizing similar events
counters map Optional. Counter used for tracking number of similar events
message string Optional. Message describing event. Will be null if no message is specified
metadata object A nested, JSON-formatted object that provides the relative path to the event entity, as well as additional data entities associated with the event. The following properties are included in metadata: path: Path to retrieve the event entity
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/folder.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/folder.txt b/docs/default-entities/sources/folder.txt
new file mode 100644
index 0000000..bf65c85
--- /dev/null
+++ b/docs/default-entities/sources/folder.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'folder'
name string Optional. Folder name
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
owner UUID Required. UUID of the folder's owner
path string Required. Relative path to the folder
metadata object A nested, JSON-formatted object that provides the relative path to the folder entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the folder entity
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/group.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/group.txt b/docs/default-entities/sources/group.txt
new file mode 100644
index 0000000..d31a8e8
--- /dev/null
+++ b/docs/default-entities/sources/group.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity UUID
type string Type of entity, in this case 'group'
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
path string Required. Relative path where the group can be retrieved
title string Optional. Display name for the group entity
metadata object A nested, JSON-formatted object that provides the relative path to the group entity, as well as additional data entities associated with the group. The following properties are included in metadata: path: Path to retrieve the group entity, including the group UUID sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Path to retrieve a list of roles associated with the group. permissions: Path to retrieve a list of all permissions directly associated with the group. If the group is associated with a role, the list will not include permissions associated with the role entity. col
lections: Nested object that contains paths to data entity collections associated with the group. activities: Activity entities associated with the group feed: A feed of all activities published by users associated with the group roles: Role entities associated with the group users: User entities associated with the group
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/notification.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/notification.txt b/docs/default-entities/sources/notification.txt
new file mode 100644
index 0000000..df1e4bf
--- /dev/null
+++ b/docs/default-entities/sources/notification.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'notification'
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
payloads string Required. The push notifications to be delivered, formatted as key-value pairs of notifier entities and messages (<notifier_name1>:<message1>, <notifier_name2>:<message2>, ...)
errorMessage string Error message returned by the notification service (APNs or GCM) if the notification fails entirely
scheduled bool Whether the notification is currently scheduled for delivery
state string The current delivery status of the notification: FINISHED, SCHEDULED or CANCELED.
metadata object A nested, JSON-formatted object that provides the relative path to the notification entity, as well as additional data entities associated with the notification. The following properties are included in metadata: path: Path to retrieve the notification object
collections: Nested object that contains paths to data entity collections associated with the notification. queue: Device entities scheduled to receive the push notification receipts: Receipt entities for delivery attempts
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/notifier.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/notifier.txt b/docs/default-entities/sources/notifier.txt
new file mode 100644
index 0000000..238ff62
--- /dev/null
+++ b/docs/default-entities/sources/notifier.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'notifier'
name string Optional. Notifier display name
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
provider string Required. Push notification provider: apple or google
environment string Required. The environment that corresponds to your app: development or production
metadata object A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/receipt.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/receipt.txt b/docs/default-entities/sources/receipt.txt
new file mode 100644
index 0000000..238ff62
--- /dev/null
+++ b/docs/default-entities/sources/receipt.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'notifier'
name string Optional. Notifier display name
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
provider string Required. Push notification provider: apple or google
environment string Required. The environment that corresponds to your app: development or production
metadata object A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/role.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/role.txt b/docs/default-entities/sources/role.txt
new file mode 100644
index 0000000..20d303f
--- /dev/null
+++ b/docs/default-entities/sources/role.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'role'
name string Optional. Unique name that identifies the role
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
roleName string Identical to the value of the 'name' property by default
title string Identical to the value of the 'name' property by default
inactivity string The amount of time, in milliseconds, that a user or group associated with the role can be inactive before they lose the permissions associated with that role. By default, 'inactivity' is set to 0 so that the user/group never loses the role.
metadata object A nested, JSON-formatted object that provides the relative path to the role entity, as well as additional data entities associated with the role. The following properties are included in metadata: path: Path to retrieve the role entity sets: Nested object that contains the 'permissions' pr
operty. permissions: Path to retrieve a list of all permissions associated with the role. collections: Nested object that contains paths to data entity collections associated with the role. groups: Group entities associated with the role users: User entities associated with the role
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/sources/user.txt
----------------------------------------------------------------------
diff --git a/docs/default-entities/sources/user.txt b/docs/default-entities/sources/user.txt
new file mode 100644
index 0000000..31c3e0d
--- /dev/null
+++ b/docs/default-entities/sources/user.txt
@@ -0,0 +1 @@
+uuid UUID Unique entity ID
type string Type of entity, in this case 'user'
created long UTC timestamp in milliseconds of when the entity was created
modified long UTC timestamp in milliseconds of when the entity was last modified
username string Required. Valid and unique username
activated boolean Whether the user account is activated. Set to 'true' by default when the user is created.
metadata object A nested, JSON-formatted object that provides the relative path to the user entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the user entity sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Deprecated. Use /users/\/roles|username\> instead. Path to retrieve a list of roles associated with the user. permissions: Path to retrieve a list of all permissions directly associated with the user. If the user is associated with a role or group, the list will n
ot include permissions associated with those entities. collections: Nested object that contains paths to data entity collections associated with the user. activities: Activity entities associated with the user devices: Device entities associated with the user feed: A feed of all activities published by the user groups: Group entities associated with the user roles: Role entities associated with the user following: Users that the user is following followers: Users that are following the user
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/default-entities/user.md
----------------------------------------------------------------------
diff --git a/docs/default-entities/user.md b/docs/default-entities/user.md
new file mode 100644
index 0000000..627c559
--- /dev/null
+++ b/docs/default-entities/user.md
@@ -0,0 +1,40 @@
+# user
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>uuid</th>
+ <th>UUID</th>
+ <th>Unique entity ID</th>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>string</td>
+ <td>Type of entity, in this case 'user'</td>
+ </tr>
+ <tr>
+ <td>created</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was created</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>long</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified</td>
+ </tr>
+ <tr>
+ <td>username</td>
+ <td>string</td>
+ <td>Required. Valid and unique username</td>
+ </tr>
+ <tr>
+ <td>activated</td>
+ <td>boolean</td>
+ <td>Whether the user account is activated. Set to 'true' by default when the user is created.</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>object</td>
+ <td>A nested, JSON-formatted object that provides the relative path to the user entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the user entity sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Deprecated. Use /users/\/roles|username\> instead. Path to retrieve a list of roles associated with the user. permissions: Path to retrieve a list of all permissions directly associated with the user. If the user is associated with a role or group, the list will not include permissions associated with those entities. collections: Nested object that contains paths to data entity collections associated with the user. activities: Activity entities associated with the user devices: Device entities associated with the user feed: A feed of all activities published by the user groups: Group entities associated with the user roles: Role entities associated with
the user following: Users that the user is following followers: Users that are following the user</td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/geolocation/geolocation.md
----------------------------------------------------------------------
diff --git a/docs/geolocation/geolocation.md b/docs/geolocation/geolocation.md
new file mode 100644
index 0000000..f22475c
--- /dev/null
+++ b/docs/geolocation/geolocation.md
@@ -0,0 +1,2 @@
+# Geolocation
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index 0078c53..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,144 +0,0 @@
-*****************************
-Apache Usergrid Documentation
-*****************************
-
-.. _intro::
-
-.. toctree::
- :maxdepth: 2
- :caption: Introduction
-
- introduction/usergrid-features
- introduction/data-model
- introduction/async-vs-sync
-
-.. _getting-started:
-
-.. toctree::
- :maxdepth: 2
- :caption: Getting Started
-
- getting-started/creating-a-new-application
- getting-started/creating-account
- getting-started/using-a-sandbox-app
- getting-started/using-the-api.md
-
-.. _data-storage:
-
-.. toctree::
- :maxdepth: 2
- :caption: Data Storage
-
- data-storage/data-store-dbms
- data-storage/optimizing-access
- data-storage/collections
- data-storage/entities
-
-.. _data-queries:
-
-.. toctree::
- :maxdepth: 2
- :caption: Data Queries
-
- data-queries/querying-your-data
- data-queries/query-parameters
- data-queries/operators-and-types
- data-queries/advanced-query-usage
-
-.. _entity-connections:
-
-.. toctree::
- :maxdepth: 2
- :caption: Entity Connections
-
- entity-connections/connecting-entities
- entity-connections/retrieving-entities
- entity-connections/disconnecting-entities
-
-.. _push-notifications:
-
-.. toctree::
- :maxdepth: 2
- :caption: Push Notifications
-
- push-notifications/users-devices
-
-.. _security-and-authentication:
-
-.. toctree::
- :maxdepth: 2
- :caption: Security and Authentication
-
- security-and-auth/roles-and-permissions
-
-.. _user-management-and-social-graph:
-
-.. toctree::
- :maxdepth: 2
- :caption: User Management and Social Graph
-
- user-management/activity
- user-management/groups
-
-.. _geolocation:
-
-.. toctree::
- :maxdepth: 2
- :caption: Geolocation
-
- geolocation
-
-.. _asset-and-file-management:
-
-.. toctree::
- :maxdepth: 2
- :caption: Assets and Files
-
- asset-and-files/assets
- asset-and-files/file-storage-configuration
-
-.. _counters-and-events:
-
-.. toctree::
- :maxdepth: 2
- :caption: Counters and Events
-
- counters-and-events/events-and-counters
-
-.. _organization-and-application-management:
-
-.. toctree::
- :maxdepth: 2
- :caption: Organizations and Applications
-
- orgs-and-apps/applications
- orgs-and-apps/organizations-admins
-
-.. _sdks:
-
-.. toctree::
- :maxdepth: 2
- :caption: Software Development Kits (SDKs)
-
- sdks/ios
- sdks/java
- sdks/javascript
- sdks/usage
-
-.. _references:
-
-.. toctree::
- :maxdepth: 2
- :caption: Reference and other docs
-
- reference/presentations
- reference/videos
-
-.. _installation:
-
-.. toctree::
- :maxdepth: 2
- :caption: Installing the Usergrid stack
-
- installation
-
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..46460d5
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,193 @@
+*****************************
+Apache Usergrid Documentation
+*****************************
+
+.. _intro::
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Introduction
+
+ introduction/usergrid-features
+ introduction/data-model
+ introduction/async-vs-sync
+
+.. _getting-started:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Getting Started
+
+ getting-started/creating-a-new-application
+ getting-started/creating-account
+ getting-started/using-a-sandbox-app
+ getting-started/using-the-api.md
+
+.. _data-storage:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Data Storage
+
+ data-storage/data-store-dbms
+ data-storage/optimizing-access
+ data-storage/collections
+ data-storage/entities
+
+.. _data-queries:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Data Queries
+
+ data-queries/querying-your-data
+ data-queries/query-parameters
+ data-queries/operators-and-types
+ data-queries/advanced-query-usage
+
+.. _entity-connections:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Entity Connections
+
+ entity-connections/connecting-entities
+ entity-connections/retrieving-entities
+ entity-connections/disconnecting-entities
+
+.. _push-notifications:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Push Notifications
+
+ push-notifications/users-devices
+
+.. _security-and-authentication:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Security and Authentication
+
+ security-and-auth/roles-and-permissions
+
+.. _user-management-and-social-graph:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: User Management and Social Graph
+
+ user-management/activity
+ user-management/groups
+
+.. _geolocation:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Geo-location
+
+ geolocation/geolocation
+
+.. _asset-and-file-management:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Assets and Files
+
+ asset-and-files/assets
+ asset-and-files/file-storage-configuration
+
+.. _counters-and-events:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Counters and Events
+
+ counters-and-events/events-and-counters
+
+.. _organization-and-application-management:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Organizations and Applications
+
+ orgs-and-apps/applications
+ orgs-and-apps/organizations-admins
+
+.. _sdks:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Software Development Kits (SDKs)
+
+ sdks/ios
+ sdks/java
+ sdks/javascript
+ sdks/usage
+
+.. _rest-endpoints:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: REST End-Points
+
+ rest-endpoints/access-token
+ rest-endpoints/activities
+ rest-endpoints/admin-users
+ rest-endpoints/collections
+ rest-endpoints/events
+ rest-endpoints/groups
+ rest-endpoints/organization
+ rest-endpoints/roles
+ rest-endpoints/users
+
+.. _default-entities:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Default Entities
+
+ default-entities/activity
+ default-entities/asset
+ default-entities/event
+ default-entities/group
+ default-entities/notifier
+ default-entities/role
+ default-entities/user
+ default-entities/application
+ default-entities/device
+ default-entities/folder
+ default-entities/notification
+ default-entities/receipt
+
+.. _references:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Reference and other docs
+
+ reference/presentations
+ reference/videos
+
+.. _installation:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Installing the Usergrid stack
+
+ installation/deploy-local
+ installation/get-2.0-running-locally
+ installation/get-up-and-running-locally
+ installation/upgrading
+
+.. _other:
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Other (obsolete?)
+
+ entity-connections/relationships
+ data-queries/query-language
+ contribute-code
+ sdks/usage
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/installation/get-up-and-running-locally.md
----------------------------------------------------------------------
diff --git a/docs/installation/get-up-and-running-locally.md b/docs/installation/get-up-and-running-locally.md
new file mode 100644
index 0000000..ba7ffcc
--- /dev/null
+++ b/docs/installation/get-up-and-running-locally.md
@@ -0,0 +1,72 @@
+# Getting Up & Running Locally
+
+## Requirements
+
+* [JDK 1.7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+* [Maven](http://maven.apache.org/)
+
+## Download
+
+### Download2
+
+Start by [downloading our latest code](https://github.com/apache/incubator-usergrid/archive/master.zip) and extract it.
+
+#### Building 3
+
+From the command line, navigate to stack directory and type the following:
+
+ mvn clean install -DskipTests=true
+
+## Running
+
+Usergrid-core contains the persistence layer and shared utilities for powering the Usergrid service. The services layer is contained in usergrid-services and exposes a higher-level API that's used by the usergrid-rest web services tier.
+
+You can run Usergrid from the command-line from the
+jar in the usergrid/standalone project:
+
+ cd launcher; java -jar target/usergrid-launcher-*.jar
+
+After startup, your instance will be available on localhost, port 8080.
+To check it’s running properly, you can try loading our status page:
+
+ curl http://localhost:8080/status
+
+You can also run it as a webapp in Tomcat, by deploying the ROOT.war file generated in the usergrid/rest project.
+
+## Getting Started with the HTTP API
+
+Start by creating an Organization. It’s the top-level structure in Usergrid:
+all Apps and Administrators must belong to an Organization. Here’s how you create one:
+
+ curl -X POST \
+ -d 'organization=myfirstorg&username=myadmin&name=Admin&email=admin@example.com&password=password' \
+ http://localhost:8080/management/organizations
+
+You can see that creating an Organization creates an Administrator in the process. Let’s authenticate as him:
+
+ curl 'http://localhost:8080/management/token?grant_type=password&username=myadmin&password=password'
+
+This will return an access\_token. We’ll use this to authenticate the next two calls.
+Next, let’s create an Application:
+
+ curl -H "Authorization: Bearer [the management token from above]" \
+ -H "Content-Type: application/json" \
+ -X POST -d '{ "name":"myapp" }' \
+ http://localhost:8080/management/orgs/myfirstorg/apps
+
+… And a User for the Application:
+
+ curl -H "Authorization: Bearer [the management token from above]" \
+ -X POST "http://localhost:8080/myfirstorg/myapp/users" \
+ -d '{ "username":"myuser", "password":"mypassword", "email":"user@example.com" }'
+
+Let’s now generate an access token for this Application User:
+
+ curl 'http://localhost:8080/myfirstorg/myapp/token?grant_type=password&username=myuser&password=mypassword'
+
+This will also send back an access\_token, but limited in scope.
+Let’s use it to create a collection with some data in it:
+
+ curl -H "Authorization: Bearer [the user token]" \
+ -X POST -d '[ { "cat":"fluffy" }, { "fish": { "gold":2, "oscar":1 } } ]' \
+ http://localhost:8080/myfirstorg/myapp/pets
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/installation/getting-up-and-running-locally.md
----------------------------------------------------------------------
diff --git a/docs/installation/getting-up-and-running-locally.md b/docs/installation/getting-up-and-running-locally.md
deleted file mode 100644
index ba7ffcc..0000000
--- a/docs/installation/getting-up-and-running-locally.md
+++ /dev/null
@@ -1,72 +0,0 @@
-# Getting Up & Running Locally
-
-## Requirements
-
-* [JDK 1.7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
-* [Maven](http://maven.apache.org/)
-
-## Download
-
-### Download2
-
-Start by [downloading our latest code](https://github.com/apache/incubator-usergrid/archive/master.zip) and extract it.
-
-#### Building 3
-
-From the command line, navigate to stack directory and type the following:
-
- mvn clean install -DskipTests=true
-
-## Running
-
-Usergrid-core contains the persistence layer and shared utilities for powering the Usergrid service. The services layer is contained in usergrid-services and exposes a higher-level API that's used by the usergrid-rest web services tier.
-
-You can run Usergrid from the command-line from the
-jar in the usergrid/standalone project:
-
- cd launcher; java -jar target/usergrid-launcher-*.jar
-
-After startup, your instance will be available on localhost, port 8080.
-To check it’s running properly, you can try loading our status page:
-
- curl http://localhost:8080/status
-
-You can also run it as a webapp in Tomcat, by deploying the ROOT.war file generated in the usergrid/rest project.
-
-## Getting Started with the HTTP API
-
-Start by creating an Organization. It’s the top-level structure in Usergrid:
-all Apps and Administrators must belong to an Organization. Here’s how you create one:
-
- curl -X POST \
- -d 'organization=myfirstorg&username=myadmin&name=Admin&email=admin@example.com&password=password' \
- http://localhost:8080/management/organizations
-
-You can see that creating an Organization creates an Administrator in the process. Let’s authenticate as him:
-
- curl 'http://localhost:8080/management/token?grant_type=password&username=myadmin&password=password'
-
-This will return an access\_token. We’ll use this to authenticate the next two calls.
-Next, let’s create an Application:
-
- curl -H "Authorization: Bearer [the management token from above]" \
- -H "Content-Type: application/json" \
- -X POST -d '{ "name":"myapp" }' \
- http://localhost:8080/management/orgs/myfirstorg/apps
-
-… And a User for the Application:
-
- curl -H "Authorization: Bearer [the management token from above]" \
- -X POST "http://localhost:8080/myfirstorg/myapp/users" \
- -d '{ "username":"myuser", "password":"mypassword", "email":"user@example.com" }'
-
-Let’s now generate an access token for this Application User:
-
- curl 'http://localhost:8080/myfirstorg/myapp/token?grant_type=password&username=myuser&password=mypassword'
-
-This will also send back an access\_token, but limited in scope.
-Let’s use it to create a collection with some data in it:
-
- curl -H "Authorization: Bearer [the user token]" \
- -X POST -d '[ { "cat":"fluffy" }, { "fish": { "gold":2, "oscar":1 } } ]' \
- http://localhost:8080/myfirstorg/myapp/pets
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d2c7b377/docs/rest-endpoints/access-token.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/access-token.md b/docs/rest-endpoints/access-token.md
new file mode 100644
index 0000000..641ae47
--- /dev/null
+++ b/docs/rest-endpoints/access-token.md
@@ -0,0 +1,40 @@
+# access-token
+
+<!-- DO NOT EDIT THIS GENERATED FILE -->
+<table class='usergrid-table rest-endpoints-table'>
+ <tr>
+ <th>End-Point</th>
+ <th>Method</th>
+ <th>Content-type</th>
+ <th>Description</th>
+ <th>Detail</th>
+ </tr>
+ <tr>
+ <td>"/management/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'"</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Obtain an access token (access type = organization)</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>"/management/token '{"grant_type":"password","username":"{username}",:"password":"{password}"}'"</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Obtain an access token (access type = admin user)</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>"/{org_id}/{app_id}/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'"</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Obtain an access token (access type = application)</td>
+ <td>Detail</td>
+ </tr>
+ <tr>
+ <td>"/{org_id}/{app_id}/token '{"grant_type":"password","username":"{username}","password":"{password}"}'"</td>
+ <td>POST</td>
+ <td>application/json</td>
+ <td>Obtain an access token (access type = application user)</td>
+ <td>Detail</td>
+ </tr>
+</table>
[3/3] incubator-usergrid git commit: Better names for installation
documentation.
Posted by sn...@apache.org.
Better names for installation documentation.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/169c2e2a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/169c2e2a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/169c2e2a
Branch: refs/heads/ug2-doc-update
Commit: 169c2e2a4d285a11069f017811eef5275811ffc5
Parents: d2c7b37
Author: Dave Johnson <sn...@apache.org>
Authored: Thu Jul 30 13:17:20 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Thu Jul 30 13:17:20 2015 -0400
----------------------------------------------------------------------
docs/README | 31 ----
docs/README.md | 23 +++
docs/contribute-code.md | 24 ---
docs/index.rst | 9 +-
docs/installation/deploy-local.md | 179 -------------------
docs/installation/get-2.0-running-locally.md | 165 -----------------
docs/installation/get-up-and-running-locally.md | 72 --------
docs/installation/ug1-deploy-to-tomcat.md | 179 +++++++++++++++++++
docs/installation/ug1-launcher-quick-start.md | 72 ++++++++
docs/installation/ug2-deploy-to-tomcat.md | 167 +++++++++++++++++
docs/installation/upgrading.md | 3 -
docs/introduction/async-vs-sync.md | 2 +-
docs/reference/contribute-code.md | 24 +++
13 files changed, 470 insertions(+), 480 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/README
----------------------------------------------------------------------
diff --git a/docs/README b/docs/README
deleted file mode 100644
index e4bb4ac..0000000
--- a/docs/README
+++ /dev/null
@@ -1,31 +0,0 @@
-# Apache Usergrid Docs
-
-We use Sphinx for documentions.
-
-## Pre requirements
-
-* sphinx
-* pip
-
- $ sudo easy_install sphinx
- $ sudo easy_install pip
-
-## How to gererate docs
-
- cd $usergrid/docs
- make clean html
-
-## How to update documentations in Usergrid site
-
-Note that this update is only available for Usergrid PPMC and committers.
-
- $ svn --username "APACHE_USERNAME" --password "APACHE_PASSWORD" co https://svn.apache.org/repos/asf/incubator/usergrid/site/
-
-If you added any files:
- $ svn add <file or directory>
-
-Then commit:
- $ svn ci -m "Some message"
-
-To pull down the latest:
- $ svn update
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..b1d9991
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,23 @@
+# Apache Usergrid Documentation
+
+Uses the Sphinx documentation system with Markdown content.
+
+## Prerequisites
+
+You will need Python, Sphinx and PIP.
+
+ $ sudo easy_install sphinx
+ $ sudo easy_install pip
+
+## How to gererate docs
+
+ cd $usergrid/docs
+ make clean html
+
+## How to update documentations in Usergrid site
+
+For most changes you simply edit the Markdown (.md) and reST (.rst) files where and commit your changes to Git.
+
+Note that Sphinx's native format is reST and not Markdown. This causes some issues. For example, using Sphinx directives in Markdown files sometimes works and sometimes does not.
+
+To update the default-entities and rest-endpoint tables, you should edit the tab-delimited text files (.text) in the source directory, and the run the Groovy scripts there to generate the markdown file representations of those tables.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/contribute-code.md
----------------------------------------------------------------------
diff --git a/docs/contribute-code.md b/docs/contribute-code.md
deleted file mode 100644
index f63c6e8..0000000
--- a/docs/contribute-code.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# How to Contribute Code & Docs
-
-Code Contributions
----
-The Usergrid project has adopted a policy for how code is to be contributed
-by external contributors, and by those who are committers on the project.
-You can read this policy here [Usergrid Contribution Workflow](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+Contribution+Workflow).
-
-Basically, we use GitHub as our code review system. So you should fork the
-apache/incubator-usergrid repo and submit PRs back to the project. Here
-are are step-by-step guide for both both external contributors and committers:
-
-* [External Contributors Guide](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+External+Contributors+Guide)
-* [Usergrid Committers Guide](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+Committers+Guide)
-
-Website and Documentation Contributions
----
-If you want to contribute to the documentation you'll find that we use a different
-system. Our website and documentation is managed in Subversion. Here's a README file
-that explains how to get the website and documentation source code and make changes:
-
-* [README.md for website](http://svn.apache.org/viewvc/incubator/usergrid/site/README.md?view=markup)
-
-* [README.md for documentation](https://github.com/apache/incubator-usergrid/tree/master/docs)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index 46460d5..90ebe1a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -175,10 +175,9 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Installing the Usergrid stack
- installation/deploy-local
- installation/get-2.0-running-locally
- installation/get-up-and-running-locally
- installation/upgrading
+ installation/ug1-deploy-to-tomcat
+ installation/ug1-launcher-quick-start
+ installation/ug2-deploy-to-tomcat
.. _other:
@@ -188,6 +187,6 @@ Apache Usergrid Documentation
entity-connections/relationships
data-queries/query-language
- contribute-code
+ reference/contribute-code
sdks/usage
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/installation/deploy-local.md
----------------------------------------------------------------------
diff --git a/docs/installation/deploy-local.md b/docs/installation/deploy-local.md
deleted file mode 100644
index 0b417da..0000000
--- a/docs/installation/deploy-local.md
+++ /dev/null
@@ -1,179 +0,0 @@
-# Deploying to local Tomcat & Cassandra
-
-This is a guide that explains how to install and run Usergrid using stock Tomcat and Cassandra on a single computer.
-
-NOTE: running Cassandra on a single computer is something you should do ONLY for testing purposes. You don't want to run one node in production even just to start out. To get the benefit of Cassandra's architecture, which is designed to support linear scalability. You should be running a Cassandra cluster with at least three nodes.
-
-For more information:
-
-* [Cassandra FAQ: Can I Start With a Single Node?](http://planetcassandra.org/blog/post/cassandra-faq-can-i-start-with-a-single-node/)
-* [Why don't you start off with a “single & small” Cassandra server](http://stackoverflow.com/questions/18462530/why-dont-you-start-off-with-a-single-small-cassandra-server-as-you-usually)
-
-## Requirements
-
-* [JDK 1.7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
-* [Maven](http://maven.apache.org/)
-
-## Download
-
-Use GitHub to clone the [apache/incubator-usergrid](https://github.com/apache/incubator-usergrid) repo.
-
-Or you can start by [downloading our latest code](https://github.com/apache/incubator-usergrid/archive/master.zip) and extract it.
-
-## Building
-
-From the command line, navigate to `stack` directory and type the following:
-
- mvn clean package -DskipTests=true
-
-Once you are done the Usergrid application will be package as a Java EE WAR file at the location __stack/rest/target/ROOT.war__.
-
-Install and configure Cassandra
----
-
-Install Cassandra, don't edit configuration files as we just want default values for this simple setup. Here are the [instructions for installing Cassandra](http://wiki.apache.org/cassandra/GettingStarted)
-
-Install and configure Tomcat
----
-
-Follow instructions, don't edit configuration files as we just want default values for this simple setup. Here are the [instructions for installing Tomcat 7](http://tomcat.apache.org/tomcat-7.0-doc/setup.html)
-
-Add Usergrid WAR to Tomcat
----
-
-Remove the existing `tomcat/webapps/ROOT` directory.
-
-Place the Usergrid `ROOT.war` file into the `tomcat/webapps` directory
-
-Add Usergrid configuration file to Tomcat
----
-
-Create a ____usergrid-custom.properties____ file and place it in Tomcat's __lib__ directory. You can find an example properties file below that should work well for a local Tomcat & Cassandra setup. You will probably only need to change the properties below to use your email address and preferred password for the install.
-
-
- usergrid.sysadmin.login.allowed=true
- usergrid.sysadmin.login.name=superuser
- usergrid.sysadmin.login.password=pw123
- usergrid.sysadmin.email=me@example.com
- usergrid.sysadmin.login.email=myself@example.com
- usergrid.management.mailer=Myself<my...@example.com>
- usergrid.test-account.admin-user.email=myself@example.com
- usergrid.test-account.admin-user.password=test
-
-Run Usergrid Database & Super User Setup
----
-
-Start Tomcat and use your web browser to visit the URLs below. While you do this you might want to watch the logs under tomcat/logs for clues, just in case anything goes wrong.
-
-Database setup URL - [http://localhost:8080/system/database/setup](http://localhost:8080/system/database/setup)
-
-When prompted to login use the sysadmin credentials that you specified in your __usergrid-custom.properties__ file. Based on the example above that would be superuser and pw123. If the operation is successful you should a message like the one below in your browser. If not, check your logs for clues about what went wrong.
-
- {
- "action" : "cassandra setup",
- "status" : "ok",
- "timestamp" : 1379424622947,
- "duration" : 76
- }
-
-Superuser setup URL - [http://localhost:8080/system/superuser/setup](http://localhost:8080/system/superuser/setup)
-
-You should not be prompted for login because you already logged into for the Database Setup. If setup works, you should see a message like this:
-
- {
- "action" : "superuser setup",
- "status" : "ok",
- "timestamp" : 1379424667936,
- "duration" : 2
- }
-
-Build the Usergrid Console
----
-The Usergrid Console is an admin interface written in JavaScript that connects to your running Usergrid instance. For evaluation purposes, you can run it within Tomcat. Build it by following the steps [here](https://github.com/apache/incubator-usergrid/blob/master/portal/README.md). Once built, copy the directory _portal/build/usergrid-portal_ to _tomcat/webapps_.
-
-
-Login to the Usergrid Console & get started
----
-You should now be able to login to the Usergrid console and start configuring applications, users and more.
-
-You can use an static version of the portal to get started:
-
-http://localhost:8080/usergrid-portal/(http://localhost:8080/usergrid-portal)
-
-
-Example __usergrid-custom.properties__ file
----
-Here's a complete example properties file to get you started.
-
- # Minimal Usergrid configuration properties for local Tomcat and Cassandra
- #
- # The cassandra configuration options.
-
- # The cassandra host to use
- cassandra.url=localhost:9160
-
- # if your cassandra instance requires username/password
- cassandra.username=someuser
- cassandra.password=somepassword
-
- # The strategy to use when creating the keyspace. This is the default.
- # We recommend creating the keyspace with this default, then editing it
- # via the cassandra CLI to meet the client's needs.
- cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy
-
- # The default replication factor for the simple strategy. Again, leave the
- # default, create the app, then use the cassandra cli to set the replication
- # factor options. This can become complicated with different topologies and
- # is more a Cassandra administration issue than a UG issue.
- cassandra.keyspace.strategy.options.replication_factor=1
-
- ######################################################
- # Custom mail transport. Not usually used for local testing
-
- #mail.transport.protocol=smtps
- #mail.smtps.host=email-smtp.us-east-1.amazonaws.com
- #mail.smtps.port=465
- #mail.smtps.auth=true
- #mail.smtps.quitwait=false
- #mail.smtps.username=
- #mail.smtps.password=
-
- ######################################################
- # Admin and test user setup (change these to be their super user
-
- usergrid.sysadmin.login.name=superuser
- usergrid.sysadmin.login.email=myself@example.com <--- Change this
- usergrid.sysadmin.login.password=pw123 <--- Change this
- usergrid.sysadmin.login.allowed=true
- usergrid.sysadmin.email=myself@example.com <--- Change this
-
- # Enable or disable this to require superadmin approval of users
- usergrid.sysadmin.approve.users=false
-
- ######################################################
- # Auto-confirm and sign-up notifications settings
-
- usergrid.management.admin_users_require_confirmation=false
- usergrid.management.admin_users_require_activation=false
- usergrid.management.organizations_require_activation=false
- usergrid.management.notify_sysadmin_of_new_organizations=false
- usergrid.management.notify_sysadmin_of_new_admin_users=false
-
- ######################################################
- # URLs
- # Redirect path when request come in for TLD
-
- usergrid.redirect_root=https://localhost:8080/status
- usergrid.view.management.organizations.organization.activate=https://localhost:8080/accounts/welcome
- usergrid.view.management.organizations.organization.confirm=https://localhost:8080/accounts/welcome
- usergrid.view.management.users.user.activate=https://localhost:8080/accounts/welcome
- usergrid.view.management.users.user.confirm=https://localhost:8080/accounts/welcome
- usergrid.organization.activation.url=https://localhost:8080/management/organizations/%s/activate
- usergrid.admin.activation.url=https://localhost:8080/management/users/%s/activate
- usergrid.admin.resetpw.url=https://localhost:8080/management/users/%s/resetpw
- usergrid.admin.confirmation.url=https://localhost:8080/management/users/%s/confirm
- usergrid.user.activation.url=https://localhost:8080%s/%s/users/%s/activate
- usergrid.user.confirmation.url=https://localhost:8080/%s/%s/users/%s/confirm
- usergrid.user.resetpw.url=https://localhost:8080/%s/%s/users/%s/resetpw
-
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/installation/get-2.0-running-locally.md
----------------------------------------------------------------------
diff --git a/docs/installation/get-2.0-running-locally.md b/docs/installation/get-2.0-running-locally.md
deleted file mode 100644
index f1ff71c..0000000
--- a/docs/installation/get-2.0-running-locally.md
+++ /dev/null
@@ -1,165 +0,0 @@
-# Get 2.0 Running Locally
-
-## Requirements
-
-* [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
-* [Maven 3.2+](http://maven.apache.org/)
-* [Tomcat 7+](https://tomcat.apache.org/download-70.cgi)
-* [Cassandra 1.2.1*](http://cassandra.apache.org/download/)
-* [ElasticSearch 1.4+](https://www.elastic.co/downloads/elasticsearch)
-* [Usergrid 2.0](https://github.com/apache/incubator-usergrid/tree/two-dot-o)
-
-##Running
-
-
-1. Start up Cassandra [^1]
- a. To do this you can navigate to the cassandra folder and run ```./bin/cassandra ```
-2. Start up Elasticsearch
- a. To do this you can navigate to the folder where you extracted elasticsearch and run ```/bin/elasticsearch```
-
-###Running Usergrid
-
-####Build The Java Sdk
-
-1. Navigate to where you cloned the usergrid repo
-2. Navigate to the ```sdks/java``` directory
-3. Run ```mvn clean install```
-
-####Build The Stack Itself
-
-1. Navigate to the ```stack``` directory.
-2. Run ```mvn clean install -DskipTests```
-3. This will generate a war at ```rest/target/ROOT.war```
-
-####Deploying the Stack Locally
-1. Take this war and deploy it on downloaded tomcat.
-1. In the lib directory of the tomcat you must also put usergrid-deployment.properties. ( An example file is provided below)
-1. Start up Tomcat
- a. To do this you can navigate to folder where Tomcat is install and run ```./bin/catalina.sh start```
-1. Go to a web browser and input the following to initilizing the database ```localhost:8080/system/database/setup```.
- a. The credentials it asks for are the admin credentialls and password as defined in the usergrid-deployment.properties.
- b. You can also do a curl call with basic auth to automatically authenticate the call instead of using the web browser.
-1. Then using the same steps as before call ```localhost:8080/system/superuser/setup```
-
-The stack is now ready to be queried against, but to get the most out of it you'll need to initilize and use our portal!
-
-####Running The Portal Locally
-#####Requirments
-[nodejs 0.10+](https://nodejs.org/download/)
-
-1. Make sure you've installed node.js above. Any version above .10 or .10 should work fine.
-2. Navigate to ```incubator-usergrid/portal```.
-3. Open config.js and make sure the override URL is pointing to your local tomcat.
-4. Now in the portal folder run the following command ```./build.sh dev```
-5. The portal should automatically open ready for use!
-
-Now usergrid is fully ready to use! Feel free to query against it or use it however you like!
-
-
-
-Example __usergrid-deployment.properties__ file
----
-```
-# core persistence properties
-
-cassandra.embedded=false
-cassandra.version=1.2.18
-cassandra.timeout=2000
-
-collections.keyspace=Usergrid_Applications
-collections.keyspace.strategy.options=replication_factor:1
-collections.keyspace.strategy.class=org.apache.cassandra.locator.SimpleStrategy
-
-collection.stage.transient.timeout=60
-
-hystrix.threadpool.graph_user.coreSize=40
-hystrix.threadpool.graph_async.coreSize=40
-
-elasticsearch.embedded=false
-elasticsearch.cluster_name=elasticsearch
-elasticsearch.index_prefix=usergrid
-elasticsearch.hosts=127.0.0.1
-elasticsearch.port=9300
-
-elasticsearch.force_refresh=true
-
-index.query.limit.default=100
-
-# Max Cassandra connections, applies to both CP and EM
-cassandra.connections=600
-
-######################################################
-# Minimal Usergrid configuration properties for local Tomcat and Cassandra
-#
-
-cassandra.url=127.0.0.1:9160
-
-cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy
-cassandra.keyspace.strategy.options.replication_factor=1
-
-######################################################
-# Custom mail transport
-
-mail.transport.protocol=smtps
-mail.smtps.host=smtp.gmail.com
-mail.smtps.port=465
-mail.smtps.auth=true
-mail.smtps.username=
-mail.smtps.password=
-mail.smtps.quitwait=false
-
-
-######################################################
-# Admin and test user setup
-
-usergrid.sysadmin.login.name=superuser
-usergrid.sysadmin.login.email=myself@example.com <--- Change this
-usergrid.sysadmin.login.password=pwHERE <--- Change this
-usergrid.sysadmin.login.allowed=true
-usergrid.sysadmin.email=myself@example.com <--- Change this
-
-usergrid.sysadmin.approve.users=false
-usergrid.sysadmin.approve.organizations=false
-
-# Base mailer account - default for all outgoing messages
-usergrid.management.mailer=User <my...@example.com> <--- Change this
-
-usergrid.setup-test-account=true
-
-usergrid.test-account.app=test-app
-usergrid.test-account.organization=test-organization
-usergrid.test-account.admin-user.username=test
-usergrid.test-account.admin-user.name=Test User
-usergrid.test-account.admin-user.email=myself@example.com <---Change this
-usergrid.test-account.admin-user.password=test
-
-######################################################
-# Auto-confirm and sign-up notifications settings
-
-usergrid.management.admin_users_require_confirmation=false
-usergrid.management.admin_users_require_activation=false
-
-usergrid.management.organizations_require_activation=false
-usergrid.management.notify_sysadmin_of_new_organizations=true
-usergrid.management.notify_sysadmin_of_new_admin_users=true
-######################################################
-# URLs
-
-# Redirect path when request come in for TLD
-usergrid.redirect_root=http://localhost:8080/status
-
-usergrid.view.management.organizations.organization.activate=http://localhost:8080/accounts/welcome
-usergrid.view.management.organizations.organization.confirm=http://localhost:8080/accounts/welcome
-usergrid.view.management.users.user.activate=http://localhost:8080/accounts/welcome
-usergrid.view.management.users.user.confirm=http://localhost:8080/accounts/welcome
-
-usergrid.organization.activation.url=http://localhost:8080/management/organizations/%s/activate
-usergrid.admin.activation.url=http://localhost:8080/management/users/%s/activate
-usergrid.admin.resetpw.url=http://localhost:8080/management/users/%s/resetpw
-usergrid.admin.confirmation.url=http://localhost:8080/management/users/%s/confirm
-usergrid.user.activation.url=http://localhost:8080%s/%s/users/%s/activate
-usergrid.user.confirmation.url=http://localhost:8080/%s/%s/users/%s/confirm
-usergrid.user.resetpw.url=http://localhost:8080/%s/%s/users/%s/resetpw
-```
-
-[^1]: You can start up cassandra and elasticsearch in any order but for the sake of ordered lists I put Cassandra first.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/installation/get-up-and-running-locally.md
----------------------------------------------------------------------
diff --git a/docs/installation/get-up-and-running-locally.md b/docs/installation/get-up-and-running-locally.md
deleted file mode 100644
index ba7ffcc..0000000
--- a/docs/installation/get-up-and-running-locally.md
+++ /dev/null
@@ -1,72 +0,0 @@
-# Getting Up & Running Locally
-
-## Requirements
-
-* [JDK 1.7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
-* [Maven](http://maven.apache.org/)
-
-## Download
-
-### Download2
-
-Start by [downloading our latest code](https://github.com/apache/incubator-usergrid/archive/master.zip) and extract it.
-
-#### Building 3
-
-From the command line, navigate to stack directory and type the following:
-
- mvn clean install -DskipTests=true
-
-## Running
-
-Usergrid-core contains the persistence layer and shared utilities for powering the Usergrid service. The services layer is contained in usergrid-services and exposes a higher-level API that's used by the usergrid-rest web services tier.
-
-You can run Usergrid from the command-line from the
-jar in the usergrid/standalone project:
-
- cd launcher; java -jar target/usergrid-launcher-*.jar
-
-After startup, your instance will be available on localhost, port 8080.
-To check it’s running properly, you can try loading our status page:
-
- curl http://localhost:8080/status
-
-You can also run it as a webapp in Tomcat, by deploying the ROOT.war file generated in the usergrid/rest project.
-
-## Getting Started with the HTTP API
-
-Start by creating an Organization. It’s the top-level structure in Usergrid:
-all Apps and Administrators must belong to an Organization. Here’s how you create one:
-
- curl -X POST \
- -d 'organization=myfirstorg&username=myadmin&name=Admin&email=admin@example.com&password=password' \
- http://localhost:8080/management/organizations
-
-You can see that creating an Organization creates an Administrator in the process. Let’s authenticate as him:
-
- curl 'http://localhost:8080/management/token?grant_type=password&username=myadmin&password=password'
-
-This will return an access\_token. We’ll use this to authenticate the next two calls.
-Next, let’s create an Application:
-
- curl -H "Authorization: Bearer [the management token from above]" \
- -H "Content-Type: application/json" \
- -X POST -d '{ "name":"myapp" }' \
- http://localhost:8080/management/orgs/myfirstorg/apps
-
-… And a User for the Application:
-
- curl -H "Authorization: Bearer [the management token from above]" \
- -X POST "http://localhost:8080/myfirstorg/myapp/users" \
- -d '{ "username":"myuser", "password":"mypassword", "email":"user@example.com" }'
-
-Let’s now generate an access token for this Application User:
-
- curl 'http://localhost:8080/myfirstorg/myapp/token?grant_type=password&username=myuser&password=mypassword'
-
-This will also send back an access\_token, but limited in scope.
-Let’s use it to create a collection with some data in it:
-
- curl -H "Authorization: Bearer [the user token]" \
- -X POST -d '[ { "cat":"fluffy" }, { "fish": { "gold":2, "oscar":1 } } ]' \
- http://localhost:8080/myfirstorg/myapp/pets
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/installation/ug1-deploy-to-tomcat.md
----------------------------------------------------------------------
diff --git a/docs/installation/ug1-deploy-to-tomcat.md b/docs/installation/ug1-deploy-to-tomcat.md
new file mode 100644
index 0000000..5356a94
--- /dev/null
+++ b/docs/installation/ug1-deploy-to-tomcat.md
@@ -0,0 +1,179 @@
+# Usegrid 1: Deploying to Tomcat
+
+This is a guide that explains how to install and run Usergrid using stock Tomcat and Cassandra on a single computer.
+
+NOTE: running Cassandra on a single computer is something you should do ONLY for testing purposes. You don't want to run one node in production even just to start out. To get the benefit of Cassandra's architecture, which is designed to support linear scalability. You should be running a Cassandra cluster with at least three nodes.
+
+For more information:
+
+* [Cassandra FAQ: Can I Start With a Single Node?](http://planetcassandra.org/blog/post/cassandra-faq-can-i-start-with-a-single-node/)
+* [Why don't you start off with a “single & small” Cassandra server](http://stackoverflow.com/questions/18462530/why-dont-you-start-off-with-a-single-small-cassandra-server-as-you-usually)
+
+## Requirements
+
+* [JDK 1.7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+* [Maven](http://maven.apache.org/)
+
+## Download
+
+Use GitHub to clone the [apache/incubator-usergrid](https://github.com/apache/incubator-usergrid) repo.
+
+Or you can start by [downloading our latest code](https://github.com/apache/incubator-usergrid/archive/master.zip) and extract it.
+
+## Building
+
+From the command line, navigate to `stack` directory and type the following:
+
+ mvn clean package -DskipTests=true
+
+Once you are done the Usergrid application will be package as a Java EE WAR file at the location __stack/rest/target/ROOT.war__.
+
+Install and configure Cassandra
+---
+
+Install Cassandra, don't edit configuration files as we just want default values for this simple setup. Here are the [instructions for installing Cassandra](http://wiki.apache.org/cassandra/GettingStarted)
+
+Install and configure Tomcat
+---
+
+Follow instructions, don't edit configuration files as we just want default values for this simple setup. Here are the [instructions for installing Tomcat 7](http://tomcat.apache.org/tomcat-7.0-doc/setup.html)
+
+Add Usergrid WAR to Tomcat
+---
+
+Remove the existing `tomcat/webapps/ROOT` directory.
+
+Place the Usergrid `ROOT.war` file into the `tomcat/webapps` directory
+
+Add Usergrid configuration file to Tomcat
+---
+
+Create a ____usergrid-custom.properties____ file and place it in Tomcat's __lib__ directory. You can find an example properties file below that should work well for a local Tomcat & Cassandra setup. You will probably only need to change the properties below to use your email address and preferred password for the install.
+
+
+ usergrid.sysadmin.login.allowed=true
+ usergrid.sysadmin.login.name=superuser
+ usergrid.sysadmin.login.password=pw123
+ usergrid.sysadmin.email=me@example.com
+ usergrid.sysadmin.login.email=myself@example.com
+ usergrid.management.mailer=Myself<my...@example.com>
+ usergrid.test-account.admin-user.email=myself@example.com
+ usergrid.test-account.admin-user.password=test
+
+Run Usergrid Database & Super User Setup
+---
+
+Start Tomcat and use your web browser to visit the URLs below. While you do this you might want to watch the logs under tomcat/logs for clues, just in case anything goes wrong.
+
+Database setup URL - [http://localhost:8080/system/database/setup](http://localhost:8080/system/database/setup)
+
+When prompted to login use the sysadmin credentials that you specified in your __usergrid-custom.properties__ file. Based on the example above that would be superuser and pw123. If the operation is successful you should a message like the one below in your browser. If not, check your logs for clues about what went wrong.
+
+ {
+ "action" : "cassandra setup",
+ "status" : "ok",
+ "timestamp" : 1379424622947,
+ "duration" : 76
+ }
+
+Superuser setup URL - [http://localhost:8080/system/superuser/setup](http://localhost:8080/system/superuser/setup)
+
+You should not be prompted for login because you already logged into for the Database Setup. If setup works, you should see a message like this:
+
+ {
+ "action" : "superuser setup",
+ "status" : "ok",
+ "timestamp" : 1379424667936,
+ "duration" : 2
+ }
+
+Build the Usergrid Console
+---
+The Usergrid Console is an admin interface written in JavaScript that connects to your running Usergrid instance. For evaluation purposes, you can run it within Tomcat. Build it by following the steps [here](https://github.com/apache/incubator-usergrid/blob/master/portal/README.md). Once built, copy the directory _portal/build/usergrid-portal_ to _tomcat/webapps_.
+
+
+Login to the Usergrid Console & get started
+---
+You should now be able to login to the Usergrid console and start configuring applications, users and more.
+
+You can use an static version of the portal to get started:
+
+http://localhost:8080/usergrid-portal/(http://localhost:8080/usergrid-portal)
+
+
+Example __usergrid-custom.properties__ file
+---
+Here's a complete example properties file to get you started.
+
+ # Minimal Usergrid configuration properties for local Tomcat and Cassandra
+ #
+ # The cassandra configuration options.
+
+ # The cassandra host to use
+ cassandra.url=localhost:9160
+
+ # if your cassandra instance requires username/password
+ cassandra.username=someuser
+ cassandra.password=somepassword
+
+ # The strategy to use when creating the keyspace. This is the default.
+ # We recommend creating the keyspace with this default, then editing it
+ # via the cassandra CLI to meet the client's needs.
+ cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy
+
+ # The default replication factor for the simple strategy. Again, leave the
+ # default, create the app, then use the cassandra cli to set the replication
+ # factor options. This can become complicated with different topologies and
+ # is more a Cassandra administration issue than a UG issue.
+ cassandra.keyspace.strategy.options.replication_factor=1
+
+ ######################################################
+ # Custom mail transport. Not usually used for local testing
+
+ #mail.transport.protocol=smtps
+ #mail.smtps.host=email-smtp.us-east-1.amazonaws.com
+ #mail.smtps.port=465
+ #mail.smtps.auth=true
+ #mail.smtps.quitwait=false
+ #mail.smtps.username=
+ #mail.smtps.password=
+
+ ######################################################
+ # Admin and test user setup (change these to be their super user
+
+ usergrid.sysadmin.login.name=superuser
+ usergrid.sysadmin.login.email=myself@example.com <--- Change this
+ usergrid.sysadmin.login.password=pw123 <--- Change this
+ usergrid.sysadmin.login.allowed=true
+ usergrid.sysadmin.email=myself@example.com <--- Change this
+
+ # Enable or disable this to require superadmin approval of users
+ usergrid.sysadmin.approve.users=false
+
+ ######################################################
+ # Auto-confirm and sign-up notifications settings
+
+ usergrid.management.admin_users_require_confirmation=false
+ usergrid.management.admin_users_require_activation=false
+ usergrid.management.organizations_require_activation=false
+ usergrid.management.notify_sysadmin_of_new_organizations=false
+ usergrid.management.notify_sysadmin_of_new_admin_users=false
+
+ ######################################################
+ # URLs
+ # Redirect path when request come in for TLD
+
+ usergrid.redirect_root=https://localhost:8080/status
+ usergrid.view.management.organizations.organization.activate=https://localhost:8080/accounts/welcome
+ usergrid.view.management.organizations.organization.confirm=https://localhost:8080/accounts/welcome
+ usergrid.view.management.users.user.activate=https://localhost:8080/accounts/welcome
+ usergrid.view.management.users.user.confirm=https://localhost:8080/accounts/welcome
+ usergrid.organization.activation.url=https://localhost:8080/management/organizations/%s/activate
+ usergrid.admin.activation.url=https://localhost:8080/management/users/%s/activate
+ usergrid.admin.resetpw.url=https://localhost:8080/management/users/%s/resetpw
+ usergrid.admin.confirmation.url=https://localhost:8080/management/users/%s/confirm
+ usergrid.user.activation.url=https://localhost:8080%s/%s/users/%s/activate
+ usergrid.user.confirmation.url=https://localhost:8080/%s/%s/users/%s/confirm
+ usergrid.user.resetpw.url=https://localhost:8080/%s/%s/users/%s/resetpw
+
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/installation/ug1-launcher-quick-start.md
----------------------------------------------------------------------
diff --git a/docs/installation/ug1-launcher-quick-start.md b/docs/installation/ug1-launcher-quick-start.md
new file mode 100644
index 0000000..8399522
--- /dev/null
+++ b/docs/installation/ug1-launcher-quick-start.md
@@ -0,0 +1,72 @@
+# Usegrid 1: Launcher Quick-start
+
+## Requirements
+
+* [JDK 1.7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+* [Maven](http://maven.apache.org/)
+
+## Download
+
+### Download2
+
+Start by [downloading our latest code](https://github.com/apache/incubator-usergrid/archive/master.zip) and extract it.
+
+#### Building 3
+
+From the command line, navigate to stack directory and type the following:
+
+ mvn clean install -DskipTests=true
+
+## Running
+
+Usergrid-core contains the persistence layer and shared utilities for powering the Usergrid service. The services layer is contained in usergrid-services and exposes a higher-level API that's used by the usergrid-rest web services tier.
+
+You can run Usergrid from the command-line from the
+jar in the usergrid/standalone project:
+
+ cd launcher; java -jar target/usergrid-launcher-*.jar
+
+After startup, your instance will be available on localhost, port 8080.
+To check it’s running properly, you can try loading our status page:
+
+ curl http://localhost:8080/status
+
+You can also run it as a webapp in Tomcat, by deploying the ROOT.war file generated in the usergrid/rest project.
+
+## Getting Started with the HTTP API
+
+Start by creating an Organization. It’s the top-level structure in Usergrid:
+all Apps and Administrators must belong to an Organization. Here’s how you create one:
+
+ curl -X POST \
+ -d 'organization=myfirstorg&username=myadmin&name=Admin&email=admin@example.com&password=password' \
+ http://localhost:8080/management/organizations
+
+You can see that creating an Organization creates an Administrator in the process. Let’s authenticate as him:
+
+ curl 'http://localhost:8080/management/token?grant_type=password&username=myadmin&password=password'
+
+This will return an access\_token. We’ll use this to authenticate the next two calls.
+Next, let’s create an Application:
+
+ curl -H "Authorization: Bearer [the management token from above]" \
+ -H "Content-Type: application/json" \
+ -X POST -d '{ "name":"myapp" }' \
+ http://localhost:8080/management/orgs/myfirstorg/apps
+
+… And a User for the Application:
+
+ curl -H "Authorization: Bearer [the management token from above]" \
+ -X POST "http://localhost:8080/myfirstorg/myapp/users" \
+ -d '{ "username":"myuser", "password":"mypassword", "email":"user@example.com" }'
+
+Let’s now generate an access token for this Application User:
+
+ curl 'http://localhost:8080/myfirstorg/myapp/token?grant_type=password&username=myuser&password=mypassword'
+
+This will also send back an access\_token, but limited in scope.
+Let’s use it to create a collection with some data in it:
+
+ curl -H "Authorization: Bearer [the user token]" \
+ -X POST -d '[ { "cat":"fluffy" }, { "fish": { "gold":2, "oscar":1 } } ]' \
+ http://localhost:8080/myfirstorg/myapp/pets
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/installation/ug2-deploy-to-tomcat.md
----------------------------------------------------------------------
diff --git a/docs/installation/ug2-deploy-to-tomcat.md b/docs/installation/ug2-deploy-to-tomcat.md
new file mode 100644
index 0000000..10ed013
--- /dev/null
+++ b/docs/installation/ug2-deploy-to-tomcat.md
@@ -0,0 +1,167 @@
+# Usergrid 2: Deploy to Tomcat
+
+__NOTE__: Beware that Usergrid 2 is UNRELEASED SOFTWARE
+
+## Requirements
+
+* [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+* [Maven 3.2+](http://maven.apache.org/)
+* [Tomcat 7+](https://tomcat.apache.org/download-70.cgi)
+* [Cassandra 1.2.1*](http://cassandra.apache.org/download/)
+* [ElasticSearch 1.4+](https://www.elastic.co/downloads/elasticsearch)
+* [Usergrid 2.0](https://github.com/apache/incubator-usergrid/tree/two-dot-o)
+
+##Running
+
+
+1. Start up Cassandra [^1]
+ a. To do this you can navigate to the cassandra folder and run ```./bin/cassandra ```
+2. Start up Elasticsearch
+ a. To do this you can navigate to the folder where you extracted elasticsearch and run ```/bin/elasticsearch```
+
+###Running Usergrid
+
+####Build The Java Sdk
+
+1. Navigate to where you cloned the usergrid repo
+2. Navigate to the ```sdks/java``` directory
+3. Run ```mvn clean install```
+
+####Build The Stack Itself
+
+1. Navigate to the ```stack``` directory.
+2. Run ```mvn clean install -DskipTests```
+3. This will generate a war at ```rest/target/ROOT.war```
+
+####Deploying the Stack Locally
+1. Take this war and deploy it on downloaded tomcat.
+1. In the lib directory of the tomcat you must also put usergrid-deployment.properties. ( An example file is provided below)
+1. Start up Tomcat
+ a. To do this you can navigate to folder where Tomcat is install and run ```./bin/catalina.sh start```
+1. Go to a web browser and input the following to initilizing the database ```localhost:8080/system/database/setup```.
+ a. The credentials it asks for are the admin credentialls and password as defined in the usergrid-deployment.properties.
+ b. You can also do a curl call with basic auth to automatically authenticate the call instead of using the web browser.
+1. Then using the same steps as before call ```localhost:8080/system/superuser/setup```
+
+The stack is now ready to be queried against, but to get the most out of it you'll need to initilize and use our portal!
+
+####Running The Portal Locally
+#####Requirments
+[nodejs 0.10+](https://nodejs.org/download/)
+
+1. Make sure you've installed node.js above. Any version above .10 or .10 should work fine.
+2. Navigate to ```incubator-usergrid/portal```.
+3. Open config.js and make sure the override URL is pointing to your local tomcat.
+4. Now in the portal folder run the following command ```./build.sh dev```
+5. The portal should automatically open ready for use!
+
+Now usergrid is fully ready to use! Feel free to query against it or use it however you like!
+
+
+
+Example __usergrid-deployment.properties__ file
+---
+```
+# core persistence properties
+
+cassandra.embedded=false
+cassandra.version=1.2.18
+cassandra.timeout=2000
+
+collections.keyspace=Usergrid_Applications
+collections.keyspace.strategy.options=replication_factor:1
+collections.keyspace.strategy.class=org.apache.cassandra.locator.SimpleStrategy
+
+collection.stage.transient.timeout=60
+
+hystrix.threadpool.graph_user.coreSize=40
+hystrix.threadpool.graph_async.coreSize=40
+
+elasticsearch.embedded=false
+elasticsearch.cluster_name=elasticsearch
+elasticsearch.index_prefix=usergrid
+elasticsearch.hosts=127.0.0.1
+elasticsearch.port=9300
+
+elasticsearch.force_refresh=true
+
+index.query.limit.default=100
+
+# Max Cassandra connections, applies to both CP and EM
+cassandra.connections=600
+
+######################################################
+# Minimal Usergrid configuration properties for local Tomcat and Cassandra
+#
+
+cassandra.url=127.0.0.1:9160
+
+cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy
+cassandra.keyspace.strategy.options.replication_factor=1
+
+######################################################
+# Custom mail transport
+
+mail.transport.protocol=smtps
+mail.smtps.host=smtp.gmail.com
+mail.smtps.port=465
+mail.smtps.auth=true
+mail.smtps.username=
+mail.smtps.password=
+mail.smtps.quitwait=false
+
+
+######################################################
+# Admin and test user setup
+
+usergrid.sysadmin.login.name=superuser
+usergrid.sysadmin.login.email=myself@example.com <--- Change this
+usergrid.sysadmin.login.password=pwHERE <--- Change this
+usergrid.sysadmin.login.allowed=true
+usergrid.sysadmin.email=myself@example.com <--- Change this
+
+usergrid.sysadmin.approve.users=false
+usergrid.sysadmin.approve.organizations=false
+
+# Base mailer account - default for all outgoing messages
+usergrid.management.mailer=User <my...@example.com> <--- Change this
+
+usergrid.setup-test-account=true
+
+usergrid.test-account.app=test-app
+usergrid.test-account.organization=test-organization
+usergrid.test-account.admin-user.username=test
+usergrid.test-account.admin-user.name=Test User
+usergrid.test-account.admin-user.email=myself@example.com <---Change this
+usergrid.test-account.admin-user.password=test
+
+######################################################
+# Auto-confirm and sign-up notifications settings
+
+usergrid.management.admin_users_require_confirmation=false
+usergrid.management.admin_users_require_activation=false
+
+usergrid.management.organizations_require_activation=false
+usergrid.management.notify_sysadmin_of_new_organizations=true
+usergrid.management.notify_sysadmin_of_new_admin_users=true
+######################################################
+# URLs
+
+# Redirect path when request come in for TLD
+usergrid.redirect_root=http://localhost:8080/status
+
+usergrid.view.management.organizations.organization.activate=http://localhost:8080/accounts/welcome
+usergrid.view.management.organizations.organization.confirm=http://localhost:8080/accounts/welcome
+usergrid.view.management.users.user.activate=http://localhost:8080/accounts/welcome
+usergrid.view.management.users.user.confirm=http://localhost:8080/accounts/welcome
+
+usergrid.organization.activation.url=http://localhost:8080/management/organizations/%s/activate
+usergrid.admin.activation.url=http://localhost:8080/management/users/%s/activate
+usergrid.admin.resetpw.url=http://localhost:8080/management/users/%s/resetpw
+usergrid.admin.confirmation.url=http://localhost:8080/management/users/%s/confirm
+usergrid.user.activation.url=http://localhost:8080%s/%s/users/%s/activate
+usergrid.user.confirmation.url=http://localhost:8080/%s/%s/users/%s/confirm
+usergrid.user.resetpw.url=http://localhost:8080/%s/%s/users/%s/resetpw
+```
+
+[^1]: You can start up cassandra and elasticsearch in any order but for the sake of ordered lists I put Cassandra first.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/installation/upgrading.md
----------------------------------------------------------------------
diff --git a/docs/installation/upgrading.md b/docs/installation/upgrading.md
deleted file mode 100644
index 0df0935..0000000
--- a/docs/installation/upgrading.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Upgrading from Previous Versions
-
-If you built and used a previous version of Usergrid, that may be using a different schema, we have an easy built-in tool to audit your Cassandra column family structure and upgrade the dataset as necessary. Once you have pulled, built and launched the new version of Usergrid, just hit [http://localhost:8080/system/database/setup](http://localhost:8080/system/database/setup) to run the upgrade tool.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/introduction/async-vs-sync.md
----------------------------------------------------------------------
diff --git a/docs/introduction/async-vs-sync.md b/docs/introduction/async-vs-sync.md
index 2f1eb32..fe1f721 100644
--- a/docs/introduction/async-vs-sync.md
+++ b/docs/introduction/async-vs-sync.md
@@ -1,4 +1,4 @@
-# Asynchronous vs. synchronous calls
+# Async vs. sync calls
The Usergrid SDKs work by making RESTful API calls from your application to the API. In some cases, both synchronous and asynchronous calls are supported for most methods, as in the case of the Usergrid Android SDK, while in others only asynchronous calls are supported, as in the Usergrid JavaScript SDK. The following is a brief explanation of synchronous vs. asynchronous API calls.
## Synchronous
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/169c2e2a/docs/reference/contribute-code.md
----------------------------------------------------------------------
diff --git a/docs/reference/contribute-code.md b/docs/reference/contribute-code.md
new file mode 100644
index 0000000..f63c6e8
--- /dev/null
+++ b/docs/reference/contribute-code.md
@@ -0,0 +1,24 @@
+# How to Contribute Code & Docs
+
+Code Contributions
+---
+The Usergrid project has adopted a policy for how code is to be contributed
+by external contributors, and by those who are committers on the project.
+You can read this policy here [Usergrid Contribution Workflow](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+Contribution+Workflow).
+
+Basically, we use GitHub as our code review system. So you should fork the
+apache/incubator-usergrid repo and submit PRs back to the project. Here
+are are step-by-step guide for both both external contributors and committers:
+
+* [External Contributors Guide](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+External+Contributors+Guide)
+* [Usergrid Committers Guide](https://cwiki.apache.org/confluence/display/usergrid/Usergrid+Committers+Guide)
+
+Website and Documentation Contributions
+---
+If you want to contribute to the documentation you'll find that we use a different
+system. Our website and documentation is managed in Subversion. Here's a README file
+that explains how to get the website and documentation source code and make changes:
+
+* [README.md for website](http://svn.apache.org/viewvc/incubator/usergrid/site/README.md?view=markup)
+
+* [README.md for documentation](https://github.com/apache/incubator-usergrid/tree/master/docs)
\ No newline at end of file