diff options
| author | drebs <drebs@leap.se> | 2017-06-07 17:44:12 -0300 |
|---|---|---|
| committer | drebs <drebs@leap.se> | 2017-06-07 17:44:12 -0300 |
| commit | 70a070d941a165377a0b2fd7a84bf0b443b46ea9 (patch) | |
| tree | 07ec93162e2de6e7bf515c5a175ee88a15d58154 /docs/api.rst | |
| parent | 0776862f274d86e2d9cdb941e74496d5f4c555c9 (diff) | |
[doc] separate api in it's own section
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 00000000..9a725065 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,60 @@ +Soledad API +=========== + +.. contents:: + :local: + +.. _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: |