Adding in missing section references, still more work to do on this. (cherry picked from commit b91895cd844bbe42d07c2a7c5d5f09402ab76cbe)
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/c4116fa2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/c4116fa2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/c4116fa2 Branch: refs/heads/two-dot-o-dev Commit: c4116fa2ed86de641c1e33b176b68be1d678e9a4 Parents: 24aa4da Author: Dave Johnson <snoopd...@apache.org> Authored: Thu Aug 6 11:36:14 2015 -0400 Committer: Dave Johnson <snoopd...@apache.org> Committed: Wed Aug 12 13:02:44 2015 -0400 ---------------------------------------------------------------------- .../file-storage-configuration.md | 39 - docs/asset-and-files/folders.md | 85 -- docs/asset-and-files/legacy-asset-support.md | 0 docs/asset-and-files/retrieving-assets.md | 27 - docs/asset-and-files/uploading-assets.md | 86 -- .../file-storage-configuration.md | 39 + docs/assets-and-files/folders.md | 85 ++ docs/assets-and-files/legacy-asset-support.md | 0 docs/assets-and-files/retrieving-assets.md | 27 + docs/assets-and-files/uploading-assets.md | 86 ++ docs/introduction/usergrid-features.md | 28 +- docs/rest-endpoints/api-docs.md | 1151 +++++++----------- docs/security-and-auth/using-permissions.md | 2 +- docs/user-management/activity.md | 6 +- docs/user-management/group.md | 12 +- docs/user-management/messagee-example.md | 2 +- docs/user-management/working-user-data.md | 12 +- 17 files changed, 707 insertions(+), 980 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/asset-and-files/file-storage-configuration.md ---------------------------------------------------------------------- diff --git a/docs/asset-and-files/file-storage-configuration.md b/docs/asset-and-files/file-storage-configuration.md deleted file mode 100644 index c56265a..0000000 --- a/docs/asset-and-files/file-storage-configuration.md +++ /dev/null @@ -1,39 +0,0 @@ -# File storage configuration - -Usergrid can store your assets either on your hard drive or in the Amazon S3 cloud. - -Local storage configuration ---- - -By default assets are stored in the temporary folder /tmp/usergrid -This can be changed by editing this file /stack/rest/src/main/resources/usergrid-rest-context.xml and replacing {usergrid.temp.files} by the wanted destination -```xml -<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.LocalFileBinaryStore"> - <property name="reposLocation" value="${usergrid.temp.files}"/> -</bean> -``` - -AwS S3 configuration ---- - -To use your AWS S3 storage you need to change the binaryStore classpath and add several constructor arguments in /stack/rest/src/main/resources/usergrid-rest-context.xml - -Some examples : -```xml -<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore"> - <constructor-arg name="accessId" value="x" /> - <constructor-arg name="secretKey" value="xx" /> - <constructor-arg name="bucketName" value="x" /> - <constructor-arg name="regionName" value="eu-central-1" /> -</bean> -``` -the regionName field is not mandatory, this code is also valid -```xml -<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore"> - <constructor-arg name="accessId" value="x" /> - <constructor-arg name="secretKey" value="xx" /> - <constructor-arg name="bucketName" value="x" /> -</bean> -``` - -The filesize is limited to 50GB but you need to keep in mind that the file has to be stored on the hard drive before being sended to Amazon. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/asset-and-files/folders.md ---------------------------------------------------------------------- diff --git a/docs/asset-and-files/folders.md b/docs/asset-and-files/folders.md deleted file mode 100644 index 7c425be..0000000 --- a/docs/asset-and-files/folders.md +++ /dev/null @@ -1,85 +0,0 @@ -# Folders - -## Linking a folder to an asset -In order to access the asset for the image in the folder, you need to link the folder to the asset. You can do that by issuing a POST request in the following format: - - POST /{org-uuid}/{app-uuid}/folders/{folder-uuid}/assets/{assets_id} - -where ``{folder-uuid}`` is the UUID of the folder, and ``{assets-uuid}`` is the UUID of the assets entity. - -Hereâs how you could link the folder and the asset you created for the my-image.jpg image: - - POST https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b - -In the response, you should see the assets entity for the image added to the folder: - - { - "action": "post", - "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491", - "params": {}, - "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", - "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets";, - "entities": [ - { - "uuid": "9501cda1-2d21-11e2-b4c6-02e81ac5a17b", - "type": "asset", - "name": "my-image.jpg", - "created": 1352763303163, - "modified": 1352763303163, - "metadata": { - "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b" - }, - "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1", - "path": "/myassets/asset1" - } - ], - "timestamp": 1352830448045, - "duration": 54, - "organization": "my-orgâ, - "applicationName": "my-app" - } - -## Retrieve list of folder assets -You can also request a list of the linked contents of the folder like this: - - GET https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets - -The response should look something like this: - - { - "action": "get", - "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491", - "params": { - "_": [ - "1352830364891" - ] - }, - "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", - "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets";, - "entities": [ - { - "uuid": "7bf47435-2ac8-11e2-b4c6-02e81ac5a17b", - "type": "asset", - "name": "my-image.jpg", - "created": 1352505133598, - "modified": 1352507245108, - "checksum": "8e0cd3866ee20746c99e9a9825f38ad8", - "content-length": 11853, - "content-type": "image/jpeg", - "etag": "\"8e0cd3866ee20746c99e9a9825f38ad8\"", - "metadata": { - "connecting": { - "assets": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b/connecting/assets" - }, - "connection": "assets", - "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b" - }, - "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1", - "path": "my-image" - } - ], - "timestamp": 1352830363797, - "duration": 57, - "organization": "my-org", - "applicationName": "my-app" - } http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/asset-and-files/legacy-asset-support.md ---------------------------------------------------------------------- diff --git a/docs/asset-and-files/legacy-asset-support.md b/docs/asset-and-files/legacy-asset-support.md deleted file mode 100644 index e69de29..0000000 http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/asset-and-files/retrieving-assets.md ---------------------------------------------------------------------- diff --git a/docs/asset-and-files/retrieving-assets.md b/docs/asset-and-files/retrieving-assets.md deleted file mode 100644 index 9313ae8..0000000 --- a/docs/asset-and-files/retrieving-assets.md +++ /dev/null @@ -1,27 +0,0 @@ -# Retrieving assets - -## Retrieving asset data - -To retrieve the asset from an entity, send a ``GET`` request with the ``Accept`` header set to the content type of the asset. The content type can be retrieved from the ``file-metadata.content-type`` property of the entity the asset is attached to. - -### Request syntax - - curl -X GET -H 'Accept: <content_type>' 'https://api.usergrid.com/<org>/<app>/<collection>/<entity> - -Parameters - -Parameter Description ---------- ----------- -content_type The content type of the attached asset. For example, text/plain, image/jpeg. -org Organization UUID or organization name -app Application UUID or application name -collection Name or UUID of the collection of the entity the asset is attached to. -entity Name or UUID of the entity the asset is attached to. - -### Example request -The following request will retrieve the data for a jpeg file attached to an entity named 'cloud' in the 'pictures' collection: - - curl -X GET -H 'Accept: image/jpeg' 'https://api.usergrid.com/your-org/your-app/pictures/cloud - -## Retrieving an asset entity -To retrieve the entity that an asset is attached to, perform a ``GET`` request as you normally would to retrieve an entity. For more information, see [Retrieving Data Entities](../data-storage/entities.html#retrieving-data-entities). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/asset-and-files/uploading-assets.md ---------------------------------------------------------------------- diff --git a/docs/asset-and-files/uploading-assets.md b/docs/asset-and-files/uploading-assets.md deleted file mode 100644 index c5b836f..0000000 --- a/docs/asset-and-files/uploading-assets.md +++ /dev/null @@ -1,86 +0,0 @@ -# Uploading assets - -With Usergrid, you can store and retrieve files and assets that hold data objects such as images, video, and audio content. - -Usergrid manages these objects as Asset entities. Optionally, you can use Folder entities to organize related assets. - -## Uploading assets -Assets can be any file type and can be attached to any entity. When an asset is uploaded, Usergrid will automatically detect the file metadata for the asset and save it in the associated entity as a ``file-metadata`` property. Only 1 asset can be attached to an entity. - -To attach an asset to an entity, do the following: - -### Request syntax - - curl -X POST -F name='<filename>' -F file=@<file_location> 'https://api.usergrid.com/<org>/<app>/<collection>/<entity> - -Parameters - -Parameter Description ---------- ----------- -filename A filename to associate with the asset. -file_location The location of the asset to be uploaded. -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 attach the asset to. -entity Name or UUID of an existing entity you want to attach the asset to. - -### Example request - - curl -X POST -i -F name='clouds' -F file=@happy_clouds.jpg 'https://api.usergrid.com/your-org/your-app/pictures/' - -### Example response - -Notice the ``file-metadata`` property in the response. - - { - "action" : "post", - "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0", - "params" : { }, - "path" : "/users", - "uri" : "https://api.usergrid.com/amuramoto/sandbox/pictures";, - "entities" : [ { - "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376", - "type" : "user", - "name" : "test", - "created" : 1395681911491, - "modified" : 1399069838919, - "name" : "clouds", - "file" : "fobnszewobnioerabnoiawegbrn\n", - "file-metadata" : { - "content-type" : "image/jpeg", - "etag" : "\"2e1db7299b0a667ed80e674a0ef9d653\"", - "last-modified" : 1399070010115, - "content-length" : 28, - "checksum" : "2e1db7299b0a667ed80e674a0ef9d653" - }, - "metadata" : { - "connecting" : { - "likes" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes" - }, - "path" : "/users/410b213a-b379-11e3-a0e5-9953085ea376", - "sets" : { - "rolenames" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles", - "permissions" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions" - }, - "connections" : { - "follows" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/follows" - }, - "collections" : { - "activities" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/activities", - "devices" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/devices", - "feed" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/feed", - "groups" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/groups", - "roles" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles", - "following" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/following", - "followers" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/followers" - } - } - } ], - "timestamp" : 1399070009986, - "duration" : 441, - "organization" : "your-org", - "applicationName" : "your-app" - } - -## Updating assets -To update the data for an asset, perform the same request outlined above in 'Uploading assets' as a ``PUT`` request rather than a ``POST``. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/assets-and-files/file-storage-configuration.md ---------------------------------------------------------------------- diff --git a/docs/assets-and-files/file-storage-configuration.md b/docs/assets-and-files/file-storage-configuration.md new file mode 100644 index 0000000..c56265a --- /dev/null +++ b/docs/assets-and-files/file-storage-configuration.md @@ -0,0 +1,39 @@ +# File storage configuration + +Usergrid can store your assets either on your hard drive or in the Amazon S3 cloud. + +Local storage configuration +--- + +By default assets are stored in the temporary folder /tmp/usergrid +This can be changed by editing this file /stack/rest/src/main/resources/usergrid-rest-context.xml and replacing {usergrid.temp.files} by the wanted destination +```xml +<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.LocalFileBinaryStore"> + <property name="reposLocation" value="${usergrid.temp.files}"/> +</bean> +``` + +AwS S3 configuration +--- + +To use your AWS S3 storage you need to change the binaryStore classpath and add several constructor arguments in /stack/rest/src/main/resources/usergrid-rest-context.xml + +Some examples : +```xml +<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore"> + <constructor-arg name="accessId" value="x" /> + <constructor-arg name="secretKey" value="xx" /> + <constructor-arg name="bucketName" value="x" /> + <constructor-arg name="regionName" value="eu-central-1" /> +</bean> +``` +the regionName field is not mandatory, this code is also valid +```xml +<bean id="binaryStore" class="org.apache.usergrid.services.assets.data.AwsSdkS3BinaryStore"> + <constructor-arg name="accessId" value="x" /> + <constructor-arg name="secretKey" value="xx" /> + <constructor-arg name="bucketName" value="x" /> +</bean> +``` + +The filesize is limited to 50GB but you need to keep in mind that the file has to be stored on the hard drive before being sended to Amazon. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/assets-and-files/folders.md ---------------------------------------------------------------------- diff --git a/docs/assets-and-files/folders.md b/docs/assets-and-files/folders.md new file mode 100644 index 0000000..7c425be --- /dev/null +++ b/docs/assets-and-files/folders.md @@ -0,0 +1,85 @@ +# Folders + +## Linking a folder to an asset +In order to access the asset for the image in the folder, you need to link the folder to the asset. You can do that by issuing a POST request in the following format: + + POST /{org-uuid}/{app-uuid}/folders/{folder-uuid}/assets/{assets_id} + +where ``{folder-uuid}`` is the UUID of the folder, and ``{assets-uuid}`` is the UUID of the assets entity. + +Hereâs how you could link the folder and the asset you created for the my-image.jpg image: + + POST https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b + +In the response, you should see the assets entity for the image added to the folder: + + { + "action": "post", + "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491", + "params": {}, + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", + "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets";, + "entities": [ + { + "uuid": "9501cda1-2d21-11e2-b4c6-02e81ac5a17b", + "type": "asset", + "name": "my-image.jpg", + "created": 1352763303163, + "modified": 1352763303163, + "metadata": { + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/9501cda1-2d21-11e2-b4c6-02e81ac5a17b" + }, + "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1", + "path": "/myassets/asset1" + } + ], + "timestamp": 1352830448045, + "duration": 54, + "organization": "my-orgâ, + "applicationName": "my-app" + } + +## Retrieve list of folder assets +You can also request a list of the linked contents of the folder like this: + + GET https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets + +The response should look something like this: + + { + "action": "get", + "application": "3400ba10-cd0c-11e1-bcf7-12313d1c4491", + "params": { + "_": [ + "1352830364891" + ] + }, + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets", + "uri": "https://api.usergrid.com/my-org/my-app/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets";, + "entities": [ + { + "uuid": "7bf47435-2ac8-11e2-b4c6-02e81ac5a17b", + "type": "asset", + "name": "my-image.jpg", + "created": 1352505133598, + "modified": 1352507245108, + "checksum": "8e0cd3866ee20746c99e9a9825f38ad8", + "content-length": 11853, + "content-type": "image/jpeg", + "etag": "\"8e0cd3866ee20746c99e9a9825f38ad8\"", + "metadata": { + "connecting": { + "assets": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b/connecting/assets" + }, + "connection": "assets", + "path": "/folders/6640a601-2ac6-11e2-92c3-02e81ae640dc/assets/7bf47435-2ac8-11e2-b4c6-02e81ac5a17b" + }, + "owner": "5c0c1789-d503-11e1-b36a-12313b01d5c1", + "path": "my-image" + } + ], + "timestamp": 1352830363797, + "duration": 57, + "organization": "my-org", + "applicationName": "my-app" + } http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/assets-and-files/legacy-asset-support.md ---------------------------------------------------------------------- diff --git a/docs/assets-and-files/legacy-asset-support.md b/docs/assets-and-files/legacy-asset-support.md new file mode 100644 index 0000000..e69de29 http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/assets-and-files/retrieving-assets.md ---------------------------------------------------------------------- diff --git a/docs/assets-and-files/retrieving-assets.md b/docs/assets-and-files/retrieving-assets.md new file mode 100644 index 0000000..9313ae8 --- /dev/null +++ b/docs/assets-and-files/retrieving-assets.md @@ -0,0 +1,27 @@ +# Retrieving assets + +## Retrieving asset data + +To retrieve the asset from an entity, send a ``GET`` request with the ``Accept`` header set to the content type of the asset. The content type can be retrieved from the ``file-metadata.content-type`` property of the entity the asset is attached to. + +### Request syntax + + curl -X GET -H 'Accept: <content_type>' 'https://api.usergrid.com/<org>/<app>/<collection>/<entity> + +Parameters + +Parameter Description +--------- ----------- +content_type The content type of the attached asset. For example, text/plain, image/jpeg. +org Organization UUID or organization name +app Application UUID or application name +collection Name or UUID of the collection of the entity the asset is attached to. +entity Name or UUID of the entity the asset is attached to. + +### Example request +The following request will retrieve the data for a jpeg file attached to an entity named 'cloud' in the 'pictures' collection: + + curl -X GET -H 'Accept: image/jpeg' 'https://api.usergrid.com/your-org/your-app/pictures/cloud + +## Retrieving an asset entity +To retrieve the entity that an asset is attached to, perform a ``GET`` request as you normally would to retrieve an entity. For more information, see [Retrieving Data Entities](../data-storage/entities.html#retrieving-data-entities). \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/assets-and-files/uploading-assets.md ---------------------------------------------------------------------- diff --git a/docs/assets-and-files/uploading-assets.md b/docs/assets-and-files/uploading-assets.md new file mode 100644 index 0000000..c5b836f --- /dev/null +++ b/docs/assets-and-files/uploading-assets.md @@ -0,0 +1,86 @@ +# Uploading assets + +With Usergrid, you can store and retrieve files and assets that hold data objects such as images, video, and audio content. + +Usergrid manages these objects as Asset entities. Optionally, you can use Folder entities to organize related assets. + +## Uploading assets +Assets can be any file type and can be attached to any entity. When an asset is uploaded, Usergrid will automatically detect the file metadata for the asset and save it in the associated entity as a ``file-metadata`` property. Only 1 asset can be attached to an entity. + +To attach an asset to an entity, do the following: + +### Request syntax + + curl -X POST -F name='<filename>' -F file=@<file_location> 'https://api.usergrid.com/<org>/<app>/<collection>/<entity> + +Parameters + +Parameter Description +--------- ----------- +filename A filename to associate with the asset. +file_location The location of the asset to be uploaded. +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 attach the asset to. +entity Name or UUID of an existing entity you want to attach the asset to. + +### Example request + + curl -X POST -i -F name='clouds' -F file=@happy_clouds.jpg 'https://api.usergrid.com/your-org/your-app/pictures/' + +### Example response + +Notice the ``file-metadata`` property in the response. + + { + "action" : "post", + "application" : "f34f4222-a166-11e2-a7f7-02e81adcf3d0", + "params" : { }, + "path" : "/users", + "uri" : "https://api.usergrid.com/amuramoto/sandbox/pictures";, + "entities" : [ { + "uuid" : "410b213a-b379-11e3-a0e5-9953085ea376", + "type" : "user", + "name" : "test", + "created" : 1395681911491, + "modified" : 1399069838919, + "name" : "clouds", + "file" : "fobnszewobnioerabnoiawegbrn\n", + "file-metadata" : { + "content-type" : "image/jpeg", + "etag" : "\"2e1db7299b0a667ed80e674a0ef9d653\"", + "last-modified" : 1399070010115, + "content-length" : 28, + "checksum" : "2e1db7299b0a667ed80e674a0ef9d653" + }, + "metadata" : { + "connecting" : { + "likes" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/connecting/likes" + }, + "path" : "/users/410b213a-b379-11e3-a0e5-9953085ea376", + "sets" : { + "rolenames" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles", + "permissions" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/permissions" + }, + "connections" : { + "follows" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/follows" + }, + "collections" : { + "activities" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/activities", + "devices" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/devices", + "feed" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/feed", + "groups" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/groups", + "roles" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/roles", + "following" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/following", + "followers" : "/users/410b213a-b379-11e3-a0e5-9953085ea376/followers" + } + } + } ], + "timestamp" : 1399070009986, + "duration" : 441, + "organization" : "your-org", + "applicationName" : "your-app" + } + +## Updating assets +To update the data for an asset, perform the same request outlined above in 'Uploading assets' as a ``PUT`` request rather than a ``POST``. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/c4116fa2/docs/introduction/usergrid-features.md ---------------------------------------------------------------------- diff --git a/docs/introduction/usergrid-features.md b/docs/introduction/usergrid-features.md index 5e57071..1a2f0d6 100644 --- a/docs/introduction/usergrid-features.md +++ b/docs/introduction/usergrid-features.md @@ -10,21 +10,21 @@ With Usergrid, developers can set up their own cloud-based data platform in minu At the core of Usergrid is a flexible platform that can store any type of application data, from simple records like a catalog of books to complex associations like user relationships. No matter what type of data drives your app, you can store it as collections of data entities and immediately perform complex queries or full-text searches on any field. You can also create custom entities with custom properties, giving you the ability to store data and context in a way that makes sense for your app. -To learn more about entities and collections, see Usergrid Data model. +To learn more about entities and collections, see [Usergrid Data model](data-model.html). -For a complete list of the default data entities available, see Default Data Entity Types. +For a complete list of the default data entities available, see [Models](../rest-endpoint/api-docs.html#models). ### Files & assets Images, video, and audio are key components of a great app experience. With Usergrid, you can upload and retrieve binary objects from the same data store as the rest of your application data, eliminating the need to set up content delivery networks (CDNs) and easing implementation. We handle all the back-end details that keep your content quickly accessible. -To learn more about files and asset storage, see Uploading files and assets . +To learn more about files and asset storage, see [Uploading files and assets](../assets-and-files/uploading-assets.html). ## Flexible data querying One of Usergrid' most powerful features is the ability to perform SQL-style queries and full-text searches on data entities, as well as their properties. This lets you quickly retrieve specific data entities based on multiple criteria, then utilize that data to power social features, target push notifications, perform user analysis, and more. -Learn more about querying app data, see Data query overview. +Learn more about querying app data, see [Data query overview](../data-queries/querying-your-data.html). ## Social @@ -32,13 +32,13 @@ Learn more about querying app data, see Data query overview. You can create relationships between data entities to help build features, improve user experience, and contextualize data. For example, you might associate a user with their devices to capture valuable geolocation data, create relationships between users to build social graphs, or implement popular features such as activity streams. -To learn more about entity relationships, see Entity connections. +To learn more about entity relationships, see [Entity connections](../entity-connections/connecting-entities.html). ### Activity streams A key aspect of social networking apps is the ability to provide and publish data streams of user actions, such as ongoing lists of comments, activities, and tweets. Usergrid simplifies management and routing of these data streams by providing an activity entity that is specifically designed to automatically create a relationship between activities and the user who created them. -To learn more about activities and activity feeds, see Activity feeds. +To learn more about activities and activity feeds, see [Activity feeds](../user-management/activity.html). ## User management @@ -46,7 +46,7 @@ To learn more about activities and activity feeds, see Activity feeds. You can easily add and manage users by providing the core services necessary to handle secure registration and log in, including OAuth 2.0-compliant client authentication. In addition, any number of default or custom data entities and properties can be associated with a user entity to create complete user profiles. -To learn more about user management, see User. +To learn more about user management, see [User Management](../user-management/user-management.html). To learn more about authentication, see Authenticating users and application clients. @@ -54,28 +54,28 @@ To learn more about authentication, see Authenticating users and application cli Applications often require the ability to configure fine-grain control of user access to data, features and functionality. Usergrid solves the implementation details of user access with roles and permissions. Simply create roles that represent user types or access levels, such as Administrator, then assign the necessary permissions to that role. With a single API call, you can then associate your roles with any user or group of users. -To learn more about user roles and permissions, see Managing access by defining permission rules. +To learn more about user roles and permissions, see [Using Permissions](../security-and-auth/securing-your-app.html). ### Groups Groups are a flexible way to organize your users based on any number of criteria. For example, you might group users based on interests or location to more effectively deliver relevant content, target offers, or customize campaigns. You can also take advantage of the groups entity to enable group-based social networking activities, such as allowing your users to create private information feeds or circles of friends. -To learn more about groups, see Working with group data. +To learn more about groups, see [Working with group data](../user-management/groups.html). ### Third-party authentication In addition to supporting user management and OAuth-based login for your app, Usergrid also makes it easy to integrate third-party authentication through such popular services as Facebook, Twitter and other OAuth-enabled accounts. Providing third-party sign-in can improve user experience, while increasing adoption, giving you access to valuable information from social networks and services. -To learn more about using third-party sign-in, see Facebook sign in. +To learn more about using third-party sign-in, see [Facebook sign in](../security-and-auth/facebook-sign.html). ## Geolocation The device entity allows you to capture geolocation data from your users' GPS-enabled devices to more effectively target campaigns, push notifications, offers and more. Geolocation also gives you an important data point for contextualizing and analyzing trends and user behavior. -To learn more about geolocation, see Geolocation. +To learn more about geolocation, see [Geolocation](../geolocation/geolocation.html). -## Push notifications +## Push notifications (Coming soon...) -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. +__(Coming Usergrid 2.0)__ 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. +To learn more about push notifications, see [Push notifications overview](../push-notifications/tbd.html).
