Skip to content

Commit e8f7401

Browse files
MESH-2329 update api spec with actual size limits
1 parent 758c976 commit e8f7401

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

specification/mesh-api.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1380,12 +1380,12 @@ paths:
13801380
Use this endpoint to send a message via MESH. Use the POST command to your virtual outbox. Specify the message recipient in the request headers, with the message contained in the request body.
13811381
13821382
### Messages larger than 100MB
1383-
100MB (20MB on internet) is the largest data payload the MESH API accepts in a single request. Compress larger messages to reduce bandwidth and data storage on Spine. If compression does not sufficiently reduce the message size enough for transmission in a single request then you can break it up into smaller chunks and transmit them separately provided:
1383+
The largest data payload the MESH API accepts in a single request is 100MB. Compress larger messages to reduce bandwidth and data storage on Spine. If compression does not sufficiently reduce the message size enough for transmission in a single request then you can break it up into smaller chunks and transmit them separately provided:
13841384
1. The total compressed size of the message is < 100MB - this is the Spine upper limit for a single message.
13851385
2. The receiver mailbox and workflow identifier support the downloading of chunked messages. MESH UI and older versions of the MESH client do not support this.
13861386
13871387
To correctly break the outbound message into valid chunks:
1388-
1. Split the **uncompressed** message into `n` ordered chunks such that each (compressed) chunk is smaller than 20MB.
1388+
1. Split the **uncompressed** message into `n` ordered chunks such that each (compressed) chunk is smaller than 100MB.
13891389
2. **Independently** compress each chunk with the same compression algorithm (e.g. `gzip`).
13901390
3. The first (compressed) chunk of the message should be transmitted using this endpoint (the normal send message endpoint). Include the optional `Mex-Chunk-Range` header with a value `1:n` to tell Spine that this is a chunked message and to wait for `n-1` other requests before delivering the message. The message identifier of this initial server response **must** be captured as it is a required path element of the Send chunked message URL.
13911391
@@ -1668,7 +1668,7 @@ paths:
16681668
summary: Send chunked message
16691669
description: |-
16701670
## Overview
1671-
Use this endpoint to send a chunked message. The 'Send Message' endpoint has a maximum single request message payload size of 100MB over HSCN or 20MB over the internet. However, you can send much larger messages (up to 20GB) by breaking up the message into chunks and transmitting it over multiple requests.
1671+
Use this endpoint to send a chunked message. The 'Send Message' endpoint has a maximum single request message payload size of 100MB. However, you can send much larger messages (up to 20GB) by breaking up the message into chunks and transmitting it over multiple requests.
16721672
16731673
**Note**: Some workflow ids do not support chunking because it is not currently supported in the MESH UI and older versions of the MESH client. Check with your receiving organisation before sending messages with this endpoint.
16741674

0 commit comments

Comments
 (0)