more zot api documentation

This commit is contained in:
zotlabs 2016-12-04 02:53:17 -08:00
parent 792527d456
commit bd4bdab81c
3 changed files with 108 additions and 0 deletions

View File

@ -0,0 +1,16 @@
API group_members
=================
GET /api/z/1.0/group_members
Required:
group_id or group_name
Returns:
abook+xchan (DB join) for each member of the privacy group

12
doc/api/group.md Normal file
View File

@ -0,0 +1,12 @@
API group
=========
GET /api/z/1.0/group
Description: list privacy groups
Returns: DB tables of all privacy groups. To use with API group_members, provide group_id from the id element returned in this call, or group_name from the gname returned in this call.

80
doc/api_zot.md Normal file
View File

@ -0,0 +1,80 @@
Zot API
=======
api/z/1.0/channel/export/basic
Export channel data
api/z/1.0/channel/stream
Fetch conversation items
api/z/1.0/files
List file storage
api/z/1.0/filemeta
Export file metadata for any uploaded file
api/z/1.0/filedata
Export file contents for any uploaded file
api/z/1.0/file/export
api/z/1.0/file
api/z/1.0/albums
List photo albums
api/z/1.0/photos
list photo metadata
api/z/1.0/photo
[api/z/1.0/group](help/api/group)
List privacy groups
[api/z/1.0/group_members](help/api/group_members)
List members of a privacy group
[api/z/1.0/xchan](help/api/api_xchan)
Global extended channel (identity) information
[api/z/1.0/item/update](help/api/api_item_update)
Create or update an item (post, activity, webpage, etc.)
api/z/1.0/item/full
Get all data associated with an item
api/z/1.0/abook
Connections
api/z/1.0/abconfig
Connection metadata (such as permissions)
api/z/1.0/perm_allowed
Check a permission for a given xchan