sachet/sachet-server
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs/files.rst: added url field information for list API POST

Browse Source
This commit is contained in:
dogeystamp 2023-05-21 13:20:23 -04:00
parent 281ad30eec
commit 5fd8fada2c
Signed by: dogeystamp
GPG Key ID: 7225FE3592EFFA38
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/files.rst
View File

@ -163,6 +163,18 @@ To access this endpoint, a user needs the :ref:`create shares<permissions_table>
The share created here is empty, and only contains metadata.
See :ref:`files_content_api` for information on uploading content.
Upon success, the server will respond like this:
.. code-block:: json
{
"status": "success",
"url": "/files/d9eafb5e-af48-40ec-b6fd-f7ea99e6d990"
}
The ``url`` field represents the share you just created.
It can be used in further requests to upload content to the share.
.. _files_content_api:
Content API