From ca1edf0a62fd1792c436bb0fd1e497a3d7c5c825 Mon Sep 17 00:00:00 2001 From: Vitor Hideyoshi Date: Tue, 24 Oct 2023 08:56:05 -0300 Subject: [PATCH] Improves README API Documentation --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index b830de2..fc3bc90 100644 --- 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