Fix multiple typos in docs (#639)

* Fox type in block field suggestion docs * Fix GraphQLArmor typo in docs * Fix GraphQLArmor typo in docs
Escape-Technologies · Apr 24, 2024 · 27c79bf · 27c79bf
1 parent 7d49232
commit 27c79bf
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 10 deletions.
diff --git a/services/docs/docs/configuration/examples.md b/services/docs/docs/configuration/examples.md
@@ -14,7 +14,7 @@ Currently, there is no global parameter but a **per-plugin parameter**.
 Here is an example to set **every plugin** to be **inoffensive**:
 
 ```ts
-GraphQLArmor({
+GraphQLArmorConfig({
   costLimit: {
     propagateOnRejection: false,
   },
@@ -54,7 +54,7 @@ const logRejection = (ctx: ValidationContext | null, error: GraphQLError) => {
     console.log(`rejected request: ${error}`)
 }
 
-GraphQLArmor({
+GraphQLArmorConfig({
   costLimit: {
     onReject: [logRejection]
   },

diff --git a/services/docs/docs/plugins/block-field-suggestions.md b/services/docs/docs/plugins/block-field-suggestions.md
@@ -15,8 +15,8 @@ In production, this can lead to Schema leak even if the introspection is disable
 ## Configuring for GraphQL Armor
 
 ```ts
-GraphQLArmor({
-  blockFieldSuggestions: {
+GraphQLArmorConfig({
+  blockFieldSuggestion: {
     // Toogle the plugin | default: true
     enabled?: boolean,
 
@@ -31,7 +31,7 @@ GraphQLArmor({
 ### Installation
 
 :::note
-If you want to use the `blockFieldSuggestions` plugin out of GraphQL Armor, you can install it from npm:
+If you want to use the `blockFieldSuggestion` plugin out of GraphQL Armor, you can install it from npm:
 :::
 
 ```bash

diff --git a/services/docs/docs/plugins/cost-limit.md b/services/docs/docs/plugins/cost-limit.md
@@ -11,7 +11,7 @@
 ## Configuring for GraphQL Armor
 
 ```ts
-GraphQLArmor({
+GraphQLArmorConfig({
   costLimit: {
     // Toogle the plugin | default: true
     enabled?: boolean,

diff --git a/services/docs/docs/plugins/max-aliases.md b/services/docs/docs/plugins/max-aliases.md
@@ -13,7 +13,7 @@ It is used to prevent **DOS attack** or **heap overflow**.
 ## Configuring for GraphQL Armor
 
 ```ts
-GraphQLArmor({
+GraphQLArmorConfig({
   maxAliases: {
     // Toogle the plugin | default: true
     enabled?: boolean,

diff --git a/services/docs/docs/plugins/max-depth.md b/services/docs/docs/plugins/max-depth.md
@@ -15,7 +15,7 @@ It is used to prevent too large queries that could lead to overfetching or **DOS
 ## Configuring for GraphQL Armor
 
 ```ts
-GraphQLArmor({
+GraphQLArmorConfig({
   maxDepth: {
     // Toogle the plugin | default: true
     enabled?: boolean,

diff --git a/services/docs/docs/plugins/max-directives.md b/services/docs/docs/plugins/max-directives.md
@@ -15,7 +15,7 @@ It is used to prevent **DOS attack**, **heap overflow** or **server overloading*
 ## Configuring for GraphQL Armor
 
 ```ts
-GraphQLArmor({
+GraphQLArmorConfig({
   maxDirectives: {
     // Toogle the plugin | default: true
     enabled?: boolean,

diff --git a/services/docs/docs/plugins/max-tokens.md b/services/docs/docs/plugins/max-tokens.md
@@ -17,7 +17,7 @@ The token limit is often limited by the graphql parser, but this is not always t
 ## Configuring for GraphQL Armor
 
 ```ts
-GraphQLArmor({
+GraphQLArmorConfig({
   maxTokens: {
     // Toogle the plugin | default: true
     enabled?: boolean,