executing-graphql-documents.md

Executing GraphQL Documents

LinearSDK publishes the full Linear graph as schema reference docs and keeps document execution simple.

Use LinearSDK.execute_document/4 for ad hoc queries, mutations, or subscriptions:

client =
  LinearSDK.Client.new!(
    api_key: System.fetch_env!("LINEAR_API_KEY")
  )

{:ok, response} =
  LinearSDK.execute_document(
    client,
    """
    query Viewer {
      viewer {
        id
        name
        email
      }
    }
    """
  )

The response is returned as LinearSDK.Response.

When the GraphQL response contains errors, the failure is normalized into LinearSDK.Error.

For documents that declare multiple operations, select the one you want explicitly:

document = """
query Viewer {
  viewer {
    id
  }
}

mutation IssueArchive($id: String!) {
  issueArchive(id: $id) {
    success
  }
}
"""

{:ok, response} =
  LinearSDK.execute_document(
    client,
    document,
    %{},
    operation_name: "Viewer"
  )

Use the generated API reference modules in HexDocs to discover:

• available root fields
• argument names and types
• object and input shapes
• enums, interfaces, unions, and scalars