Skip to content

Commit

Permalink
chore: doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
João Pinho committed Dec 26, 2023
1 parent d8a7038 commit 7955b32
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions packages/large-response-middleware/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Enables Lambdas to return responses larger than 6MB by offloading the content to S3 and returning a reference to the S3 file.

<p align="center">
<img src="./docs/out/architecture-1/Architecture%20-%20Sequence%20Diagram.svg" />
<img src="docs/out/architecture-1/Architecture - Sequence Diagram.svg" />
</p>

When a client can handle a Large Response, it must send a request with the HTTP Header `Accept: application/large-response.vnd+json`. The `application/large-response.vnd+json` is a custom MIME type indicating that the client agrees to receive a large response payload when necessary. The response body for the `large-response.vnd+json` MIME type is in the following format:
Expand All @@ -22,8 +22,8 @@ If the client does not provide the large response MIME type, the Lambda will log

Supported Parameters:

| Parameter | Type | Description |
| --------------- | ----------------- | ---------------------------------------------------------------------------- |
| Parameter | Type | Description |
| --------------- | ------------------- | ---------------------------------------------------------------------------- |
| thresholdWarn | `number` | Warning threshold level (percentage of `sizeLimitInMB`), e.g: 0.80 |
| thresholdError | `number` | Error threshold level (percentage of `sizeLimitInMB`), e.g: 0.90 |
| sizeLimitInMB | `number` | Maximum allowed size limit in MB, e.g 6 |
Expand Down
4 changes: 2 additions & 2 deletions packages/large-response-middleware/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions packages/large-response-middleware/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@epilot/large-response-middleware",
"version": "0.0.4",
"version": "0.0.6",
"license": "MIT",
"repository": {
"type": "git",
Expand All @@ -22,7 +22,7 @@
},
"files": [
"lib/",
"docs/out/Architecture - Sequence Diagram.svg",
"docs/out/",
"README.md"
],
"scripts": {
Expand Down

0 comments on commit 7955b32

Please sign in to comment.