Update 'README.md'
This commit is contained in:
parent
4ffb57da87
commit
2867e6d9f2
57
README.md
57
README.md
@ -1,2 +1,59 @@
|
|||||||
# filedrop
|
# filedrop
|
||||||
|
|
||||||
|
## Data Base
|
||||||
|
|
||||||
|
### File_Info
|
||||||
|
|
||||||
|
* UUID -- UUID
|
||||||
|
* Name -- Char
|
||||||
|
* mime_type -- Char
|
||||||
|
* uploaded_at -- Unix Time Stamp
|
||||||
|
* Owner -- key to users
|
||||||
|
* is_public -- bool -- display file in get list
|
||||||
|
|
||||||
|
### Data
|
||||||
|
|
||||||
|
* UUID -- UUID
|
||||||
|
* MD5 -- MD5 hash
|
||||||
|
* Path -- char Path to file on local disk
|
||||||
|
* Created -- Unix Time Stamp
|
||||||
|
* Size -- Number -- size in bytes
|
||||||
|
|
||||||
|
### Users
|
||||||
|
|
||||||
|
Simple table as a place holder for user seeded with a `anon` user
|
||||||
|
|
||||||
|
|
||||||
|
## v1 API endpoints
|
||||||
|
|
||||||
|
JSON API
|
||||||
|
|
||||||
|
### /v1/files
|
||||||
|
|
||||||
|
#### `GET`
|
||||||
|
|
||||||
|
Return a JSON list of all files.
|
||||||
|
|
||||||
|
#### `POST`
|
||||||
|
|
||||||
|
Takes a new file, retuning the UUID and MD5 of the file. In the user is not logged in, it will belong to `anon`
|
||||||
|
|
||||||
|
### /v1/files/{UUID}
|
||||||
|
|
||||||
|
#### `GET`
|
||||||
|
|
||||||
|
return the file with correct MIME type as RAW data.
|
||||||
|
|
||||||
|
#### `PUT`
|
||||||
|
|
||||||
|
Post new file data about file. Editable fileds are `tpye` and `is_public`.
|
||||||
|
|
||||||
|
#### `DELETE`
|
||||||
|
|
||||||
|
removes file.
|
||||||
|
|
||||||
|
### /v1/files/{user}
|
||||||
|
|
||||||
|
#### `get`
|
||||||
|
|
||||||
|
Return a JSON list of all files for a user.
|
Loading…
x
Reference in New Issue
Block a user