
<h1 class="has-pills">
  __Directive
  <span data-algolia-exclude><span class="pill pill--object pill--normal-case pill--large"><code>OBJECT</code></span></span>
</h1>

A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.  In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.



| `args` `[__InputValue!]` Arguments `includeDeprecated` `Boolean` Default value: `false` |
| --- |

</details></div></td></tr><tr><td><h3 class="is-small has-pills"><code>description</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>isRepeatable</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>locations</code><a href="/docs/apis/graphql/schemas/enum/__directivelocation" class="pill pill--enum pill--normal-case pill--medium" title="Go to ENUM __DirectiveLocation"><code>[__DirectiveLocation!]</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>name</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>onField</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean!</code></a><span class="pill pill--deprecated"><code>deprecated</code></span></h3><p><em>Deprecated: Use `locations`.</em></p></td></tr><tr><td><h3 class="is-small has-pills"><code>onFragment</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean!</code></a><span class="pill pill--deprecated"><code>deprecated</code></span></h3><p><em>Deprecated: Use `locations`.</em></p></td></tr><tr><td><h3 class="is-small has-pills"><code>onOperation</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean!</code></a><span class="pill pill--deprecated"><code>deprecated</code></span></h3><p><em>Deprecated: Use `locations`.</em></p></td></tr>
  </tbody>
</table>
