diff options
author | zotlabs <mike@macgirvin.com> | 2016-12-04 02:53:17 -0800 |
---|---|---|
committer | zotlabs <mike@macgirvin.com> | 2016-12-04 02:53:17 -0800 |
commit | bd4bdab81ce6b6d2cd8f602677e5cbb299c0c6b0 (patch) | |
tree | 9ffcf97d99d356424317d5a5de0f03e501c85b7f | |
parent | 792527d456a031696f93015fb4fc91e60dee151b (diff) | |
download | volse-hubzilla-bd4bdab81ce6b6d2cd8f602677e5cbb299c0c6b0.tar.gz volse-hubzilla-bd4bdab81ce6b6d2cd8f602677e5cbb299c0c6b0.tar.bz2 volse-hubzilla-bd4bdab81ce6b6d2cd8f602677e5cbb299c0c6b0.zip |
more zot api documentation
-rw-r--r-- | doc/api/api_group_members.md | 16 | ||||
-rw-r--r-- | doc/api/group.md | 12 | ||||
-rw-r--r-- | doc/api_zot.md | 80 |
3 files changed, 108 insertions, 0 deletions
diff --git a/doc/api/api_group_members.md b/doc/api/api_group_members.md new file mode 100644 index 000000000..f4bcfa4e3 --- /dev/null +++ b/doc/api/api_group_members.md @@ -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 + diff --git a/doc/api/group.md b/doc/api/group.md new file mode 100644 index 000000000..76df1c8e6 --- /dev/null +++ b/doc/api/group.md @@ -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. + +
\ No newline at end of file diff --git a/doc/api_zot.md b/doc/api_zot.md new file mode 100644 index 000000000..3ba536550 --- /dev/null +++ b/doc/api_zot.md @@ -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 |