Skip to content

Commit 3806e20

Browse files
authored
docs: improve descriptions in overrides documentation for clarity (wundergraph#2673)
1 parent f779fcc commit 3806e20

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs-website/studio/overrides.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
---
22
title: "Overrides"
3-
description: "Override the result of breaking changes in schema checks for individual operations which you deem are safe. Overrides are active across all graphs in a namespace."
3+
description: "Override the result of operation checks for breaking changes that affect individual operations that you deem safe. Overrides are active across all graphs in a namespace."
44
icon: overline
55
---
66

77
## Configuring overrides
88

9-
When you run a check against a subgraph, we detect breaking changes that affect operations. On the check page, you can configure overrides for each operation to ignore specific breaking changes in future checks.
9+
As part of a schema check, we detect breaking changes and then run operation checks to determine which operations are affected based on real traffic. On the check page, you can configure overrides to either ignore specific breaking changes for an operation or ignore the entire operation in future checks.
1010

1111
<Info>
12-
Applying overrides will not change the outcome of the check run. Only future checks will take them into account.
12+
Overrides only apply to operation checks. Breaking changes will still be detected and reported — overrides let you either ignore specific breaking changes for an operation or ignore the entire operation during operation checks. They do not affect other parts of a schema check such as composition, breaking change detection, or linting.
13+
</Info>
14+
15+
<Info>
16+
Applying overrides will not change the outcome of the current check run. Only future checks will take them into account.
1317
</Info>
1418

1519
<Frame>

0 commit comments

Comments
 (0)