aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzotlabs <mike@macgirvin.com>2017-06-11 23:28:55 -0700
committerzotlabs <mike@macgirvin.com>2017-06-11 23:28:55 -0700
commit6ce9eedb5fe746a70416fb66128d6b0ead6f949a (patch)
tree7592d509628544a813b7a871093da8a0f722214e
parent6f78183b74bbe50a6e96dca78f6724c882a668b1 (diff)
downloadvolse-hubzilla-6ce9eedb5fe746a70416fb66128d6b0ead6f949a.tar.gz
volse-hubzilla-6ce9eedb5fe746a70416fb66128d6b0ead6f949a.tar.bz2
volse-hubzilla-6ce9eedb5fe746a70416fb66128d6b0ead6f949a.zip
doco for the channel basic export api call
-rw-r--r--doc/developer/api_zot.bb15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/developer/api_zot.bb b/doc/developer/api_zot.bb
index a114c7c44..b2c19d7a1 100644
--- a/doc/developer/api_zot.bb
+++ b/doc/developer/api_zot.bb
@@ -4,7 +4,20 @@ The API endpoints detailed below are relative to [code]api/z/1.0[/code], meaning
[h3]channel/export/basic[/h3]
-Export channel data
+Export basic channel data
+
+Options:
+ - sections
+ comma-separated list of data types to export
+
+ - posts
+ if true, return default sections plus 3 months of posts
+
+ If no sections are requested, the following sections are returned:
+ channel, connections, config, apps, chatrooms, events, webpages, mail, wikis
+
+ Files and large collections of posts may run into memory limits; these must generally be
+ requested separately.
[h3]channel/stream[/h3]