<!--- Hugo front matter used to generate the website version of this page:
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# GraphQL

## GraphQL Attributes

This document defines attributes for GraphQL.

| Attribute                | Type   | Description                               | Examples                                          | Stability                                                        |
| ------------------------ | ------ | ----------------------------------------- | ------------------------------------------------- | ---------------------------------------------------------------- |
| `graphql.document`       | string | The GraphQL document being executed. [1]  | `query findBookById { bookById(id: ?) { name } }` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `graphql.operation.name` | string | The name of the operation being executed. | `findBookById`                                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `graphql.operation.type` | string | The type of the operation being executed. | `query`; `mutation`; `subscription`               | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** The value may be sanitized to exclude sensitive information.

`graphql.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

| Value          | Description          | Stability                                                        |
| -------------- | -------------------- | ---------------------------------------------------------------- |
| `mutation`     | GraphQL mutation     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `query`        | GraphQL query        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `subscription` | GraphQL subscription | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
