Commit be5d6507 authored by Alex Kalderimis's avatar Alex Kalderimis

Document use of BaseResolver#calls_gitaly!

parent dfad880d
...@@ -1137,9 +1137,10 @@ When using resolvers, they can and should serve as the SSoT for field metadata. ...@@ -1137,9 +1137,10 @@ When using resolvers, they can and should serve as the SSoT for field metadata.
All field options (apart from the field name) can be declared on the resolver. All field options (apart from the field name) can be declared on the resolver.
These include: These include:
- `type` (this is particularly important, and is planned to be mandatory) - `type` (this is required - all resolvers must include a type annotation)
- `extras` - `extras`
- `description` - `description`
- Gitaly annotations (with `calls_gitaly!`)
Example: Example:
...@@ -1149,6 +1150,7 @@ module Resolvers ...@@ -1149,6 +1150,7 @@ module Resolvers
type Types::MyType, null: true type Types::MyType, null: true
extras [:lookahead] extras [:lookahead]
description 'Retrieve a single MyType' description 'Retrieve a single MyType'
calls_gitaly!
end end
end end
``` ```
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment