# reserved-names

Source: https://apigenie.pl/docs/linter/graphql/rules/reserved-names

This rule checks that the names of types, fields, arguments, enum values and directives don't start with "__", as the GraphQL specification requires.

## Rule Details

The rule reports the issues of the validation rule of the same name, with the messages of graphql-js. A document that breaks it is rejected by GraphQL servers and tools, so the rule should stay enabled with the `error` severity.

## Configuration

This rule has no options.

```yaml
version: "1.0"
commands:
  lint:
    graphql:
      rules:
        reserved-names: warning
```

The rule can be disabled for a node and everything nested in it with an `# apigenie-lint-disable reserved-names` comment on the node, or for a whole file with the comment at the top of the file, separated from the first definition by a blank line. It applies to definitions.

## Examples

**Good**.

```graphql
type User { id: ID! }
```

**Bad**. The linter reports `Name "__id" must not begin with "__", which is reserved by GraphQL introspection.`.

```graphql
type User { __id: ID! }
```