Skip to content

Commit

Permalink
chore: add allowlist to the max aliases documentation (#660)
Browse files Browse the repository at this point in the history
  • Loading branch information
nullswan authored May 29, 2024
1 parent 3a7c38c commit 906b847
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 16 deletions.
13 changes: 7 additions & 6 deletions services/docs/docs/plugins/block-field-suggestions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ Prevent **returning field suggestions** and **leaking your schema** to unauthori
In production, this can lead to Schema leak even if the introspection is disabled.


- [Configurating through GraphQL Armor](#configuring-for-graphql-armor)
- [Standalone usage](#standalone-usage)
- [Installation](#installation)
- [With `@envelop/core` from `@the-guild-org`](#with-envelopcore-from-the-guild-org)
- [Using the default mask](#using-the-default-mask)
- [Using custom mask](#using-custom-mask)
- [Block field suggestions](#block-field-suggestions)
- [Configuring for GraphQL Armor](#configuring-for-graphql-armor)
- [Standalone usage](#standalone-usage)
- [Installation](#installation)
- [With `@envelop/core` from `@the-guild-org`](#with-envelopcore-from-the-guild-org)
- [Using the default mask](#using-the-default-mask)
- [Using custom mask](#using-custom-mask)

## Configuring for GraphQL Armor

Expand Down
11 changes: 6 additions & 5 deletions services/docs/docs/plugins/cost-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

**Limit** the **complexity** of a GraphQL document.

- [Configurating through GraphQL Armor](#configuring-for-graphql-armor)
- [Standalone usage](#standalone-usage)
- [Installation](#installation)
- [With `@graphql/graphql-js`](#with-graphqlgraphql-js)
- [With `@envelop/core` from `@the-guild-org`](#with-envelopcore-from-the-guild-org)
- [Cost limit](#cost-limit)
- [Configuring for GraphQL Armor](#configuring-for-graphql-armor)
- [Standalone usage](#standalone-usage)
- [Installation](#installation)
- [With `@graphql/graphql-js`](#with-graphqlgraphql-js)
- [With `@envelop/core` from `@the-guild-org`](#with-envelopcore-from-the-guild-org)

## Configuring for GraphQL Armor

Expand Down
14 changes: 9 additions & 5 deletions services/docs/docs/plugins/max-aliases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@

It is used to prevent **DOS attack** or **heap overflow**.

- [Configurating through GraphQL Armor](#configuring-for-graphql-armor)
- [Standalone usage](#standalone-usage)
- [Installation](#installation)
- [With `@graphql/graphql-js`](#with-graphqlgraphql-js)
- [With `@envelop/core` from `@the-guild-org`](#with-envelopcore-from-the-guild-org)
- [Max Aliases](#max-aliases)
- [Configuring for GraphQL Armor](#configuring-for-graphql-armor)
- [Standalone usage](#standalone-usage)
- [Installation](#installation)
- [With `@graphql/graphql-js`](#with-graphqlgraphql-js)
- [With `@envelop/core` from `@the-guild-org`](#with-envelopcore-from-the-guild-org)

## Configuring for GraphQL Armor

Expand All @@ -29,6 +30,9 @@ GraphQLArmorConfig({

// Do you want to propagate the rejection to the client? | default: true
propagateOnRejection?: boolean,

// List of queries that are allowed to bypass the plugin
allowList?: string[],
}
})
```
Expand Down

0 comments on commit 906b847

Please sign in to comment.