API Reference ExShopifySchema v#2024.4.2

View Source

Modules

Documentation for ExShopifySchema.

This module provides the structure for GraphQL introspection data. The definitions for each version of the Shopify GraphQL API are dynamically defined from JSON files. Each version can be accessed through like this ExShopifySchema.Graphql.Introspection.Definitions.V202501.

This module defines the structure of the GraphQL introspection data.

Fields are conceptually functions which return values, and occasionally accept arguments which alter their behavior. These arguments often map directly to function arguments within a GraphQL service’s implementation.

Directives provide a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

Directives provide a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

Enum types describe the set of possible values.

Enum values represent possible values for enum types.

GraphQL Objects represent a list of named fields, each of which yield a value of a specific type.

Fields may accept arguments to configure their behavior. These inputs are often scalars or enums, but they sometimes need to represent more complex values.

GraphQL interfaces represent a list of named fields and their arguments. GraphQL objects and interfaces can then implement these interfaces which requires that the implementing type will define all fields defined by those interfaces.

A GraphQL list is a special collection type which declares the type of each item in the List (referred to as the item type of the list). List values are serialized as ordered lists, where each item in the list is serialized as per the item type.

The fundamental unit of any GraphQL Schema is the type. There are six kinds of named type definitions in GraphQL, and two wrapping types.

By default, all types in GraphQL are nullable; the null value is a valid response for all of the above types. To declare a type that disallows null, the GraphQL Non-Null type can be used.

GraphQL Objects represent a list of named fields, each of which yield a value of a specific type.

There are three types of operations that GraphQL models

Scalar types represent primitive leaf values in a GraphQL type system.

The schema defines the entry point for operations in a GraphQL

A GraphQL type can be a named type, a list type, or a non-null type. See details in the ExShopifySchema.Graphql.Introspection.Definition.NamedType, ExShopifySchema.Graphql.Introspection.Definition.ListType, and ExShopifySchema.Graphql.Introspection.Definition.NonNullType.

GraphQL Unions represent an object that could be one of a list of GraphQL Object types, but provides for no guaranteed fields between those types.

Utility module for building GraphQL components from introspection JSON data.

Utility functions for working with enum values.

Schemas to cast Shopify resources into structured data.

Fallback in case a field is not loaded.

This module provides utility functions for defining types.

Conveniences for writing ExShopifySchema related Mix tasks.

Mix Tasks

Generates ExShopifySchema GraphQL schemas from introspection data.