Merge branch 'dev' of https://github.com/redmatrix/hubzilla into dev

1 files changed, 237 insertions, 4 deletions

diff --git a/doc/developer/api_zot.md b/doc/developer/api_zot.md
index 26af72298..2458da8b2 100644
--- a/doc/developer/api_zot.md
+++ b/doc/developer/api_zot.md
@@ -14,13 +14,121 @@ Export channel data
 channel/stream
 ================================================================================
 
-Fetch conversation items 
+Fetch channel conversation items 
+
+network/stream
+================================================================================
+
+Fetch network conversation items 
+
 
 
 files
 ================================================================================
 
-List file storage
+List file storage (attach DB)
+
+GET /api/z/1.0/files
+
+
+Options:
+
+	- hash
+		return only entries matching hash (exactly)
+
+	- filename
+		return only entries matching filename (substring)
+
+	- filetype
+		return only entries matching filetype/mimetype (substring)
+
+	- start
+		start at record (default 0)
+
+	- records
+		number of records to return or 0 for unlimited
+
+
+
+Example: 
+
+curl -u mychannel:mypassword https://xyz.macgirvin.com/api/z/1.0/files -d filetype=multipart/mixed
+
+
+Returns:
+
+	{
+	
+	    "success": true,
+	    "results": [
+	        {
+	            "id": "1",
+	            "aid": "1",
+	            "uid": "2",
+	            "hash": "44ee8b2a1a7f36dea07b93b7747a2383a1bc0fdd08339e8928bfcbe45f65d939",
+	            "filename": "Profile Photos",
+	            "filetype": "multipart/mixed",
+	            "filesize": "0",
+	            "revision": "0",
+	            "folder": "",
+	            "os_storage": "1",
+	            "is_dir": "1",
+	            "is_photo": "0",
+	            "flags": "0",
+	            "created": "2016-01-02 21:51:17",
+	            "edited": "2016-01-02 21:51:17",
+	            "allow_cid": "",
+	            "allow_gid": "",
+	            "deny_cid": "",
+	            "deny_gid": ""
+	        },
+	        {
+	            "id": "12",
+	            "aid": "1",
+	            "uid": "2",
+	            "hash": "71883f1fc64af33889229cbc79c5a056deeec5fc277d765f182f19073e1b2998",
+	            "filename": "Cover Photos",
+	            "filetype": "multipart/mixed",
+	            "filesize": "0",
+	            "revision": "0",
+	            "folder": "",
+	            "os_storage": "1",
+	            "is_dir": "1",
+	            "is_photo": "0",
+	            "flags": "0",
+	            "created": "2016-01-15 00:24:33",
+	            "edited": "2016-01-15 00:24:33",
+	            "allow_cid": "",
+	            "allow_gid": "",
+	            "deny_cid": "",
+	            "deny_gid": ""
+	        },
+	        {
+	            "id": "16",
+	            "aid": "1",
+	            "uid": "2",
+	            "hash": "f48f7ec3278499d1dd86b72c3207beaaf4717b07df5cc9b373f14d7aad2e1bcd",
+	            "filename": "2016-01",
+	            "filetype": "multipart/mixed",
+	            "filesize": "0",
+	            "revision": "0",
+	            "folder": "",
+	            "os_storage": "1",
+	            "is_dir": "1",
+	            "is_photo": "0",
+	            "flags": "0",
+	            "created": "2016-01-22 03:24:55",
+	            "edited": "2016-01-22 03:26:57",
+	            "allow_cid": "",
+	            "allow_gid": "",
+	            "deny_cid": "",
+	            "deny_gid": ""
+	        }
+		]
+	}
+
+
+
 
 filemeta
 ================================================================================
@@ -30,7 +138,69 @@ Export file metadata for any uploaded file
 filedata
 ================================================================================
 
-Export file contents for any uploaded file
+Provides the ability to download a file from cloud storage in chunks
+
+GET /api/z/1.0/filedata
+
+
+Required:
+
+	- file_id
+		attach.hash of desired file ('begins with' match)
+
+
+Optional:
+
+	- start
+		starting byte of returned data in file (counting from 0)
+
+	- length
+		length (prior to base64 encoding) of chunk to download 
+
+
+Returns:
+
+	attach (DB) structure with base64 encoded 'content' comprised of the desired chunk
+
+
+
+Example:
+
+	https://xyz.macgirvin.com/api/z/1.0/filedata?f=&file_id=9f5217770fd&start=0&length=48
+
+Returns:
+
+	{
+	
+    	"attach": {
+	        "id": "107",
+    	    "aid": "1",
+	        "uid": "2",
+    	    "hash": "9f5217770fd55d563bd77f84d534d8e119a187514bbd391714626cd9c0e60207",
+	        "creator": "pgcJx1IQjuPkx8aI9qheJlBMZzJz-oTPjHy3h5pWlOVOriBO_cSiUhhqwhuZ74TYJ8_ECO3pPiRMWC0q8YPCQg",
+    	    "filename": "pcxtopbm.c",
+	        "filetype": "application/octet-stream",
+    	    "filesize": "3934",
+	        "revision": "0",
+    	    "folder": "",
+	        "flags": "0",
+    	    "is_dir": "0",
+	        "is_photo": "0",
+    	    "os_storage": "1",
+	        "os_path": "",
+    	    "display_path": "",
+	        "content": "LyogcGN4dG9wYm0uYyAtIGNvbnZlcnQgUEMgcGFpbnRicnVzaCAoLnBjeCkgZmls",
+    	    "created": "2016-07-24 23:13:01",
+	        "edited": "2016-07-24 23:13:01",
+    	    "allow_cid": "",
+	        "allow_gid": "",
+    	    "deny_cid": "",
+	        "deny_gid": "",
+    	    "start": 0,
+	        "length": 48
+    	}
+	
+	}
 
 
 file/export
@@ -42,7 +212,70 @@ file
 albums
 ================================================================================
 
-List photo albums
+Description: list photo albums
+
+GET /api/z/1.0/albums
+
+
+Output:
+
+	text - textual name
+
+	total - number of photos in this album
+
+	url - web URL
+
+	urlencode - textual name, urlencoded
+
+	bin2hex - textual name using bin2hex (which is used in the web URL link)
+
+
+Example:
+
+
+	{
+	
+	    "success": true,
+	    "albums": [
+	        {
+	            "text": "/",
+	            "total": "2",
+	            "url": "https://xyz.macgirvin.com/photos/hubzilla/album/",
+	            "urlencode": "",
+	            "bin2hex": ""
+	        },
+		        {
+	            "text": "2016-01",
+	            "total": "6",
+	            "url": "https://xyz.macgirvin.com/photos/hubzilla/album/323031362d3031",
+	            "urlencode": "2016-01",
+	            "bin2hex": "323031362d3031"
+	        },
+	        {
+	            "text": "2016-02",
+	            "total": "7",
+	            "url": "https://xyz.macgirvin.com/photos/hubzilla/album/323031362d3032",
+	            "urlencode": "2016-02",
+	            "bin2hex": "323031362d3032"
+	        },
+	        {
+	            "text": "Cover Photos",
+	            "total": "5",
+	            "url": "https://xyz.macgirvin.com/photos/hubzilla/album/436f7665722050686f746f73",
+	            "urlencode": "Cover+Photos",
+	            "bin2hex": "436f7665722050686f746f73"
+	        },
+	        {
+	            "text": "Profile Photos",
+	            "total": "26",
+	            "url": "https://xyz.macgirvin.com/photos/hubzilla/album/50726f66696c652050686f746f73",
+	            "urlencode": "Profile+Photos",
+	            "bin2hex": "50726f66696c652050686f746f73"
+	        }
+	    ]
+	
+	}
+
 
 
 photos