feat: introduce validateWithRules for complete document (sdl and/or executable) and/or existing schema validation#4835
Draft
yaacovCR wants to merge 1 commit into
Draft
Conversation
|
@yaacovCR is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Previously, we could use
validateSDLto validate type system AST against a limited set of SDL rules,validatewhen given a document against a schema to validate the document against the schema, orvalidateSchemato validate a builtGraphQLSchemain a non rules-based manner.This PR introduces
validateWithRulesthat performs integrated rules-based validation on a document containing anything (executable definitions and/or SDL) and/or an existing builtGraphQLSchema. The validation of a built schema is also divided up into rules.By default, when
validateWithRulesis supplied both a document and aGraphQLSchema, existing schema-only errors are not reported; validation focuses on the document and any type-system definitions it contains. SetincludeExistingSchemaErrors: trueto also report errors from the existing schema, evaluated together with the document’s type-system definitions. When only a schema is passed, schema errors are always reported, andincludeExistingSchemaErrors: falsethrows.WIP.