Skip to content

document new persisted operations options #165

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
StarpTech merged 1 commit into from
Sep 3, 2025
Merged

document new persisted operations options #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion docs/router/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1077,7 +1077,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 |
| PERSISTED_OPERATIONS_DISABLED | persisted_operations.disabled | <Icon icon="square" /> | Disable persisted operations. | false |
| | 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 Down Expand Up @@ -1865,6 +1865,9 @@ The configuration for the security. The security is used to configure the securi
| SECURITY_BLOCK_NON_PERSISTED_OPERATIONS | block_non_persisted_operations | <Icon icon="square" /> | Block non-persisted Operations. | |
| SECURITY_BLOCK_NON_PERSISTED_OPERATIONS_ENABLED | block_non_persisted_operations.enabled | <Icon icon="square" /> | If the value is true, the non-persisted operations are blocked. | false |
| SECURITY_BLOCK_NON_PERSISTED_OPERATIONS_CONDITION | block_non_persisted_operations.condition | <Icon icon="square" /> | The [expression](/router/configuration/template-expressions) to evaluate if the operation should be blocked. | |
| SECURITY_BLOCK_PERSISTED_OPERATIONS | block_persisted_operations | <Icon icon="square" /> | Block persisted Operations. | |
| SECURITY_BLOCK_PERSISTED_OPERATIONS_ENABLED | block_persisted_operations.enabled | <Icon icon="square" /> | If the value is true, the persisted operations are blocked. | false |
| SECURITY_BLOCK_PERSISTED_OPERATIONS_CONDITION | block_persisted_operations.condition | <Icon icon="square" /> | The [expression](/router/configuration/template-expressions) to evaluate if the operation should be blocked. | |
| | complexity_calculation_cache | <Icon icon="square" /> | Complexity Cache configuration | |
| | complexity_limits | <Icon icon="square" /> | Complexity limits configuration | |
| | parser_limits.approximate_depth_limit | <Icon icon="square" /> | The approximate cumulative depth limit of a query, including fragments. Set to 0 to disable. | 200 |
Expand All @@ -1885,6 +1888,8 @@ security:
enabled: false
block_non_persisted_operations:
enabled: false
block_persisted_operations:
enabled: false
complexity_calculation_cache: # This is for a local in-memory cache, to persist the calculation results
enabled: true
size: 1024
Expand Down