Skip to content

Document the maxSize attribute of submission upload configurations #383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bram-atmire wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document the maxSize attribute of submission upload configurations #383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion submissionuploads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Provide detailed information about a specific input-form. The JSON response docu
{
"id": "default",
"required": true,
"max-size": 536870912,
"maxSize": 536870912,
"accessConditionOptions": [
{
"name": "openaccess"
Expand Down Expand Up @@ -50,6 +50,8 @@ The attributes of the objects in the accessConditionOptions arrays are as follow

A null value for the accessConditionOptions attribute means that the upload step doesn't allow the user to set a policy for the file. The file will get only the policies inherited from the collection.

The *maxSize* attribute is the largest file, in bytes, that this upload step accepts: the `maxSize` configured for the upload configuration (or `upload.max`), capped by the REST server's multipart limit (`spring.servlet.multipart.max-file-size`). It is absent when no limit applies. Clients should check a file against it before sending any data; the backend also rejects a larger file with the section error `error.validation.filesize`.

Exposed links:
* metadata: it is a link to the submission-form to use for the files metadata

Expand Down