Skip to content

Commit 6257abb

Browse files
committed
Add reviewer suggestions
1 parent db75a07 commit 6257abb

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

documentation/limits.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Parser limits"
2+
title: "Limits"
33
date: 2024-11-24T10:00:00+10:00
44
description: Configuring limits to prevent DoS attacks
55
---
@@ -35,9 +35,9 @@ public static final int MAX_RULE_DEPTH = 500;
3535
```
3636

3737
## Introspection Query Limits
38-
Introspection queries can be a vector for attacks by causing a "field explosion". graphql-java includes measures to limit introspection queries:
38+
graphql-java includes measures to limit introspection queries:
3939

40-
**GoodFaithIntrospection:** Ensures introspection queries do not exploit the "field explosion" trick and limits the depth and field count.
40+
**GoodFaithIntrospection:** Ensures introspection queries remain under a reasonable size.
4141

4242
```java
4343
public static final int GOOD_FAITH_MAX_FIELDS_COUNT = 500;
@@ -47,6 +47,6 @@ public static final int GOOD_FAITH_MAX_DEPTH_COUNT = 20;
4747
## Instrumentation
4848
Beyond parser level limits, graphql-java provides instrumentation to manage query complexity:
4949

50-
**MaxQueryDepthInstrumentation:** Limits the depth of a query to prevent overly complex queries.
50+
**MaxQueryComplexityInstrumentation:** Limits the complexity of a query to prevent excessive resource usage. [See example on the Instrumentation page](/documentation/master/instrumentation#query-complexity-instrumentation).
5151

52-
**MaxQueryComplexityInstrumentation:** Limits the complexity of a query to prevent excessive resource usage.
52+
**MaxQueryDepthInstrumentation:** Limits the depth of a query to prevent overly complex queries. [See example on the Instrumentation page](/documentation/master/instrumentation#query-depth-instrumentation)

versioned_docs/version-v21/limits.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Parser limits"
2+
title: "Limits"
33
date: 2024-11-24T10:00:00+10:00
44
description: Configuring limits to prevent DoS attacks
55
---
@@ -35,9 +35,9 @@ public static final int MAX_RULE_DEPTH = 500;
3535
```
3636

3737
## Introspection Query Limits
38-
Introspection queries can be a vector for attacks by causing a "field explosion". graphql-java includes measures to limit introspection queries:
38+
graphql-java includes measures to limit introspection queries:
3939

40-
**GoodFaithIntrospection:** Ensures introspection queries do not exploit the "field explosion" trick and limits the depth and field count.
40+
**GoodFaithIntrospection:** Ensures introspection queries remain under a reasonable size.
4141

4242
```java
4343
public static final int GOOD_FAITH_MAX_FIELDS_COUNT = 500;
@@ -47,6 +47,6 @@ public static final int GOOD_FAITH_MAX_DEPTH_COUNT = 20;
4747
## Instrumentation
4848
Beyond parser level limits, graphql-java provides instrumentation to manage query complexity:
4949

50-
**MaxQueryDepthInstrumentation:** Limits the depth of a query to prevent overly complex queries.
50+
**MaxQueryComplexityInstrumentation:** Limits the complexity of a query to prevent excessive resource usage. [See example on the Instrumentation page](/documentation/master/instrumentation#query-complexity-instrumentation).
5151

52-
**MaxQueryComplexityInstrumentation:** Limits the complexity of a query to prevent excessive resource usage.
52+
**MaxQueryDepthInstrumentation:** Limits the depth of a query to prevent overly complex queries. [See example on the Instrumentation page](/documentation/master/instrumentation#query-depth-instrumentation)

versioned_docs/version-v22/limits.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Parser limits"
2+
title: "Limits"
33
date: 2024-11-24T10:00:00+10:00
44
description: Configuring limits to prevent DoS attacks
55
---
@@ -35,9 +35,9 @@ public static final int MAX_RULE_DEPTH = 500;
3535
```
3636

3737
## Introspection Query Limits
38-
Introspection queries can be a vector for attacks by causing a "field explosion". graphql-java includes measures to limit introspection queries:
38+
graphql-java includes measures to limit introspection queries:
3939

40-
**GoodFaithIntrospection:** Ensures introspection queries do not exploit the "field explosion" trick and limits the depth and field count.
40+
**GoodFaithIntrospection:** Ensures introspection queries remain under a reasonable size.
4141

4242
```java
4343
public static final int GOOD_FAITH_MAX_FIELDS_COUNT = 500;
@@ -47,6 +47,6 @@ public static final int GOOD_FAITH_MAX_DEPTH_COUNT = 20;
4747
## Instrumentation
4848
Beyond parser level limits, graphql-java provides instrumentation to manage query complexity:
4949

50-
**MaxQueryDepthInstrumentation:** Limits the depth of a query to prevent overly complex queries.
50+
**MaxQueryComplexityInstrumentation:** Limits the complexity of a query to prevent excessive resource usage. [See example on the Instrumentation page](/documentation/master/instrumentation#query-complexity-instrumentation).
5151

52-
**MaxQueryComplexityInstrumentation:** Limits the complexity of a query to prevent excessive resource usage.
52+
**MaxQueryDepthInstrumentation:** Limits the depth of a query to prevent overly complex queries. [See example on the Instrumentation page](/documentation/master/instrumentation#query-depth-instrumentation)

0 commit comments

Comments
 (0)