From 5fd8fada2c23172cced9f49e297a4379242b2c94 Mon Sep 17 00:00:00 2001 From: dogeystamp Date: Sun, 21 May 2023 13:20:23 -0400 Subject: [PATCH] docs/files.rst: added url field information for list API POST --- docs/files.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/files.rst b/docs/files.rst index 93f27ad..4709651 100644 --- a/docs/files.rst +++ b/docs/files.rst @@ -163,6 +163,18 @@ To access this endpoint, a user needs the :ref:`create shares 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