diff options
| author | drebs <drebs@riseup.net> | 2017-09-28 16:58:45 -0300 |
|---|---|---|
| committer | drebs <drebs@riseup.net> | 2017-09-28 16:58:45 -0300 |
| commit | 638824139e0f90ac917b5827e8f38d47d1a6cda8 (patch) | |
| tree | be04269af9ae6a6fbb39b842fc474b71620fa303 /docs/api.rst | |
| parent | 9694b5424507c03a2494713354e8a20a2f8a8d43 (diff) | |
[doc] add api reference to the docs
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 65 |
1 files changed, 7 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 |