diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 65 | ||||
| -rw-r--r-- | docs/api/attachments.rst | 11 | ||||
| -rw-r--r-- | docs/api/blobs.rst | 11 | ||||
| -rw-r--r-- | docs/api/client.rst | 8 | ||||
| -rw-r--r-- | docs/api/server.rst | 6 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
6 files changed, 44 insertions, 58 deletions
diff --git a/docs/api.rst b/docs/api.rst index 9a725065..362c632c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,60 +1,9 @@ -Soledad API -=========== +API Reference +============= -.. contents:: - :local: +.. toctree:: + :maxdepth: 1 -.. _client-side-code-api: - -Client-side code API --------------------- - -.. autoclass:: leap.soledad.client.Soledad - :members: - :undoc-members: - -.. _client-side-attachments-api: - -Client-side attachments API ---------------------------- - -.. autoclass:: leap.soledad.client._document.AttachmentStates - :members: - :undoc-members: - -.. autointerface:: leap.soledad.client._document.IDocumentWithAttachment - :members: - :undoc-members: - - -.. _server-side-attachments-rest-api: - -Server-side attachments REST API --------------------------------- - -These are the possible ways to interact with the attachments REST API on the -server side: - -=========== ================ ======== ================== -HTTP Method URL Content Possible responses -=========== ================ ======== ================== -GET /user_id - 200 -GET /user_id/blob_id - 200, 404 -PUT /user_id/blob_id The BLOB 200, 409, 507 -DELETE /user_id/blob_id - 200 -=========== ================ ======== ================== - -Server-side attachments code API --------------------------------- - -.. _i-blobs-backend: - -.. autoclass:: leap.soledad.server.interfaces.IBlobsBackend - :members: - :undoc-members: - -.. _filesystem-blobs-backend: - -.. autoclass:: leap.soledad.server._blobs.FilesystemBlobsBackend - :members: - :undoc-members: + api/client + api/blobs + api/attachments diff --git a/docs/api/attachments.rst b/docs/api/attachments.rst new file mode 100644 index 00000000..80b81d67 --- /dev/null +++ b/docs/api/attachments.rst @@ -0,0 +1,11 @@ +Client-side Attachments API +=========================== + +Soledad Documents implement the ``IDocumentWithAttachment`` API that associates +:ref:`blobs` with documents. + +.. autoclass:: leap.soledad.client._document.IDocumentWithAttachment + :members: + :undoc-members: + :special-members: + :show-inheritance: diff --git a/docs/api/blobs.rst b/docs/api/blobs.rst new file mode 100644 index 00000000..fbf31e1c --- /dev/null +++ b/docs/api/blobs.rst @@ -0,0 +1,11 @@ +Client-side Blobs API +===================== + +The Soledad Client object has a ``blobmanager`` property which is responsible +for handling blobs. + +.. autoclass:: leap.soledad.client._db.blobs.BlobManager + :members: + :special-members: __init__ + :undoc-members: + :show-inheritance: diff --git a/docs/api/client.rst b/docs/api/client.rst new file mode 100644 index 00000000..7be3f763 --- /dev/null +++ b/docs/api/client.rst @@ -0,0 +1,8 @@ +Soledad Client API +================== + +.. autoclass:: leap.soledad.client.Soledad + :members: + :undoc-members: + :special-members: __init__ + :show-inheritance: diff --git a/docs/api/server.rst b/docs/api/server.rst new file mode 100644 index 00000000..d93e41ed --- /dev/null +++ b/docs/api/server.rst @@ -0,0 +1,6 @@ +Soledad Server API +================== + +.. automodule:: leap.soledad.server + :members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst index 0aa81dbf..275bad96 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -41,6 +41,7 @@ Soledad documentation client reference development + api Indices and tables ================== |