summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordrebs <drebs@leap.se>2017-12-06 17:48:32 -0200
committerdrebs <drebs@leap.se>2017-12-13 13:43:46 -0200
commit8a0daa4a9eddbf8fee0961eaf3ca1a502f55bb0c (patch)
treecd11f2477a487cd96c2bc088b38ec8339c52f1fc /docs
parent5cd3883f9ba98f3e78a818988860da0071c9480b (diff)
[doc] add api doc for blobs backend
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst1
-rw-r--r--docs/api/blobs-server-backend.rst21
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index a184c9f7..31d8b36a 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -8,3 +8,4 @@ API Reference
api/attachments
api/blobs-client
api/blobs-server
+ api/blobs-server-backend
diff --git a/docs/api/blobs-server-backend.rst b/docs/api/blobs-server-backend.rst
new file mode 100644
index 00000000..5a9e1033
--- /dev/null
+++ b/docs/api/blobs-server-backend.rst
@@ -0,0 +1,21 @@
+Blobs Server-side Data Backend API
+==================================
+
+Blobs Backend Interface
+-----------------------
+
+.. autoclass:: leap.soledad.server.interfaces.IBlobsBackend
+ :members:
+ :undoc-members:
+ :special-members: __init__
+ :show-inheritance:
+
+
+Incoming Box Backend Interface
+------------------------------
+
+.. autoclass:: leap.soledad.server.interfaces.IIncomingBoxBackend
+ :members:
+ :undoc-members:
+ :special-members: __init__
+ :show-inheritance: