Skip to content

add additional info for HTTP Cache #652

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions docs/06_reference/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,12 @@ def get_data(url):
fail("GET %s failed with status %d: %s", url, res.status_code, res.body())
return res.json()
```
**NOTES ABOUT HTTP CACHE*:*
- **Scope:** the HTTP cache is scoped _per app_ and not _per installation_. All installations of your app will share the same cache. This is a common source of bugs!
- **Minimum:** the client will cache requests for a minimum of 5 seconds
- **Jitter:** the client will randomly select a TTL that is +/- 10% of the requested TTL
- **Rate Limits:** the clients respects 429s, and will cache the response for period recommended by the API
- **Cache Control:** if a developer does not request a TTL, and the API provides a max-age cache control header, the client will honor the response at a maximum of 1 hour

## Pixlet module: Cache

Expand Down
Loading