Improves README API Documentation

2023-10-24 08:56:05 -03:00
parent 74cecd50c3
commit ca1edf0a62
1 changed files with 17 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -84,6 +84,14 @@ poetry run ./run-queue.sh --queue
 | `username`     | `string` | **Required**. Username of file owner |
 | `file_postfix` | `string` | **Required**. Type of desired file   |

+Returns:
+
+```json
+{
+    "presigned_url": string
+}
+```
+
 #### Get file write link

 ```http
@@ -96,6 +104,15 @@ poetry run ./run-queue.sh --queue
 | `file_postfix` | `string` | **Required**. Type of desired file   |
 | `file_type`    | `string` | **Required**. File format            |

+Returns:
+
+```json
+{
+    "presigned_url": string,
+    "file_key": string
+}
+```
+
 #### Delete file

 ```http