Document cache options

api3dao · Nov 25, 2023 · 35f7f73 · 35f7f73
1 parent 50082b3
commit 35f7f73
Showing 1 changed file with 15 additions and 2 deletions.
diff --git a/packages/api/README.md b/packages/api/README.md
@@ -135,9 +135,22 @@ The delay in seconds for the endpoint. The endpoint will only serve data that is
 The maximum number of signed data entries that can be inserted in one batch. This is a safety measure to prevent
 spamming theAPI with large payloads. The batch is rejected if it contains more entries than this value.
 
-#### `cache.maxAgeSeconds`
+#### `cache`
 
-The maximum age of the cache header in seconds.
+Configures the cache for the API endpoints.
+
+Defaults to no cache.
+
+##### `type`
+
+The type of the cache. Options:
+
+- `browser` - Uses the browser cache.
+- `cdn` - Uses the CDN cache. The CDN network needs to support `cdn-cache-control` header.
+
+##### `maxAgeSeconds`
+
+The maximum age of the cache in seconds. The cache is cleared after this time.
 
 #### `allowedAirnodes`