old-portfolio/storage-hideyoshi.com
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improves README API Documentation

Browse Source
This commit is contained in:
Vitor Hideyoshi
2023-10-24 08:56:05 -03:00
parent 74cecd50c3
commit ca1edf0a62
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -84,6 +84,14 @@ poetry run ./run-queue.sh --queue
| `username` | `string` | **Required**. Username of file owner | | `username` | `string` | **Required**. Username of file owner |
| `file_postfix` | `string` | **Required**. Type of desired file | | `file_postfix` | `string` | **Required**. Type of desired file |
Returns:
```json
{
"presigned_url": string
}
```
#### Get file write link #### Get file write link
```http ```http
@@ -96,6 +104,15 @@ poetry run ./run-queue.sh --queue
| `file_postfix` | `string` | **Required**. Type of desired file | | `file_postfix` | `string` | **Required**. Type of desired file |
| `file_type` | `string` | **Required**. File format | | `file_type` | `string` | **Required**. File format |
Returns:
```json
{
"presigned_url": string,
"file_key": string
}
```
#### Delete file #### Delete file
```http ```http