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/29 18:06:40 UTC
[9/9] incubator-usergrid git commit: Converted Entity Connections
pages, and replaced references to API BaaS with Usergrid.
Converted Entity Connections pages, and replaced references to API BaaS with Usergrid.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/080f911c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/080f911c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/080f911c
Branch: refs/heads/ug2-doc-update
Commit: 080f911cd1a574ce1cd5f9ffdec8cbdbe61991c8
Parents: 07d14c8
Author: Dave Johnson <sn...@apache.org>
Authored: Wed Jul 29 12:06:14 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Wed Jul 29 12:06:14 2015 -0400
----------------------------------------------------------------------
docs/data-queries/advanced-query-usage.md | 8 +-
docs/data-queries/operators-and-types.md | 2 +-
docs/data-queries/query-language.md | 2 +-
docs/data-queries/query-parameters.md | 2 +-
docs/data-queries/querying-your-data.md | 4 +-
docs/data-storage/data-store-dbms.md | 10 +--
docs/entity-connections/connecting-entities.md | 60 +++++++++++++
.../disconnecting-entities.md | 79 ++++++++++++++++
docs/entity-connections/relationships.md | 6 +-
docs/entity-connections/retrieving-entities.md | 94 ++++++++++++++++++++
docs/getting-started/creating-account.md | 4 +-
docs/index.md | 4 +-
docs/introduction/async-vs-sync.md | 4 +-
docs/introduction/usergrid-features.md | 2 +-
14 files changed, 257 insertions(+), 24 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/data-queries/advanced-query-usage.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/advanced-query-usage.md b/docs/data-queries/advanced-query-usage.md
index 4e6e7ba..0e59350 100644
--- a/docs/data-queries/advanced-query-usage.md
+++ b/docs/data-queries/advanced-query-usage.md
@@ -3,15 +3,15 @@ Query examples in this content are shown unencoded to make them easier to read.
Attaching a query to all API calls
## JavaScript SDK only
-The following feature is currently only supported by the Apigee JavaScript SDK
-In some cases, it may be convenient to attach a query or other URI parameter to every call you make to API BaaS, such as a custom identifier or token. To do this with the Apigee JavaScript SDK, add a qs property to your Apigee.Client object when you initialize the SDK. For more on initializing the SDK, see our install guide.
+The following feature is currently only supported by the Usergrid JavaScript SDK
+In some cases, it may be convenient to attach a query or other URI parameter to every call you make to Usergrid, such as a custom identifier or token. To do this with the Usergrid JavaScript SDK, add a qs property to your Usergrid.Client object when you initialize the SDK. For more on initializing the SDK, see our install guide.
-For example, the following would append ?custom_id=1234 to every call sent from the Apigee JavaScript SDK to API BaaS:
+For example, the following would append ?custom_id=1234 to every call sent from the Usergrid JavaScript SDK to Usergrid:
var options = {
orgName:'yourOrg',
appName:'yourApp',
qs:'custom_id=1234'
}
- var dataClient = new Apigee.Client(options);
+ var dataClient = new Usergrid.Client(options);
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/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 c779809a..2029ce5 100644
--- a/docs/data-queries/operators-and-types.md
+++ b/docs/data-queries/operators-and-types.md
@@ -1,6 +1,6 @@
# Supported query operators & data types
-The following operators and data types are supported by the SQL-like query language in API BaaS.
+The following operators and data types are supported by the SQL-like query language in Usergrid.
## Operators
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/data-queries/query-language.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/query-language.md b/docs/data-queries/query-language.md
index bd337ac..9b96f28 100644
--- a/docs/data-queries/query-language.md
+++ b/docs/data-queries/query-language.md
@@ -14,7 +14,7 @@ sorting the list in ascending order by name:
## Basic syntax
-Queries of Apigee data for Apache Usergrid are made up of two kinds of
+Queries of Usergrid data for Apache Usergrid are made up of two kinds of
statements: the path to the collection you want to query, followed by
the query language statement containing your query. These two statements
are separated by "?ql=" to indicate where the query language statement
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/data-queries/query-parameters.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/query-parameters.md b/docs/data-queries/query-parameters.md
index 50f1596..9446412 100644
--- a/docs/data-queries/query-parameters.md
+++ b/docs/data-queries/query-parameters.md
@@ -8,7 +8,7 @@ Query examples in this content are shown unencoded to make them easier to read.
As a best practice, you should include no more than 3 parameters in your queries. The API will not prevent you from submitting a query with more than 3 parameters; however, due to the nature of NoSQL, queries with many parameters can quickly become very inefficient.
-For more information, see our API BaaS DBMS overview and Data store best practices.
+For more information, see our Usergrid DBMS overview and Data store best practices.
### Contains
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/data-queries/querying-your-data.md
----------------------------------------------------------------------
diff --git a/docs/data-queries/querying-your-data.md b/docs/data-queries/querying-your-data.md
index 9f3abac..e6166ed 100644
--- a/docs/data-queries/querying-your-data.md
+++ b/docs/data-queries/querying-your-data.md
@@ -8,13 +8,13 @@ Query examples in this content are shown unencoded to make them easier to read.
## Basic query usage
-The following examples show how to query the Apigee API to return the first 5 entities in the users collection that contain the property status:'active'.
+The following examples show how to query the Usergrid API to return the first 5 entities in the users collection that contain the property status:'active'.
### Optimizing queries
As a best practice, you should include no more than 3 parameters in your queries. The API will not prevent you from submitting a query with more than 3 parameters; however, due to the nature of NoSQL, queries with many parameters can quickly become very inefficient.
-For more information, see our API BaaS DBMS overview and Data store best practices.
+For more information, see our Usergrid DBMS overview and Data store best practices.
### Request Syntax
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/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 5911b04..300a376 100644
--- a/docs/data-storage/data-store-dbms.md
+++ b/docs/data-storage/data-store-dbms.md
@@ -1,12 +1,12 @@
# The Usergrid Data Store
-The API BaaS data store is backed by Cassandra, an open source distributed DBMS. Cassandra isn’t a relational database system (RDBMS), and is sometimes placed in the category of “NoSQL” or “schema-less” databases.
+The Usergrid data store is backed by Cassandra, an open source distributed DBMS. Cassandra isn’t a relational database system (RDBMS), and is sometimes placed in the category of “NoSQL” or “schema-less” databases.
.. note:: Usergrid is not a relational database
-Optimizing for performance on a DBMS like Cassandra differs a bit from relational databases. For more information, see Optimizing access to your API BaaS data store.
+Optimizing for performance on a DBMS like Cassandra differs a bit from relational databases. For more information, see Optimizing access to your Usergrid data store.
-Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. API BaaS client applications write and read data formatted as JavaScript Object Notation (JSON). (Apigee provides SDKs through which client apps can do much of this work in their native language. For more information, see API BaaS SDKs.)
+Cassandra is specifically designed to support applications that need flexibility and high scalability, particularly web and mobile applications. Usergrid client applications write and read data formatted as JavaScript Object Notation (JSON). (Usergrid provides SDKs through which client apps can do much of this work in their native language. For more information, see Usergrid SDKs.)
With Cassandra as the underlying DBMS, apps benefit from:
@@ -15,7 +15,7 @@ Fast writes to the data store.
* Flexibility in data model design. You aren't constrained by a schema.
* Linear scalability.
-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 API BaaS, which is backed by Cassandra.
+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">
@@ -55,7 +55,7 @@ A Cassandra column family includes rows that can have differing column sets.
.. image:: cassandra.png
-In the JSON from the API BaaS application, the products are represented as entities. Note that each entity in the entities array below has a slightly different set of properties, like the columns in a Cassandra column family.
+In the JSON from the Usergrid application, the products are represented as entities. Note that each entity in the entities array below has a slightly different set of properties, like the columns in a Cassandra column family.
{
"action" : "get",
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/entity-connections/connecting-entities.md
----------------------------------------------------------------------
diff --git a/docs/entity-connections/connecting-entities.md b/docs/entity-connections/connecting-entities.md
new file mode 100644
index 0000000..1c6219e
--- /dev/null
+++ b/docs/entity-connections/connecting-entities.md
@@ -0,0 +1,60 @@
+# Connecting entities
+
+When creating a connection, if you specify the collection of the entity being connected to, you can create the connection using the value of its 'name' property or its UUID.
+
+## Request syntax
+
+To create a connection, the entity being connected to can either be specified by just its UUID, or both its collection and the value of its 'name' property.
+
+Connect by UUID
+
+ curl -X POST https://api.usergrid.com/<org>/<app>/<connecting_collection>/<connecting_entity>/<relationship>/<connected_entity>
+
+Connect by 'name' property
+
+ curl -X POST https://api.usergrid.com/<org>/<app>/<connecting_collection>/<connecting_entity>/<relationship>/<connected_collection>/<connected_entity>
+
+Parameters
+
+Parameter Description
+--------- -----------
+org Organization UUID or organization name
+app Application UUID or application name
+connecting_collection Name or UUID of the collection of the connecting entity.
+connecting_entity Name or UUID of the connecting entity.
+relationship Type of connection being created (e.g., likes)
+connected_collection Name or UUID of the collection of the entity being connected to.
+connected_entity Name or UUID of the entity being connected to.
+
+If the connecting entity is a 'user' entity, the 'username' should be used rather than the 'name'.
+
+'connected_collection' is not required if the entity being connected to is specified by its UUID.
+
+Example request
+
+ curl -X POST http://api.usergrid.com/your-org/your-app/users/Arthur/likes/6c56ffda-9e75-11e3-99fd-8dd1801e534c
+
+Example Response
+
+ {
+ "action" : "post",
+ "application" : "db1e60a0-417f-11e3-9586-0f1ff3650d20",
+ "params" : { },
+ "path" : "/users/174785aa-8ea8-11e3-ae1f-eb20e5bce407/likes",
+ "uri" : "https://api.usergrid.com/my-org/my-app/users/174785aa-8ea8-11e3-ae1f-eb20e5bce407/likes",
+ "entities" : [ {
+ "uuid" : "6c56ffda-9e75-11e3-99fd-8dd1801e534c",
+ "type" : "user",
+ "name" : "Arthur",
+ "created" : 1393371291725,
+ "modified" : 1393371291725,
+ "metadata" : {
+ "path" : "/users/174785aa-8ea8-11e3-ae1f-eb20e5bce407/likes/6c56ffda-9e75-11e3-99fd-8dd1801e534c"
+ }
+ } ],
+ "timestamp" : 1393371455487,
+ "duration" : 77,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/entity-connections/disconnecting-entities.md
----------------------------------------------------------------------
diff --git a/docs/entity-connections/disconnecting-entities.md b/docs/entity-connections/disconnecting-entities.md
new file mode 100644
index 0000000..b52d62d
--- /dev/null
+++ b/docs/entity-connections/disconnecting-entities.md
@@ -0,0 +1,79 @@
+# Disconnecting entities
+
+To disconnect a user from other data, perform a DELETE operation against the same endpoint at which you posted to create the connection.
+
+## Request syntax
+
+Disconnect by UUID
+
+ curl -X DELETE https://api.usergrid.com/<org>/<app>/<connecting_collection>/<connecting_entity>/<relationship>/<connected_entity>
+
+Disconnect by 'name' property
+
+ curl -X DELETE https://api.usergrid.com/<org>/<app>/<connecting_collection>/<connecting_entity>/<relationship>/<connected_collection>/<connected_entity>
+
+Parameters
+
+Parameter Description
+--------- -----------
+org Organization UUID or organization name
+app Application UUID or application name
+connecting_collection Name or UUID of the collection of the connecting entity.
+connecting_entity Name or UUID of the connecting entity.
+relationship Type of connection being created (e.g., likes)
+connected_collection Name or UUID of the collection of the entity being connected to.
+connected_entity Name or UUID of the entity being connected to.
+
+If the connecting entity is a 'user' entity, the 'username' should be used rather than the 'name'.
+
+'connected_collection' is not required if the entity being connected to is specified by its UUID.Parameter
+
+Example request
+
+ curl -X DELETE https://api.usergrid.com/your-org/your-app/users/Arthur/likes/users/Ford
+
+Example response
+
+ {
+ "action" : "delete",
+ "application" : "k88dh4f-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes",
+ "uri" : "https://api.usergrid.com/your-org/your-app/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes",
+ "entities" : [ {
+ "uuid" : "5bcc47ca-cfed-11e3-8bde-a7e008061e10",
+ "type" : "user",
+ "created" : 1398810410556,
+ "modified" : 1398810410556,
+ "username" : "Ford",
+ "activated" : true,
+ "metadata" : {
+ "connecting" : {
+ "likes" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/connecting/likes"
+ },
+ "path" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10",
+ "sets" : {
+ "rolenames" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/roles",
+ "permissions" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/permissions"
+ },
+ "connections" : {
+ "friends" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/friends",
+ "likes" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/likes"
+ },
+ "collections" : {
+ "activities" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/activities",
+ "devices" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/devices",
+ "feed" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/feed",
+ "groups" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/groups",
+ "roles" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/roles",
+ "following" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/following",
+ "followers" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/followers"
+ }
+ }
+ } ],
+ "timestamp" : 1398962837195,
+ "duration" : 85,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/entity-connections/relationships.md
----------------------------------------------------------------------
diff --git a/docs/entity-connections/relationships.md b/docs/entity-connections/relationships.md
index e039e09..5946640 100644
--- a/docs/entity-connections/relationships.md
+++ b/docs/entity-connections/relationships.md
@@ -1,7 +1,6 @@
# Relationships
-Creating connections between entities
--------------------------------------
+## Creating connections between entities
One of the most useful features of App services is the ability to create
connections between entities. A simple example of this is the
@@ -51,8 +50,7 @@ call:
GET https://api.usergrid.com/my-org/my-app/users/fred/followers
-Creating other connections
---------------------------
+## Creating other connections
You can extend this connection structure to create connections using any
"verb" that can link two entities. For example, you could use likes to
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/entity-connections/retrieving-entities.md
----------------------------------------------------------------------
diff --git a/docs/entity-connections/retrieving-entities.md b/docs/entity-connections/retrieving-entities.md
new file mode 100644
index 0000000..31eaf9c
--- /dev/null
+++ b/docs/entity-connections/retrieving-entities.md
@@ -0,0 +1,94 @@
+# Retrieving connections
+
+Viewing all of an entities connections
+To see all of the connection types associated with an entity, simply retrieve the entity.
+
+All of the connection types the entity has made to other entities will appear in the metadata.connections property.
+
+All of the connection types that other entities have made to the entity will appear in the metadata.connecting property.
+
+For user entities, following/followers connections can be accessed by sending a GET request to the URL in the collections.following and collections.followers properties.
+
+Retrieve connected entities by connection type
+To get a list of entities a specified entity has connected to with a specific connection type, do the following:
+
+## Request syntax
+
+ curl -X GET https://api.usergrid.com/<org>/<app>/<collection>/<entity>/<relationship>
+
+Parameters
+
+Parameter Description
+--------- -----------
+org Organization UUID or organization name
+app Application UUID or application name
+collection Name or UUID of the collection of the entity you want to retrieve the connections of.
+entity Name or UUID of the entity whose connections you want to retrieve
+relationship The connection type you want to retrieve the entities for.
+
+For example, specifying a relationship of 'likes' would return a list of all entities that have the 'likes' connection with the specified entity.
+
+Example request
+
+ curl -X GET https://api.usergrid.com/your-org/your-app/users/Arthur/likes
+
+Example response
+
+Notice that the entities are returned as a JSON array in the entities property.
+
+ {
+ "action" : "get",
+ "application" : "dk88fh4r-a166-11e2-a7f7-02e81adcf3d0",
+ "params" : { },
+ "path" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes",
+ "uri" : "https://api.usergrid.com/your-org/your-app/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes",
+ "entities" : [ {
+ "uuid" : "5bcc47ca-cfed-11e3-8bde-a7e008061e10",
+ "type" : "user",
+ "created" : 1398810410556,
+ "modified" : 1398810410556,
+ "username" : "Ford",
+ "activated" : true,
+ "metadata" : {
+ "connecting" : {
+ "likes" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/connecting/likes"
+ },
+ "path" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10",
+ "sets" : {
+ "rolenames" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/roles",
+ "permissions" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/permissions"
+ },
+ "collections" : {
+ "activities" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/activities",
+ "devices" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/devices",
+ "feed" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/feed",
+ "groups" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/groups",
+ "roles" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/roles",
+ "following" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/following",
+ "followers" : "/users/58606d0a-cfed-11e3-a694-dbf5228024a7/likes/5bcc47ca-cfed-11e3-8bde-a7e008061e10/followers"
+ }
+ }
+ } ],
+ "timestamp" : 1398884631067,
+ "duration" : 41,
+ "organization" : "your-org",
+ "applicationName" : "your-app"
+ }
+
+## Retrieve all connected entities
+
+To get a list of all the entities a specified entity has connected to, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to connections.
+
+All of the entities that have made a connection of that type to the specified entity will be returned in the entities property of the response.
+
+## Retrieve all connecting entities by type
+
+To get a list of all the entities that have created a connection of a specific type to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to connecting/<relationship>.
+
+All of the entities that have made a connection to the specified entity will be returned in the entities property of the response.
+
+## Retrieve all connecting entities
+
+To get a list of all the entities that have connected to a specified entity, use the same method as shown above in Retrieve connected entities by connection type, and set the relationship to connecting.
+
+All of the entities that have made a connection to the specified entity will be returned in the entities property of the response.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/getting-started/creating-account.md
----------------------------------------------------------------------
diff --git a/docs/getting-started/creating-account.md b/docs/getting-started/creating-account.md
index d8ec8f4..15a8329 100644
--- a/docs/getting-started/creating-account.md
+++ b/docs/getting-started/creating-account.md
@@ -1,5 +1,5 @@
# Creating an Usergrid Account
-To get started using the API Services BaaS, you'll need an Usergrid account. (Before reading this, you should already be familiar with what Usergrid can do to support your apps. If you're still curious about that, you might want to read API BaaS features first.)
+To get started using the API Services BaaS, you'll need an Usergrid account. (Before reading this, you should already be familiar with what Usergrid can do to support your apps. If you're still curious about that, you might want to read Usergrid features first.)
With an account, you get the following useful things:
@@ -17,5 +17,5 @@ With an account, you get the following useful things:
Ready to learn and do more?
* Install an SDK that will be most useful for your application environment. For more about Usergrid's SDKs, see SDKs.
-* Review API BaaS features for information on concepts and features.
+* Review Usergrid features for information on concepts and features.
* Consult the API Reference for usage details.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/index.md
----------------------------------------------------------------------
diff --git a/docs/index.md b/docs/index.md
index dc35ba8..0078c53 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -51,7 +51,9 @@ Apache Usergrid Documentation
:maxdepth: 2
:caption: Entity Connections
- entity-connections/relationships
+ entity-connections/connecting-entities
+ entity-connections/retrieving-entities
+ entity-connections/disconnecting-entities
.. _push-notifications:
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/introduction/async-vs-sync.md
----------------------------------------------------------------------
diff --git a/docs/introduction/async-vs-sync.md b/docs/introduction/async-vs-sync.md
index 064665a..2f1eb32 100644
--- a/docs/introduction/async-vs-sync.md
+++ b/docs/introduction/async-vs-sync.md
@@ -1,11 +1,11 @@
# Asynchronous vs. synchronous calls
-The Apigee 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 Apigee Android SDK, while in others only asynchronous calls are supported, as in the Apigee JavaScript SDK. The following is a brief explanation of synchronous vs. asynchronous API 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
If an API call is synchronous, it means that code execution will block (or wait) for the API call to return before continuing. This means that until a response is returned by the API, your application will not execute any further, which could be perceived by the user as latency or performance lag in your app. Making an API call synchronously can be beneficial, however, if there if code in your app that will only execute properly once the API response is received.
## Asynchronous
-Asynchronous calls do not block (or wait) for the API call to return from the server. Execution continues on in your program, and when the call returns from the server, a "callback" function is executed. For example, in the following code using the Apigee JavScript SDK, the function called dogCreateCallback will be called when the create dog API call returns from the server. Meanwhile, execution will continue:
+Asynchronous calls do not block (or wait) for the API call to return from the server. Execution continues on in your program, and when the call returns from the server, a "callback" function is executed. For example, in the following code using the Usergrid JavScript SDK, the function called dogCreateCallback will be called when the create dog API call returns from the server. Meanwhile, execution will continue:
function dogCreateCallback(err, dog) {
alert('I will probably be called second');
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/080f911c/docs/introduction/usergrid-features.md
----------------------------------------------------------------------
diff --git a/docs/introduction/usergrid-features.md b/docs/introduction/usergrid-features.md
index afb3bcb..2ff4a67 100644
--- a/docs/introduction/usergrid-features.md
+++ b/docs/introduction/usergrid-features.md
@@ -76,6 +76,6 @@ To learn more about geolocation, see Geolocation.
## Push notifications
-Push notifications are the most effective way to engage your users with relevant content, and thanks to Usergrid, implementing them can be done in minutes. Simply register your app and your user's devices with a notification provider, such as Apple Push Notification Service or Google Cloud Messaging, then use the API BaaS notification entity to send millions of push notifications a month at no cost. When used in conjunction with queries of user and application data, push notifications become a powerful tool for leveraging user data, ensuring relevancy and driving engagement.
+Push notifications are the most effective way to engage your users with relevant content, and thanks to Usergrid, implementing them can be done in minutes. Simply register your app and your user's devices with a notification provider, such as Apple Push Notification Service or Google Cloud Messaging, then use the Usergrid notification entity to send millions of push notifications a month at no cost. When used in conjunction with queries of user and application data, push notifications become a powerful tool for leveraging user data, ensuring relevancy and driving engagement.
To learn more about push notifications, see Push notifications overview.