Skip to content

Commit 5cc723f

Browse files
committed
fix: docs
1 parent 1b6d5c7 commit 5cc723f

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

src/Options/Definitions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ module.exports.ParseServerOptions = {
399399
maxGraphQLQueryComplexity: {
400400
env: 'PARSE_SERVER_MAX_GRAPH_QLQUERY_COMPLEXITY',
401401
help:
402-
'Maximum query complexity for GraphQL queries. Controls depth and number of operations.* Format: { depth: number, fields: number }* - depth: Maximum depth of nested field selections* - fields: Maximum number of operations (queries/mutations) in a single request* If both maxIncludeQueryComplexity and maxGraphQLQueryComplexity are provided, maxIncludeQueryComplexity values* must be lower than maxGraphQLQueryComplexity values to avoid validation conflicts.',
402+
'Maximum query complexity for GraphQL queries. Controls depth and number of field selections.* Format: { depth: number, fields: number }* - depth: Maximum depth of nested field selections* - fields: Maximum number of field selections in a single request* If both maxIncludeQueryComplexity and maxGraphQLQueryComplexity are provided, maxIncludeQueryComplexity values* must be lower than maxGraphQLQueryComplexity values to avoid validation conflicts.',
403403
action: parsers.objectParser,
404404
},
405405
maxIncludeQueryComplexity: {

src/Options/docs.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/Options/index.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ type RequestKeywordDenylist = {
4444
value: any,
4545
};
4646
type GraphQLQueryComplexityOptions = {
47-
depth: number,
48-
fields: number,
47+
depth?: number,
48+
fields?: number,
4949
};
5050
type IncludeComplexityOptions = {
51-
depth: number,
52-
count: number,
51+
depth?: number,
52+
count?: number,
5353
};
5454

5555
export interface ParseServerOptions {
@@ -363,10 +363,10 @@ export interface ParseServerOptions {
363363
* must be lower than maxGraphQLQueryComplexity values to avoid validation conflicts.
364364
*/
365365
maxIncludeQueryComplexity: ?IncludeComplexityOptions;
366-
/* Maximum query complexity for GraphQL queries. Controls depth and number of operations.
366+
/* Maximum query complexity for GraphQL queries. Controls depth and number of field selections.
367367
* Format: { depth: number, fields: number }
368368
* - depth: Maximum depth of nested field selections
369-
* - fields: Maximum number of operations (queries/mutations) in a single request
369+
* - fields: Maximum number of field selections in a single request
370370
* If both maxIncludeQueryComplexity and maxGraphQLQueryComplexity are provided, maxIncludeQueryComplexity values
371371
* must be lower than maxGraphQLQueryComplexity values to avoid validation conflicts.
372372
*/

types/Options/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ type RequestKeywordDenylist = {
2727
value: any;
2828
};
2929
type GraphQLQueryComplexityOptions = {
30-
depth: number;
31-
fields: number;
30+
depth?: number;
31+
fields?: number;
3232
};
3333
type IncludeComplexityOptions = {
34-
depth: number;
35-
count: number;
34+
depth?: number;
35+
count?: number;
3636
};
3737
export interface ParseServerOptions {
3838
appId: string;

0 commit comments

Comments
 (0)