Skip to content

Commit af152e2

Browse files
committed
Document specifiedBy directive handling
1 parent 9d3462a commit af152e2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

doc/directives.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Directives in GraphQL are extensible annotations which alter the runtime
44
evaluation of a query or which add information to the `schema` definition.
5-
They always begin with an `@`. There are three built-in directives which this
5+
They always begin with an `@`. There are four built-in directives which this
66
library automatically handles:
77

88
1. `@include(if: Boolean!)`: Only resolve this field and include it in the
@@ -11,9 +11,11 @@ results if the `if` argument evaluates to `true`.
1111
results if the `if` argument evaluates to `false`.
1212
3. `@deprecated(reason: String)`: Mark the field or enum value as deprecated
1313
through introspection with the specified `reason` string.
14+
4. `@specifiedBy(url: String!)`: Mark the custom scalar type through
15+
introspection as specified by a human readable page at the specified URL.
1416

1517
The `schema` can also define custom `directives` which are valid on different
1618
elements of the `query`. The library does not handle them automatically, but it
17-
will pass them to the `getField` implementations through the
19+
will pass them to the `getField` implementations through the optional
1820
`graphql::service::FieldParams` struct (see [fieldparams.md](fieldparams.md)
1921
for more information).

0 commit comments

Comments
 (0)