← All types
AutomationOb Object

MagicQuerySchema

Input (JSON Schema) and output (introspection) contract for a Magic Query noun.

Fields

noun

String!Non-null

The noun this describes, e.g. 'jobs'.

SINGLE or COLLECTION.

Possible values (2)
SINGLE

Fetches a single node; requires an identifier (noun#<id>).

COLLECTION

Fetches a filterable, paginated collection.

The GraphQL type name the query returns, e.g. 'JobState'.

JSON Schema for the accepted options (limit/after/filters, or id).

GraphQL introspection for the return type.

Referenced by (1)
Exact type SDL
"""
Input (JSON Schema) and output (introspection) contract for a Magic Query noun.
"""
type MagicQuerySchema {
  """The noun this describes, e.g. 'jobs'."""
  noun: String!
  """SINGLE or COLLECTION."""
  kind: MagicQueryKind!
  """The GraphQL type name the query returns, e.g. 'JobState'."""
  returnType: String!
  """JSON Schema for the accepted options (limit/after/filters, or id)."""
  inputSchema: JSON!
  """GraphQL introspection for the return type."""
  outputSchema: IntrospectionResultJSON!
}