Operation directives
GraphQL uses directives to modify the evaluation of an item in the schema or the operation. Operation directives can be included inside any operation (query, subscription, mutation) and can be used to modify the execution of the operation or the values returned by the operation.
Directives can help avoid having to create resolvers for values that can be computed via the values of additional fields.
All Directives are proceeded by @
symbol
Default Operation directives
Strawberry provides two default operation directives:
-
@skip(if: Boolean!)
- if Boolean is true, the given item is NOT resolved by the GraphQL Server -
@include(if: Boolean!)
- if Boolean is false, the given item is NOT resolved by the GraphQL Server
@deprecated(reason: String)
IS NOT compatible with Operation directives.
@deprecated
is exclusive to Schema Directives
Examples of Default Operation directives
Custom Operation directives
Custom directives must be defined in the schema to be used within the query and can be used to decorate other parts of the schema.
Locations for Operation directives
Directives can only appear in specific locations inside the query. These
locations must be included in the directive's definition. In Strawberry the
location is defined in the directive function's parameter locations
.
Operation directives possible locations
Operation directives can be applied to many different parts of an operation. Here's the list of all the allowed locations:
-
QUERY
-
MUTATION
-
SUBSCRIPTION
-
FIELD
-
FRAGMENT_DEFINITION
-
FRAGMENT_SPREAD
-
INLINE_FRAGMENT