Skip to content

docs: option to force disable persisted operations #114

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.

Sign up for GitHub

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

Merged
endigma merged 2 commits into from
Jul 4, 2025
Merged

docs: option to force disable persisted operations #114

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d15de2
Document persisted_operations.disabled config option
endigma Jul 3, 2025
bc2756e
Add to example yaml and fix indent
endigma Jul 4, 2025
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
32 changes: 17 additions & 15 deletions docs/router/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1021,14 +1021,15 @@ The configuration for the persisted operations allows you to maintain a fixed se
version: "1"

persisted_operations:
log_unknown: false
safelist:
enabled: false
cache:
size: 100MB
storage:
provider_id: s3
object_prefix: wundergraph
disabled: false
log_unknown: false
safelist:
enabled: false
cache:
size: 100MB
storage:
provider_id: s3
object_prefix: wundergraph
```

### Persisted Operations Configuration Options
Expand All @@ -1038,6 +1039,7 @@ These rules apply to requests being made from the Router to all Subgraphs.
| Environment Variable | YAML | Required | Description | Default Value |
| ------------------------------------------ | ------------------------------------------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| | persisted_operations | <Icon icon="square" /> | The configuration for the persisted operations. | |
| PERSISTED_OPERATIONS_DISABLED | persisted_operations.disabled | <Icon icon="square" /> | When set to `true`, all requests using persisted operations will be blocked and the router will return an error response. | false |
Comment thread
endigma marked this conversation as resolved.
| | persisted_operations.cache | <Icon icon="square" /> | LRU cache for persisted operations. | |
| PERSISTED_OPERATIONS_CACHE_SIZE | persisted_operations.cache.size | <Icon icon="square" /> | The size of the cache in SI unit. | "100MB" |
| | persisted_operations.storage | <Icon icon="square" /> | The storage provider for persisted operation. Only one provider can be active. When no provider is specified, the router will fallback to the Cosmo CDN provider to download the persisted operations. | |
Expand All @@ -1058,13 +1060,13 @@ It defaults to using a local cache (with the size defined in `cache.size`), but
version: "1"

automatic_persisted_queries:
enabled: true
cache:
size: 10MB # This is only relevant for an in-memory cache that we maintain
ttl: 900 # in seconds, set both for a local and a remote KV
storage:
provider_id: "my_redis"
object_prefix: cosmo_apq
enabled: true
cache:
size: 10MB # This is only relevant for an in-memory cache that we maintain
ttl: 900 # in seconds, set both for a local and a remote KV
storage:
provider_id: "my_redis"
object_prefix: cosmo_apq
```

### Configuration Options
Expand Down