Skip to content
Products
/
Mirakl Platform
/
GraphQL Reference
/
Directives

GraphQL Overview

Download GraphQL schema
schema.docs.graphql

Queries

Overview

Mutations

Overview

Directives

Overview

paginationLimit

Arguments

default
Int
max
Int!,non-nullrequired
Locations
ARGUMENT_DEFINITION

cost

Arguments

weight
Int!,non-nullrequired
slicingArguments
[String!],non-null
Locations
FIELD_DEFINITION

include

Directs the executor to include this field or fragment only when the if argument is true.

Arguments

if
Boolean!,non-nullrequired

Included when true.

Locations
FIELD
FRAGMENT_SPREAD
INLINE_FRAGMENT

skip

Directs the executor to skip this field or fragment when the if argument is true.

Arguments

if
Boolean!,non-nullrequired

Skipped when true.

Locations
FIELD
FRAGMENT_SPREAD
INLINE_FRAGMENT

deprecated

Marks an element of a GraphQL schema as no longer supported.

Arguments

reason
String
Default:"No longer supported"

Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by CommonMark.

Locations
FIELD_DEFINITION
ARGUMENT_DEFINITION
INPUT_FIELD_DEFINITION
ENUM_VALUE

specifiedBy

Exposes a URL that specifies the behavior of this scalar.

Arguments

url
String!,non-nullrequired

The URL that specifies the behavior of this scalar.

Locations
SCALAR

oneOf

Indicates exactly one field must be supplied and this field must not be null.

Locations
INPUT_OBJECT

Objects

Overview

Interfaces

Overview

Unions

Overview

Inputs

Overview

Scalars

Overview