Update documentation for folders

This commit is contained in:
Eike Kettner
2020-07-17 00:02:25 +02:00
parent 94089fd0b6
commit 99210365ce
10 changed files with 54 additions and 8 deletions

View File

@ -49,10 +49,20 @@ your username is not visible.
Example screenshot:
<div class="thumbnail">
<img src="../img/sources-form.jpg">
<img src="../img/sources-form.png">
</div>
This example shows a source with name "test". It defines two urls:
This example shows a source with name "test". Besides a description
and a name that is only used for displaying purposes, a priority and a
[folder](metadata#folders) can be specified.
The priority is used for the processing jobs that are submitted when
files are uploaded via this endpoint.
The folder is used to place all items, that result from uploads to
this endpoint, into this folder.
The source endpoint defines two urls:
- `/app/upload/<id>`
- `/api/v1/open/upload/item/<id>`