Skip to content

README.md

Latest commit

 

History

History
52 lines (32 loc) · 1.99 KB

README.md

File metadata and controls

52 lines (32 loc) · 1.99 KB

Documentation

Please see each section for in-depth documentation

Configuration

This section describes the configuration options for GraphQL Protect.

Run modes

Protect supports various running modes for different needs and purposes.

  • serve runs as an HTTP proxy protection your GraphQL during runtime. Check out the Deployment Options section for more configuration options
  • validate runs as a CLI tool, validating your Persisted Operations against your schema and configured protections.
  • version outputs versioning info of protect

HTTP configuration

Protections

This section contains all the documentation about each protection feature.

Run

This section contains in depth documentation for run strategies

Known Limitations

Graphql Spec Support

GraphQL Protect makes use of gqlparser to parse and validate GraphQL schemas & GraphQL requests. Gqlparser's spec support is and select portions of the Draft. gqlparser uses graphql-js as a reference implementation, resulting a similar level of graphql spec support.

If experience any issues related to spec support, or you want to verify the (draft spec) feature you want to use is supported, it's best to inspect the gqlparser library directly for your use case.

Response encoding

Currently, handling encoded responses from the upstream is not supported, we're open for contributions : )