docs: usage documentation

inveniosoftware / invenio-files-rest

REST API for uploading/downloading files for Invenio.

https://invenio-files-rest.readthedocs.io

MIT License

9 stars 68 forks source link

docs: usage documentation #198

Open lnielsen opened 5 years ago

lnielsen commented 5 years ago

[x] REST API
[x] Storage backends
- [x] Building your own storage backend.
[x] Uploading files (incl. and )
- [x] JS uploaders
- [x] Multipart Upload
- [x] Large file uploads
  - Custom Flask class/formparser.
  - Nginx
  - MAX_CONTENT_LENGTH
[x] Serving files (incl. security)
[x] Permissions
[x] Integrity checking
[x] Signals (file_downloaded)
[x] Data migration

vlad-bm commented 5 years ago

[JS Uploaders]: We would like to know in more detail what the scope of this section should be. Additionally, in the code there are a couple of helper methods ngfileupload_partfactory and ngfileupload_partfactory which I am not sure of how they would work.