Skip to content

Commit

Permalink
Update README.md to add upload completion implementation note. (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
LionelOnTech authored Sep 13, 2023
1 parent da97d96 commit 3da9471
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,9 @@ When the user is finished entering the metadata then the CDE, via a browser redi

The client sends a POST to this URL with additional information (file sizes). The CDE responds with detailed upload instructions specifying the exact sequence of request the client should perform to upload each file to the CDE.

The client proceeds to upload the files as specified by the CDE. When the upload is complete, the CDE provides the client with the document version information.
The client proceeds to upload the files as specified by the CDE. After all file parts are uploaded, the client will send the upload completion request. When the upload is complete, the CDE provides the client with the document version information.

It is highly recommended that for the upload completion request, the server periodically send a whitespace character back to the client to keep the connection from timing out, since upload completion call can take up to several minutes to respond depending on the size of the file uploaded.

#### 3.3.1.2. Identifying Files During the Workflow

Expand Down Expand Up @@ -521,6 +523,8 @@ Body:

After the client has successfully uploaded all binary parts of the document, the server must be notified via the upload completion endpoint. In this example, the url for this endpoint was returned as `https://cde.example.com/upload-completion?upload_session=ee56b8f3-8f93-4819-976e-46a45a5a996f`.

Note that for long running upload completion requests, the server may periodically send back a whitespace character to keep the connection from timing out.

The client just sends a `POST` request without a body to this endpoint and receives a `DocumentVersion` as response:

```json
Expand Down

0 comments on commit 3da9471

Please sign in to comment.