Commit bf16401b authored by jkvis's avatar jkvis
Browse files

Updated documentation

parent 158b6fb1
...@@ -97,7 +97,7 @@ An optional copy of this structure is found at `/<SECONDARY_PATH>/`. ...@@ -97,7 +97,7 @@ An optional copy of this structure is found at `/<SECONDARY_PATH>/`.
Web hooks (actions) Web hooks (actions)
------------------- -------------------
An optional web hook can be specified. A HTTP `POST` request will be issued to this URL with the metadata JSON object: An optional web hook can be specified. A HTTP `POST` request will be issued to this URL with the metadata JSON object.
The web hook shall reply with a HTTP 200-299 status code if it can handle this transfer succesfully. The web hook shall reply with a HTTP 200-299 status code if it can handle this transfer succesfully.
...@@ -152,7 +152,6 @@ Response: ...@@ -152,7 +152,6 @@ Response:
``` ```
{ {
"required": [ "required": [
"title",
"files" "files"
], ],
"type": "object", "type": "object",
...@@ -348,6 +347,7 @@ Short description | Cause(s) | Remedy ...@@ -348,6 +347,7 @@ Short description | Cause(s) | Remedy
`missing upload file` | No file was uploaded. | Upload a file. `missing upload file` | No file was uploaded. | Upload a file.
`missing User-Id` | The `User-Id` header was missing. All API calls require the `User-Id`. | Include the `User-Id` header. `missing User-Id` | The `User-Id` header was missing. All API calls require the `User-Id`. | Include the `User-Id` header.
`secondary copy failed` | See `file saving failed`. | See `file saving failed`. `secondary copy failed` | See `file saving failed`. | See `file saving failed`.
`transfer initiation locked` | Another transfer initiation is already in progress. | Wait until the previous request is handled.
`unknown file` | The uploaded filename was not found in the metadata. | Make sure you uploaded the right file and/or check your metadata. `unknown file` | The uploaded filename was not found in the metadata. | Make sure you uploaded the right file and/or check your metadata.
`unknown transfer` | Either a unknown Transfer-Id URL was used while uploading a file or you tried to access a unknown transfer. | Check your Transfer-Id. `unknown transfer` | Either a unknown Transfer-Id URL was used while uploading a file or you tried to access a unknown transfer. | Check your Transfer-Id.
`unknown user` | You supplied unknown user credentials. | Provide your secret user hash. `unknown user` | You supplied unknown user credentials. | Provide your secret user hash.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment