Skip to content

Commit 13a5456

Browse files
committed
docs: adds s3filemetadata
1 parent 45fa3d2 commit 13a5456

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,6 +514,18 @@ This will result in the dashboard being available via `HTTPS` and the signed URL
514514

515515
Since we use `TLS` enabled endpoints for development, running MinIO in secure mode will satisfy any browser security policies.
516516

517+
### S3FileMetadata
518+
519+
The template provides a `SQLAlchemy` table called `S3FileMetadata` this is used to store metadata about file uploads.
520+
521+
The client sends a request with the file `name`, `size` and `mime type`, the endpoint create a `S3FileMetadata` and returns an pre-signed upload URL, that the client must post the contents of the file to.
522+
523+
The client can take as long as it takes it upload the contents, but must begin uploading within the signed life e.g five minutes from when the URL is generated.
524+
525+
The template is designed to schedule a task to check if the object made it to the store. It continues to check this for a period of time and marks the file to be available if the contents are found on the object store.
526+
527+
The client must keep polling back to the server to see if the file is eventually available.
528+
517529
## Taskfile
518530

519531
[Task](https://taskfile.dev) is a task runner / build tool that aims to be simpler and easier to use than, for example, GNU Make. Wile it's useful to know the actual commands it's easy to use a tool like task to make things easier on a daily basis:

0 commit comments

Comments
 (0)