Emojigit
/
bepasty-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documenting required permission for REST apis

master
OGAWA Hirofumi 2020-11-14 01:48:03 +09:00
parent e2b3069750
commit 8cb43e9166
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/rest.rst
View File

@ -68,7 +68,9 @@ API Interface::
POST /apis/rest/items
When uploading a file, chunked upload is mandatory. Check the MAX_BODY_SIZE for the maximum chunk size that can
be sent to the server. The body of the post request contains the base64 encoded binary of the file to be uploaded.
be sent to the server. The body of the post request contains the
base64 encoded binary of the file to be uploaded. (required
permission: :ref:`create <permissions>`)
POST Request by the client
--------------------------
@ -123,6 +125,8 @@ API Interface::
GET /apis/rest/items/<itemname>
(required permission: :ref:`read <permissions>`)
GET Request by the client
-------------------------
@ -176,6 +180,8 @@ API Interface::
GET /apis/rest/items
(required permission: :ref:`list <permissions>`)
GET Request by the client
-------------------------
@ -211,6 +217,8 @@ API Interface::
GET /apis/rest/items/<itemname>/download
(required permission: :ref:`read <permissions>`)
GET Response by the server
--------------------------
Example Response::