You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by su...@apache.org on 2014/08/08 04:08:19 UTC
svn commit: r1616662 [5/5] - in /incubator/usergrid/site: content/community/
content/img/ publish/community/ publish/docs/access-token/
publish/docs/activity/ publish/docs/admin-portal/ publish/docs/admin-user/
publish/docs/app-security/ publish/docs/a...
Modified: incubator/usergrid/site/publish/docs/role/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/role/index.html?rev=1616662&r1=1616661&r2=1616662&view=diff
==============================================================================
--- incubator/usergrid/site/publish/docs/role/index.html (original)
+++ incubator/usergrid/site/publish/docs/role/index.html Fri Aug 8 02:08:18 2014
@@ -235,12 +235,16 @@
<p>POST /{org_id}/{app_id}/roles {request body}</p>
<h3 id="parameters">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>arg uuid|string org_id</p></td>
@@ -259,13 +263,17 @@
</td>
</tr>
</tbody>
-</table><h3 id="example---request">Example - Request</h3>
+</table>
+<h3 id="example---request">Example - Request</h3>
<ul>
<li><a href="#curl_create_role">cURL</a></li>
<li><a href="#javascript_create_role">JavaScript (HTML5)</a></li>
<li><a href="#ruby_create_role">Ruby</a></li>
<li><a href="#nodejs_create_role">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/ -d '{"name":"manager","title":"Manager"}'</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/ -d '{"name":"manager","title":"Manager"}'</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -324,10 +332,12 @@ client.request(options, function (err, d
<p>GET /{org_id}/{app_id}/roles</p>
<h3 id="parameters-1">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -338,13 +348,17 @@ client.request(options, function (err, d
<td align="left">Application UUID or application name</td>
</tr>
</tbody>
-</table><h3 id="example---request-1">Example - Request</h3>
+</table>
+<h3 id="example---request-1">Example - Request</h3>
<ul>
<li><a href="#curl_get_roles">cURL</a></li>
<li><a href="#javascript_get_roles">JavaScript (HTML5)</a></li>
<li><a href="#ruby_get_roles">Ruby</a></li>
<li><a href="#nodejs_get_roles">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/roles"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/roles"</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -443,10 +457,12 @@ client.request(options, function (err, d
<p>DELETE /{org_id}/{app_id}/roles/{rolename}</p>
<h3 id="parameters-2">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -461,13 +477,17 @@ client.request(options, function (err, d
<td align="left">Role name</td>
</tr>
</tbody>
-</table><h3 id="example---request-2">Example - Request</h3>
+</table>
+<h3 id="example---request-2">Example - Request</h3>
<ul>
<li><a href="#curl_delete_role">cURL</a></li>
<li><a href="#javascript_delete_role">JavaScript (HTML5)</a></li>
<li><a href="#ruby_delete_role">Ruby</a></li>
<li><a href="#nodejs_delete_role">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/roles/manager"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/roles/manager"</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -527,10 +547,12 @@ client.request(options, function (err, d
<p>GET /{org_id}/{app_id}/roles/{rolename|role_id}/permissions</p>
<h3 id="parameters-3">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -545,13 +567,17 @@ client.request(options, function (err, d
<td align="left">Role UUID or role name</td>
</tr>
</tbody>
-</table><h3 id="example---request-3">Example - Request</h3>
+</table>
+<h3 id="example---request-3">Example - Request</h3>
<ul>
<li><a href="#curl_get_role_permissions">cURL</a></li>
<li><a href="#javascript_get_role_permissions">JavaScript (HTML5)</a></li>
<li><a href="#ruby_get_role_permissions">Ruby</a></li>
<li><a href="#nodejs_get_role_permissions">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/roles/manager/permissions"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/roles/manager/permissions"</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -588,12 +614,16 @@ client.request(options, function (err, d
<p>POST /{org_id}/{app_id}/roles/{rolename|role_id}/permissions {request body}</p>
<h3 id="parameters-4">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>arg uuid|string org_id</p></td>
@@ -616,13 +646,17 @@ client.request(options, function (err, d
</td>
</tr>
</tbody>
-</table><h3 id="example---request-4">Example - Request</h3>
+</table>
+<h3 id="example---request-4">Example - Request</h3>
<ul>
<li><a href="#curl_add_role_permissions">cURL</a></li>
<li><a href="#javascript_add_role_permissions">JavaScript (HTML5)</a></li>
<li><a href="#ruby_add_role_permissions">Ruby</a></li>
<li><a href="#nodejs_add_role_permissions">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/manager/permissions" -d '{"permission":"get,put,post,delete:/users/me/groups" }'</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/manager/permissions" -d '{"permission":"get,put,post,delete:/users/me/groups" }'</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -660,10 +694,12 @@ client.request(options, function (err, d
<p>DELETE /{org_id}/{app_id}/roles/{rolename|role_id}/permissions?permission={permissions_spec}</p>
<h3 id="parameters-5">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">uuid|string org_id</td>
@@ -682,13 +718,17 @@ client.request(options, function (err, d
<td align="left">The pattern on which the permissions were granted.</td>
</tr>
</tbody>
-</table><h3 id="example---request-5">Example - Request</h3>
+</table>
+<h3 id="example---request-5">Example - Request</h3>
<ul>
<li><a href="#curl_delete_role_permissions">cURL</a></li>
<li><a href="#javascript_delete_role_permissions">JavaScript (HTML5)</a></li>
<li><a href="#ruby_delete_role_permissions">Ruby</a></li>
<li><a href="#nodejs_delete_role_permissions">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X DELETE -H "authorization: Bearer INSERT_BEARER_TOKEN_HERE" "https://api.usergrid.com/my-org/my-app/roles/default/permissions?permission=get,post,delete:/notes"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X DELETE -H "authorization: Bearer INSERT_BEARER_TOKEN_HERE" "https://api.usergrid.com/my-org/my-app/roles/default/permissions?permission=get,post,delete:/notes"</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -753,10 +793,12 @@ client.request(options, function (err, d
<pre><code>POST /{org_id}/{app_id}/users/{uuid|username}/roles/{role_id}</code></pre>
<h3 id="parameters-6">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -775,13 +817,17 @@ client.request(options, function (err, d
<td align="left">User UUID or username</td>
</tr>
</tbody>
-</table><h3 id="example---request-6">Example - Request</h3>
+</table>
+<h3 id="example---request-6">Example - Request</h3>
<ul>
<li><a href="#curl_add_role_user">cURL</a></li>
<li><a href="#javascript_add_role_user">JavaScript (HTML5)</a></li>
<li><a href="#ruby_add_role_user">Ruby</a></li>
<li><a href="#nodejs_add_role_user">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/manager/users/john.doe"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/roles/manager/users/john.doe"</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -849,10 +895,12 @@ client.request(options, function (err, d
<pre><code>GET /{org_id}/{app_id}/roles/{role_id}/users</code></pre>
<h3 id="parameters-7">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -867,13 +915,17 @@ client.request(options, function (err, d
<td align="left">Role UUID or role name</td>
</tr>
</tbody>
-</table><h3 id="example---request-7">Example - Request</h3>
+</table>
+<h3 id="example---request-7">Example - Request</h3>
<ul>
<li><a href="#curl_get_role_users">cURL</a></li>
<li><a href="#javascript_get_role_users">JavaScript (HTML5)</a></li>
<li><a href="#ruby_get_role_users">Ruby</a></li>
<li><a href="#nodejs_get_role_users">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/roles/manager/users"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/roles/manager/users"</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -944,10 +996,12 @@ client.request(options, function (err, d
<pre><code>DELETE /{org_id}/{app_id}/roles/{role_id}/users/{uuid|username}</code></pre>
<h3 id="parameters-8">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -966,13 +1020,17 @@ client.request(options, function (err, d
<td align="left">User UUID or username</td>
</tr>
</tbody>
-</table><h3 id="example---request-8">Example - Request</h3>
+</table>
+<h3 id="example---request-8">Example - Request</h3>
<ul>
<li><a href="#curl_delete_role_user">cURL</a></li>
<li><a href="#javascript_delete_role_user">JavaScript (HTML5)</a></li>
<li><a href="#ruby_delete_role_user">Ruby</a></li>
<li><a href="#nodejs_delete_role_user">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/roles/manager/users/john.doe"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/roles/manager/users/john.doe"</code></pre>
<p>It is recommended that you use the <a href="http://apigee.com/usergrid">Admin Portal</a> for administrative activities instead of using JavaScript to do them programmatically in your app.</p>
<p><strong>Note:</strong>You can see the response below in the Admin Portal by using the <a href="/docs/usergrid/content/displaying-app-services-api-calls-curl-commands">JavaScript Console</a>.</p>
<p>The example assumes use of the <a href="https://github.com/scottganyo/usergrid_iron">Ruby SDK</a>.</p>
@@ -1046,11 +1104,13 @@ curl -X DELETE "https://api.usergrid.com
<h3 id="general-properties">General properties</h3>
<p>Roles have the following general properties.</p>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Property</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">uuid</td>
@@ -1090,27 +1150,35 @@ curl -X DELETE "https://api.usergrid.com
<td align="left">Role title</td>
</tr>
</tbody>
-</table><h3 id="set-properties">Set properties</h3>
+</table>
+<h3 id="set-properties">Set properties</h3>
<p>Roles have the following set property.</p>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Set</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
-<tbody><tr class="odd">
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
<td align="left">permissions</td>
<td align="left">string</td>
<td align="left">Set of user permissions</td>
-</tr></tbody>
-</table><h3 id="collection-properties">Collection properties</h3>
+</tr>
+</tbody>
+</table>
+<h3 id="collection-properties">Collection properties</h3>
<p>Roles have the following collections.</p>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Collection</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">users</td>
@@ -1123,7 +1191,8 @@ curl -X DELETE "https://api.usergrid.com
<td align="left">Collection of groups assigned to a role</td>
</tr>
</tbody>
-</table><p>Â </p>
+</table>
+<p>Â </p>
</div>
</div>
</div>
Modified: incubator/usergrid/site/publish/docs/updating-collections/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/updating-collections/index.html?rev=1616662&r1=1616661&r2=1616662&view=diff
==============================================================================
--- incubator/usergrid/site/publish/docs/updating-collections/index.html (original)
+++ incubator/usergrid/site/publish/docs/updating-collections/index.html Fri Aug 8 02:08:18 2014
@@ -174,7 +174,8 @@
<li><a href="#javascript_update_collection">JavaScript (HTML5)</a></li>
<li><a href="#ruby_update_collection">Ruby</a></li>
<li><a href="#nodejs_update_collection">Node.js</a></li>
-</ul><h3 id="example-requestresponse">Example Request/Response</h3>
+</ul>
+<h3 id="example-requestresponse">Example Request/Response</h3>
<h4 id="request">Request:</h4>
<pre><code>curl -X PUT https://api.usergrid.com/your-org/your-app/items/?ql= -d '{"availability":"in-stock"}'</code></pre>
<p>Note the empty <code>?ql=</code> query string.</p>
@@ -216,12 +217,16 @@
<p>Note the empty query string (ql=) appended to the URL.</p>
<h3 id="parameters">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>org</p></td>
@@ -244,7 +249,8 @@
</td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p>
<h3 id="example-requestresponse-1">Example Request/Response</h3>
<h4 id="request-1">Request:</h4>
<pre><code>-(NSString*)updateCollection {
@@ -307,12 +313,16 @@
<pre><code>(ApigeeClientResponse *)apiRequest: (NSString *)url operation:(NSString *)op data:(NSString *)opData</code></pre>
<h3 id="properties">Properties</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>url</p></td>
@@ -330,7 +340,8 @@
<td align="left"><p>A JSON-formatted string that contains the entity properties to be updated</p></td>
</tr>
</tbody>
-</table><p>Updating all entities in a collection is not currently supported by the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
+</table>
+<p>Updating all entities in a collection is not currently supported by the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
<p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p>
<h3 id="example-requestresponse-2">Example Request/Response</h3>
<h4 id="request-2">Request:</h4>
@@ -395,12 +406,16 @@ __proto__: Object
<pre><code>request(options, callback)</code></pre>
<h3 id="parameters-1">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>options</p></td>
@@ -419,7 +434,8 @@ __proto__: Object
<td align="left"><p>Callback function to handle the API response</p></td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#ruby">Apache Usergrid RubyGem</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#ruby">Apache Usergrid RubyGem</a>.</p>
<h3 id="example-requestresponse-3">Example Request/Response</h3>
<h4 id="request-3">Request:</h4>
<pre><code>#Create a client object
@@ -473,10 +489,12 @@ end
<pre><code>collection.update_query(properties, query_string)</code></pre>
<h3 id="properties-1">Properties</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">properties</td>
@@ -487,7 +505,8 @@ end
<td align="left">A query string that specifies the entities to be updated. Use an empty string (<code>""</code>) to update all entities.</td>
</tr>
</tbody>
-</table><p>The example assumes use of the <a href="/app-services-sdks#nodejs">Apache Usergrid Node.js module</a>.</p>
+</table>
+<p>The example assumes use of the <a href="/app-services-sdks#nodejs">Apache Usergrid Node.js module</a>.</p>
<h3 id="example-requestresponse-4">Example Request/Response</h3>
<h4 id="request-4">Request:</h4>
<pre><code>//Create the Apache Usergrid client object
@@ -541,12 +560,16 @@ dataClient.request(options,function (err
<pre><code>request(options,callback);</code></pre>
<h3 id="parameters-2">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>options</p></td>
@@ -564,7 +587,8 @@ dataClient.request(options,function (err
<td align="left"><p>Callback function to handle the API response</p></td>
</tr>
</tbody>
-</table><p>Â </p>
+</table>
+<p>Â </p>
</div>
</div>
</div>
Modified: incubator/usergrid/site/publish/docs/updating-data-entities/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/updating-data-entities/index.html?rev=1616662&r1=1616661&r2=1616662&view=diff
==============================================================================
--- incubator/usergrid/site/publish/docs/updating-data-entities/index.html (original)
+++ incubator/usergrid/site/publish/docs/updating-data-entities/index.html Fri Aug 8 02:08:18 2014
@@ -195,7 +195,8 @@
<li><a href="#javascript_update_entity">JavaScript (HTML5)</a></li>
<li><a href="#ruby_update_entity">Ruby</a></li>
<li><a href="#nodejs_update_entity">Node.js</a></li>
-</ul><h3 id="example-requestresponse">Example Request/Response</h3>
+</ul>
+<h3 id="example-requestresponse">Example Request/Response</h3>
<h4 id="request">Request:</h4>
<pre><code>curl -X PUT https://api.usergrid.com/your-org/your-app/items/milk -d '{"price":"4.00", "availability":"in-stock"}'</code></pre>
<h4 id="response">Response:</h4>
@@ -227,12 +228,16 @@
<pre><code>curl -X PUT https://api.usergrid.com/<org>/<app>/<collection>/<entity> -d {<property>}</code></pre>
<h3 id="parameters">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>org</p></td>
@@ -259,7 +264,8 @@
</td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p>
<h3 id="example-requestresponse-1">Example Request/Response</h3>
<h4 id="request-1">Request:</h4>
<pre><code>-(NSString*)updateEntity {
@@ -323,10 +329,12 @@
<pre><code>(ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity</code></pre>
<h3 id="parameters-1">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">entityID</td>
@@ -337,7 +345,8 @@
<td align="left">NSMutableDictionary containing the properties to be updated</td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
<h3 id="example-requestresponse-2">Example Request/Response</h3>
<h4 id="request-2">Request:</h4>
<pre><code>//Create client entity
@@ -412,10 +421,12 @@ dataClient.updateEntityAsync(entityID, u
<pre><code>updateEntity(String entityID, Map<String, Object> updatedProperties)</code></pre>
<h3 id="parameters-2">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">entityID</td>
@@ -430,7 +441,8 @@ dataClient.updateEntityAsync(entityID, u
<td align="left">Callback function (Asynchronous calls only)</td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p>
<h3 id="example-requestresponse-3">Example Request/Response</h3>
<h4 id="request-3">Request:</h4>
<pre><code>//Create the Apache Usergrid client object
@@ -654,7 +666,8 @@ entity.save(function (error,response) {
<li><a href="#javascript_update_subproperty">JavaScript (HTML5)</a></li>
<li><a href="#ruby_update_subproperty">Ruby</a></li>
<li><a href="#nodejs_update_subproperty">Node.js</a></li>
-</ul><h3 id="example-requestresponse-6">Example Request/Response</h3>
+</ul>
+<h3 id="example-requestresponse-6">Example Request/Response</h3>
<h4 id="request-6">Request:</h4>
<pre><code>curl -X PUT https://api.usergrid.com/your-org/your-app/items/milk -d '{"varieties":[{"name":"1%","price":"3.25"},{"name":"whole","price":"4.00"}]}'</code></pre>
<h4 id="response-5">Response:</h4>
@@ -693,12 +706,16 @@ entity.save(function (error,response) {
<pre><code>curl -X PUT https://api.usergrid.com/<org_id>/<app_id>/<collection>/<uuid|name> -d '{<property> : [{<sub_property>}, {<sub_property>}...]}'</code></pre>
<h3 id="parameters-3">Parameters</h3>
<table>
+<colgroup>
<col width="16%">
<col width="81%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">org_id</td>
@@ -726,7 +743,8 @@ entity.save(function (error,response) {
</td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#ios">Apache Usergrid iOS SDK</a>.</p>
<h3 id="example-requestresponse-7">Example Request/Response</h3>
<h4 id="request-7">Request:</h4>
<pre><code>-(NSString*)updateEntity {
@@ -807,10 +825,12 @@ entity.save(function (error,response) {
<pre><code>(ApigeeClientResponse *)updateEntity: (NSString *)entityID entity:(NSDictionary *)updatedEntity</code></pre>
<h3 id="parameters-4">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">entityID</td>
@@ -821,7 +841,8 @@ entity.save(function (error,response) {
<td align="left">Entity object containing the properties to be updated</td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#android">Apache Usergrid Android SDK</a>.</p>
<h3 id="example-requestresponse-8">Example Request/Response</h3>
<h4 id="request-8">Request:</h4>
<pre><code>//Create client entity
@@ -919,10 +940,12 @@ dataClient.updateEntityAsync(entityID, u
<pre><code>updateEntity(String entityID, Map<String, Object> updatedProperties)</code></pre>
<h3 id="parameters-5">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">entityID</td>
@@ -937,7 +960,8 @@ dataClient.updateEntityAsync(entityID, u
<td align="left">Callback function (Asynchronous calls only)</td>
</tr>
</tbody>
-</table><p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p>
+</table>
+<p>This example uses the <a href="/app-services-sdks#javascript">Apache Usergrid JavaScript (HTML5) SDK</a>.</p>
<h3 id="example-requestresponse-9">Example Request/Response</h3>
<h4 id="request-9">Request:</h4>
<pre><code>//Create the Apache Usergrid client object
Modified: incubator/usergrid/site/publish/docs/user/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/user/index.html?rev=1616662&r1=1616661&r2=1616662&view=diff
==============================================================================
--- incubator/usergrid/site/publish/docs/user/index.html (original)
+++ incubator/usergrid/site/publish/docs/user/index.html Fri Aug 8 02:08:18 2014
@@ -257,12 +257,16 @@
<p>POSTÂ /{org_id}/{app_id}/users {request body}</p>
<h3 id="parameters">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>arg uuid|string org_id</p></td>
@@ -283,7 +287,8 @@
</td>
</tr>
</tbody>
-</table><p>Although the password parameter is not mandatory, if you donât specify it, the user will not be able to log in using username and password credentials. If a password is not specified for the user, and youâre an Admin, you can set a password for the user (see <a href="#set_password">Setting a password</a>).</p>
+</table>
+<p>Although the password parameter is not mandatory, if you donât specify it, the user will not be able to log in using username and password credentials. If a password is not specified for the user, and youâre an Admin, you can set a password for the user (see <a href="#set_password">Setting a password</a>).</p>
<p><strong>Note:</strong> The username can contain any combination of characters, including those that represent letters, numbers, and symbols.</p>
<h3 id="example---request">Example - Request</h3>
<ul>
@@ -291,7 +296,10 @@
<li><a href="#javascript_create_user">JavaScript (HTML5)</a></li>
<li><a href="#ruby_create_user">Ruby</a></li>
<li><a href="#nodejs_create_user">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/users" -d '{"username":"john.doe","email":"john.doe@gmail.com","name":"John Doe"}'</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/users" -d '{"username":"john.doe","email":"john.doe@gmail.com","name":"John Doe"}'</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'POST',
@@ -386,7 +394,10 @@ client.request(options, function (err, d
<li><a href="#javascript_set_password">JavaScript (HTML5)</a></li>
<li><a href="#ruby_set_password">Ruby</a></li>
<li><a href="#nodejs_set_password">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X PUT "https://api.usergrid.com/my-org/my-app/users/john.doe/password" -d '{"newpassword":"foo9876a","oldpassword":"bar1234b"}'</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X PUT "https://api.usergrid.com/my-org/my-app/users/john.doe/password" -d '{"newpassword":"foo9876a","oldpassword":"bar1234b"}'</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'PUT',
@@ -430,10 +441,12 @@ client.request(options, function (err, d
<p>GETÂ /{org_id}/{app_id}/users/{uuid|username|email_address}</p>
<h3 id="parameters-2">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -448,13 +461,17 @@ client.request(options, function (err, d
<td align="left">User UUID, username, or email address. The alias /users/me can be used in place of the current userâs uuid, username, or email address. <strong>Note:</strong> The /users/me endpoint is accessible only if you provide an access token with the request (see <a href="/authenticating-users-and-application-clients">Authenticating users and application clients</a>). If you make an anonymous (âguestâ) call, the system will not be able to determine which user to return as /users/me.</td>
</tr>
</tbody>
-</table><h3 id="example---request-2">Example - Request</h3>
+</table>
+<h3 id="example---request-2">Example - Request</h3>
<ul>
<li><a href="#curl_get_user">cURL</a></li>
<li><a href="#javascript_get_user">JavaScript (HTML5)</a></li>
<li><a href="#ruby_get_user">Ruby</a></li>
<li><a href="#nodejs_get_user">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users/jane.doe"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users/jane.doe"</code></pre>
<p>OR</p>
<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users/a407b1e7-58e8-11e1-ac46-22000a1c5a67e"</code></pre>
<p>OR</p>
@@ -535,7 +552,10 @@ client.request(options, function (err, d
<li><a href="#javascript_get_multuser">JavaScript (HTML5)</a></li>
<li><a href="#ruby_get_multuser">Ruby</a></li>
<li><a href="#nodejs_get_multuser">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users;7d1aa429-e978-11e0-8264-005056c00008;a407b1e7-58e8-11e1-ac46-22000a1c5a67e"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users;7d1aa429-e978-11e0-8264-005056c00008;a407b1e7-58e8-11e1-ac46-22000a1c5a67e"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'GET',
@@ -631,12 +651,16 @@ client.request(options, function (err, d
<p>PUTÂ /{org_id}/{app_id}/users/{uuid|username} {request body}</p>
<h3 id="parameters-3">Parameters</h3>
<table>
+<colgroup>
<col width="50%">
<col width="50%">
-<thead><tr class="header">
+</colgroup>
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left"><p>arg uuid|string org_id</p></td>
@@ -661,13 +685,17 @@ client.request(options, function (err, d
</td>
</tr>
</tbody>
-</table><h3 id="example---request-3">Example - Request</h3>
+</table>
+<h3 id="example---request-3">Example - Request</h3>
<ul>
<li><a href="#curl_update_user">cURL</a></li>
<li><a href="#javascript_update_user">JavaScript (HTML5)</a></li>
<li><a href="#ruby_update_user">Ruby</a></li>
<li><a href="#nodejs_update_user">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X PUT "https://api.usergrid.com/my-org/my-app/users/john.doe" -d '{"email":"john.doe@mail.com", "city":"san francisco"}'</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X PUT "https://api.usergrid.com/my-org/my-app/users/john.doe" -d '{"email":"john.doe@mail.com", "city":"san francisco"}'</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'PUT',
@@ -748,10 +776,12 @@ client.request(options, function (err, d
<p>DELETEÂ /{org_id}/{app_id}/users/{uuid|username}</p>
<h3 id="parameters-4">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -770,13 +800,17 @@ client.request(options, function (err, d
<td align="left">One or more sets of user properties</td>
</tr>
</tbody>
-</table><h3 id="example---request-4">Example - Request</h3>
+</table>
+<h3 id="example---request-4">Example - Request</h3>
<ul>
<li><a href="#curl_delete_user">cURL</a></li>
<li><a href="#javascript_delete_user">JavaScript (HTML5)</a></li>
<li><a href="#ruby_delete_user">Ruby</a></li>
<li><a href="#nodejs_delete_user">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/users/john.doe"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/users/john.doe"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'DELETE',
@@ -858,10 +892,12 @@ client.request(options, function (err, d
<p>GETÂ /{org_id}/{app_id}/users?{query}</p>
<h3 id="parameters-5">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -876,13 +912,17 @@ client.request(options, function (err, d
<td align="left">Query in the query language. See <a href="/queries-and-parameters">Queries and parameters</a>.</td>
</tr>
</tbody>
-</table><h3 id="example---request-5">Example - Request</h3>
+</table>
+<h3 id="example---request-5">Example - Request</h3>
<ul>
<li><a href="#curl_query_users">cURL</a></li>
<li><a href="#javascript_query_users">JavaScript (HTML5)</a></li>
<li><a href="#ruby_query_users">Ruby</a></li>
<li><a href="#nodejs_query_users">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users?ql=select%20*%20where%20city%3D'Chicago'"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users?ql=select%20*%20where%20city%3D'Chicago'"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'GET',
@@ -974,10 +1014,12 @@ client.request(options, function (err, d
<p>POST /{org_id}/{app_id}/groups/{uuid|groupname}/users/{uuid|username}</p>
<h3 id="parameters-6">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -996,13 +1038,17 @@ client.request(options, function (err, d
<td align="left">UUID or username of user</td>
</tr>
</tbody>
-</table><h3 id="example---request-6">Example - Request</h3>
+</table>
+<h3 id="example---request-6">Example - Request</h3>
<ul>
<li><a href="#curl_add_user">cURL</a></li>
<li><a href="#javascript_add_user">JavaScript (HTML5)</a></li>
<li><a href="#ruby_add_user">Ruby</a></li>
<li><a href="#nodejs_add_user">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/groups/mynewgroup/users/john.doe"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/groups/mynewgroup/users/john.doe"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'POST',
@@ -1082,10 +1128,12 @@ client.request(options, function (err, d
<p>POSTÂ /{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_id}</p>
<h3 id="parameters---use-case-1">Parameters - Use Case 1</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -1112,14 +1160,18 @@ client.request(options, function (err, d
<td align="left">Second entity UUID</td>
</tr>
</tbody>
-</table><p>If the relationship is a collection (such as a users collection for the group employees), this request adds the second entity to the first entityâs collection of the specified name. (Note that employees is an entity name within the groups collection.) In the case of a group, this is how you add users as group members.</p>
+</table>
+<p>If the relationship is a collection (such as a users collection for the group employees), this request adds the second entity to the first entityâs collection of the specified name. (Note that employees is an entity name within the groups collection.) In the case of a group, this is how you add users as group members.</p>
<h3 id="example---request---use-case-1-add-a-user-to-a-collection">Example - Request - Use Case 1 (Add a user to a collection)</h3>
<ul>
<li><a href="#curl_add_user_collection">cURL</a></li>
<li><a href="#javascript_add_user_collection">JavaScript (HTML5)</a></li>
<li><a href="#ruby_add_user_collection">Ruby</a></li>
<li><a href="#nodejs_add_user_collection">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/groups/employees/users/jane.doe"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/groups/employees/users/jane.doe"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'POST',
@@ -1194,7 +1246,10 @@ client.request(options, function (err, d
<li><a href="#javascript_create_connection1">JavaScript (HTML5)</a></li>
<li><a href="#ruby_create_connection1">Ruby</a></li>
<li><a href="#nodejs_create_connection1">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/users/jane.doe/likes/d9693ec3-61c9-11e2-9ffc-02e81adcf3d0"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/users/jane.doe/likes/d9693ec3-61c9-11e2-9ffc-02e81adcf3d0"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'POST',
@@ -1268,10 +1323,12 @@ organization": "my-org",
<p>POSTÂ /{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_type}/{second_entity_id}</p>
<h3 id="parameters---use-case-2">Parameters - Use Case 2</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -1302,14 +1359,18 @@ organization": "my-org",
<td align="left">Second entity UUID or entity name</td>
</tr>
</tbody>
-</table><h3 id="example---request---use-case-2">Example - Request - Use Case 2</h3>
+</table>
+<h3 id="example---request---use-case-2">Example - Request - Use Case 2</h3>
<p>When creating a connection, if you specify the entity type for the second entity, then you can create the connection using the entityâs name rather than its UUID.</p>
<ul>
<li><a href="#curl_create_connection2">cURL</a></li>
<li><a href="#javascript_create_connection2">JavaScript (HTML5)</a></li>
<li><a href="#ruby_create_connection2">Ruby</a></li>
<li><a href="#nodejs_create_connection2">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/users/john.doe/likes/food/pizza"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X POST "https://api.usergrid.com/my-org/my-app/users/john.doe/likes/food/pizza"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'POST',
@@ -1369,10 +1430,12 @@ client.request(options, function (err, d
<p>DELETEÂ /{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_id}</p>
<h3 id="parameters---use-case-1-1">Parameters - Use Case 1</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -1399,14 +1462,18 @@ client.request(options, function (err, d
<td align="left">Second entity UUID</td>
</tr>
</tbody>
-</table><p>If the relationship is a collection (such as a users collection for the group employees), this request removes the second entity from the first entityâs collection of the specified name. In the case of a group, this is how you delete users as group members.</p>
+</table>
+<p>If the relationship is a collection (such as a users collection for the group employees), this request removes the second entity from the first entityâs collection of the specified name. In the case of a group, this is how you delete users as group members.</p>
<h3 id="example---request---use-case-1-remove-a-user-from-a-collection">Example - Request - Use Case 1 (Remove a user from a collection)</h3>
<ul>
<li><a href="#curl_delete_user_collection">cURL</a></li>
<li><a href="#javascript_delete_user_collection">JavaScript (HTML5)</a></li>
<li><a href="#ruby_delete_user_collection">Ruby</a></li>
<li><a href="#nodejs_delete_user_collection">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/groups/employees/users/jane.doe"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/groups/employees/users/jane.doe"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'DELETE',
@@ -1479,7 +1546,10 @@ client.request(options, function (err, d
<li><a href="#javascript_delete_connection">JavaScript (HTML5)</a></li>
<li><a href="#ruby_delete_connection">Ruby</a></li>
<li><a href="#nodejs_delete_connection">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/users/jane.doe/likes/d9693ec3-61c9-11e2-9ffc-02e81adcf3d0"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/users/jane.doe/likes/d9693ec3-61c9-11e2-9ffc-02e81adcf3d0"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'DELETE',
@@ -1557,10 +1627,12 @@ client.request(options, function (err, d
<p>DELETEÂ /{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_type}/{second_entity_id}</p>
<h3 id="parameters---use-case-2-1">Parameters - Use Case 2</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -1591,14 +1663,18 @@ client.request(options, function (err, d
<td align="left">Second entity UUID or entity name</td>
</tr>
</tbody>
-</table><h3 id="example---request---use-case-2-1">Example - Request - Use Case 2</h3>
+</table>
+<h3 id="example---request---use-case-2-1">Example - Request - Use Case 2</h3>
<p>When removing a connection, if you specify the entity type for the second entity, then you can delete the connection using the entityâs name rather than its UUID.</p>
<ul>
<li><a href="#curl_delete_connection1">cURL</a></li>
<li><a href="#javascript_delete_connection1">JavaScript (HTML5)</a></li>
<li><a href="#ruby_delete_connection1">Ruby</a></li>
<li><a href="#nodejs_delete_connection1">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/users/test-user-1/follows/test-user-2"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X DELETE "https://api.usergrid.com/my-org/my-app/users/test-user-1/follows/test-user-2"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'DELETE',
@@ -1646,10 +1722,12 @@ client.request(options, function (err, d
<p>GETÂ /{org_id}/{app_id}/users/{uuid|username}/{relationship}?{query}</p>
<h3 id="parameters-7">Parameters</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Parameter</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">arg uuid|string org_id</td>
@@ -1672,13 +1750,17 @@ client.request(options, function (err, d
<td align="left">Query in the query language. See <a href="/queries-and-parameters">Queries and parameters</a>.</td>
</tr>
</tbody>
-</table><h3 id="example---request-7">Example - Request</h3>
+</table>
+<h3 id="example---request-7">Example - Request</h3>
<ul>
<li><a href="#curl_query_user_collections">cURL</a></li>
<li><a href="#javascript_query_user_collections">JavaScript (HTML5)</a></li>
<li><a href="#ruby_query_user_collections">Ruby</a></li>
<li><a href="#nodejs_query_user_collections">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users/jane.doe/likes?ql=select%20*%20where%20city%3D'milwaukee'"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users/jane.doe/likes?ql=select%20*%20where%20city%3D'milwaukee'"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'GET',
@@ -1752,7 +1834,10 @@ client.request(options, function (err, d
<li><a href="#javascript_get_user_feed">JavaScript (HTML5)</a></li>
<li><a href="#ruby_get_user_feed">Ruby</a></li>
<li><a href="#nodejs_get_user_feed">Node.js</a></li>
-</ul><!-- --><pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users/john.doe/feed"</code></pre>
+</ul>
+<!-- -->
+
+<pre><code>curl -X GET "https://api.usergrid.com/my-org/my-app/users/john.doe/feed"</code></pre>
<p>The example assumes use of the <a href="https://github.com/apigee/usergrid-javascript-sdk">JavaScript (HTML5) SDK</a>.</p>
<pre><code>var options = {
method:'GET',
@@ -1844,11 +1929,13 @@ client.request(options, function (err, d
<h2 id="user-properties">User properties</h2>
<p>The following are the system-defined properties for user entities. You can create application-specific properties for a user entity in addition to the system-defined properties. The system-defined properties are reserved. You cannot use these names to create other properties for a user entity. In addition the users name is reserved for the users collection â you canât use it to name another collection.</p>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Property</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">uuid</td>
@@ -1923,13 +2010,16 @@ client.request(options, function (err, d
<td align="left">User picture</td>
</tr>
</tbody>
-</table><p>The following property sets are assigned to user entities.</p>
+</table>
+<p>The following property sets are assigned to user entities.</p>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Set</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">connections</td>
@@ -1952,13 +2042,16 @@ client.request(options, function (err, d
<td align="left">Set of user credentials</td>
</tr>
</tbody>
-</table><p>Users have the following associated collections.</p>
+</table>
+<p>Users have the following associated collections.</p>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Collection</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">groups</td>
@@ -1986,7 +2079,8 @@ client.request(options, function (err, d
<td align="left">Set of roles assigned to a user</td>
</tr>
</tbody>
-</table><p>Â </p>
+</table>
+<p>Â </p>
</div>
</div>
</div>
Modified: incubator/usergrid/site/publish/docs/users-devices/index.html
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/docs/users-devices/index.html?rev=1616662&r1=1616661&r2=1616662&view=diff
==============================================================================
--- incubator/usergrid/site/publish/docs/users-devices/index.html (original)
+++ incubator/usergrid/site/publish/docs/users-devices/index.html Fri Aug 8 02:08:18 2014
@@ -158,11 +158,13 @@
<h2 id="users">Users</h2>
<h3 id="properties">Properties</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Property</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">uuid</td>
@@ -237,13 +239,16 @@
<td align="left">User picture</td>
</tr>
</tbody>
-</table><h3 id="sets">Sets</h3>
+</table>
+<h3 id="sets">Sets</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Set</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">connections</td>
@@ -266,13 +271,16 @@
<td align="left">Set of user credentials</td>
</tr>
</tbody>
-</table><h3 id="relationshops">Relationshops</h3>
+</table>
+<h3 id="relationshops">Relationshops</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Collection</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">groups</td>
@@ -300,7 +308,8 @@
<td align="left">Set of roles assigned to a user</td>
</tr>
</tbody>
-</table><h3 id="facebook-sign-in">Facebook Sign-in</h3>
+</table>
+<h3 id="facebook-sign-in">Facebook Sign-in</h3>
<p>You can authenticate your Apache Usergrid requests by logging into Facebook. To access Apache Usergrid resources, you need to provide an access token with each request (unless you use the sandbox app). You can get an access token by connecting to an appropriate web service endpoint and providing the correct client credentials â this is further described in <a href="/authenticating-users-and-application-clients">Authenticating users and application clients</a>. However, you can also obtain an access token by logging into Facebook.</p>
<p>To enable authentication to Apache Usergrid through Facebook, do the following in your app:</p>
<ol style="list-style-type: decimal">
@@ -309,7 +318,8 @@
<p>Send the Facebook access token to Apache Usergrid. If the Facebook access token is valid and the user does not already exist in App Services, Apache Usergrid provisions a new Apache Usergrid user. It also returns an Apache Usergrid access token, which you can use for subsequent Apache Usergrid API calls. Behind the scenes, Apache Usergrid uses the Facebook access token to retrieve the userâs profile information from Facebook.</p>
<p>If the Facebook access token is invalid, Facebook returns an OAuth authentication error, and the login does not succeed.</p>
</li>
-</ol><p>The request to authenticate to Apache Usergrid using a Facebook access token is:</p>
+</ol>
+<p>The request to authenticate to Apache Usergrid using a Facebook access token is:</p>
<pre><code>GET https://api.usergrid.com/{my_org}/{my_app}/auth/facebook?fb_access_token={fb_access_token}</code></pre>
<p>where:</p>
<ul>
@@ -318,14 +328,17 @@
<li>{my_app} is the application UUID or application name.<br>
</li>
<li>{fb_access_token} is the Facebook access token.</li>
-</ul><h2 id="devices">Devices</h2>
+</ul>
+<h2 id="devices">Devices</h2>
<h3 id="properties-1">Properties</h3>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Property</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
+</tr>
+</thead>
<tbody>
<tr class="odd">
<td align="left">uuid</td>
@@ -355,19 +368,24 @@
<td align="left">Device name (mandatory)</td>
</tr>
</tbody>
-</table><h3 id="relationships">Relationships</h3>
+</table>
+<h3 id="relationships">Relationships</h3>
<p>Devices have the following associated collection.</p>
<table>
-<thead><tr class="header">
+<thead>
+<tr class="header">
<th align="left">Collection</th>
<th align="left">Type</th>
<th align="left">Description</th>
-</tr></thead>
-<tbody><tr class="odd">
+</tr>
+</thead>
+<tbody>
+<tr class="odd">
<td align="left">users</td>
<td align="left">user</td>
<td align="left">Collection of users to which a device belongs</td>
-</tr></tbody>
+</tr>
+</tbody>
</table>
</div>
</div>
Added: incubator/usergrid/site/publish/img/github.png
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/img/github.png?rev=1616662&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/usergrid/site/publish/img/github.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/usergrid/site/publish/img/stliu.jpg
URL: http://svn.apache.org/viewvc/incubator/usergrid/site/publish/img/stliu.jpg?rev=1616662&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/usergrid/site/publish/img/stliu.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream