sangria.validation.rules

Executable definitions

A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.

Fields on correct type

A GraphQL document is only valid if all fields selected are defined by the parent type, or are an allowed meta field such as __typename

Fragments on composite type

Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.

All inferred variables within input document should not conflict in it's inferred type

Known argument names

A GraphQL field is only valid if all supplied arguments are defined by that field.

Known directives

A GraphQL document is only valid if all @directives are known by the schema and legally positioned.

Known fragment names

A GraphQL document is only valid if all ...Fragment fragment spreads refer to fragments defined in the same document.

Known type names

A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.

Lone anonymous operation

A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand) that it contains only that one operation definition.

No undefined variables

A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.

No unused fragments

A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.

No unused variables

A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.

Overlapping fields can be merged

A selection set is only valid if all fields (including spreading any fragments) either correspond to distinct response names or can be merged without ambiguity.

The algorithm is described in CachedCheck.

The validation rule implements the same validation as OverlappingFieldsCanBeMerged and could eventually replace it. It is an alternative, more performant implementation.

Possible fragment spread

A fragment spread is only valid if the type condition could ever possibly be true: if there is a non-empty intersection of the possible parent types, and possible types which pass the type condition.

Provided required arguments

A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.

Scalar leafs

A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.

Subscriptions must only include one field.

A GraphQL subscription is valid only if it contains a single root field.

Unique argument names

A GraphQL field or directive is only valid if all supplied arguments are uniquely named.

Unique directive names per location

A GraphQL document is only valid if all directives at a given location are uniquely named.

Unique fragment names

A GraphQL document is only valid if all defined fragments have unique names.

Unique input field names

A GraphQL input object value is only valid if all supplied fields are uniquely named.

Unique operation names

A GraphQL document is only valid if all defined operations have unique names.

Unique variable names

A GraphQL operation is only valid if all its variables are uniquely named.

Value literals of correct type

A GraphQL document is only valid if all value literals are of the type expected at their position.

Variables are input types

A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).

Variables passed to field arguments conform to type