Skip to content

Commit e359408

Browse files
Copilothotlong
andcommitted
Use inclusive terminology: replace whitelist/blacklist with allow list/deny list
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 5530d3b commit e359408

4 files changed

Lines changed: 16 additions & 16 deletions

File tree

content/docs/references/api/graphql.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ const result = GraphQLConfigSchema.parse(data);
120120
| **mode** | `Enum<'optional' \| 'required'>` | optional | Persisted query mode (optional: allow both, required: only persisted) |
121121
| **store** | `object` | optional | Query store configuration |
122122
| **apq** | `object` | optional | Automatic Persisted Queries configuration |
123-
| **allowlist** | `object` | optional | Query allowlist configuration |
123+
| **allowlist** | `object` | optional | Query allow list configuration |
124124
| **security** | `object` | optional | Security configuration |
125125

126126
---

packages/spec/json-schema/api/GraphQLConfig.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1321,7 +1321,7 @@
13211321
"enabled": {
13221322
"type": "boolean",
13231323
"default": false,
1324-
"description": "Enable query allowlist (reject queries not in list)"
1324+
"description": "Enable query allow list (reject queries not in list)"
13251325
},
13261326
"queries": {
13271327
"type": "array",
@@ -1350,11 +1350,11 @@
13501350
},
13511351
"source": {
13521352
"type": "string",
1353-
"description": "External allowlist source (file path or URL)"
1353+
"description": "External allow list source (file path or URL)"
13541354
}
13551355
},
13561356
"additionalProperties": false,
1357-
"description": "Query allowlist configuration"
1357+
"description": "Query allow list configuration"
13581358
},
13591359
"security": {
13601360
"type": "object",

packages/spec/json-schema/api/GraphQLPersistedQuery.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
"enabled": {
9292
"type": "boolean",
9393
"default": false,
94-
"description": "Enable query allowlist (reject queries not in list)"
94+
"description": "Enable query allow list (reject queries not in list)"
9595
},
9696
"queries": {
9797
"type": "array",
@@ -120,11 +120,11 @@
120120
},
121121
"source": {
122122
"type": "string",
123-
"description": "External allowlist source (file path or URL)"
123+
"description": "External allow list source (file path or URL)"
124124
}
125125
},
126126
"additionalProperties": false,
127-
"description": "Query allowlist configuration"
127+
"description": "Query allow list configuration"
128128
},
129129
"security": {
130130
"type": "object",

packages/spec/src/api/graphql.zod.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,10 @@ export const GraphQLTypeConfigSchema = z.object({
126126

127127
/** Fields to include/exclude */
128128
fields: z.object({
129-
/** Include only these fields (whitelist) */
129+
/** Include only these fields (allow list) */
130130
include: z.array(z.string()).optional().describe('Fields to include'),
131131

132-
/** Exclude these fields (blacklist) */
132+
/** Exclude these fields (deny list) */
133133
exclude: z.array(z.string()).optional().describe('Fields to exclude (e.g., sensitive fields)'),
134134

135135
/** Custom field mappings */
@@ -688,7 +688,7 @@ export type GraphQLRateLimit = z.infer<typeof GraphQLRateLimitSchema>;
688688
/**
689689
* Persisted Queries Configuration
690690
*
691-
* Only allow pre-registered queries to execute (whitelist approach).
691+
* Only allow pre-registered queries to execute (allow list approach).
692692
* Improves security and performance.
693693
*/
694694
export const GraphQLPersistedQuerySchema = z.object({
@@ -728,10 +728,10 @@ export const GraphQLPersistedQuerySchema = z.object({
728728
}).optional().describe('APQ cache configuration'),
729729
}).optional().describe('Automatic Persisted Queries configuration'),
730730

731-
/** Query allowlist */
731+
/** Query allow list */
732732
allowlist: z.object({
733-
/** Enable allowlist mode */
734-
enabled: z.boolean().default(false).describe('Enable query allowlist (reject queries not in list)'),
733+
/** Enable allow list mode */
734+
enabled: z.boolean().default(false).describe('Enable query allow list (reject queries not in list)'),
735735

736736
/** Allowed query IDs */
737737
queries: z.array(z.object({
@@ -740,9 +740,9 @@ export const GraphQLPersistedQuerySchema = z.object({
740740
query: z.string().optional().describe('Query string'),
741741
})).optional().describe('Allowed queries'),
742742

743-
/** External allowlist source */
744-
source: z.string().optional().describe('External allowlist source (file path or URL)'),
745-
}).optional().describe('Query allowlist configuration'),
743+
/** External allow list source */
744+
source: z.string().optional().describe('External allow list source (file path or URL)'),
745+
}).optional().describe('Query allow list configuration'),
746746

747747
/** Security */
748748
security: z.object({

0 commit comments

Comments
 (0)