← All types
AutomationOb Object

MagicQueryInfo

A discoverable Magic Query noun and its accepted options.

Fields

noun

String!Non-null

The noun to use in a Magic Query string, e.g. 'jobs' in 'jobs?limit=10'.

SINGLE (needs an identifier, noun#<id>) or COLLECTION (filterable and paginated).

Possible values (2)
SINGLE

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

COLLECTION

Fetches a filterable, paginated collection.

The GraphQL type name this noun's query returns, e.g. 'JobState'.

Short, LLM-friendly description of what this noun returns.

parameters

[String!]!Non-null

Accepted option names for this noun.

Referenced by (1)
Exact type SDL
"""A discoverable Magic Query noun and its accepted options."""
type MagicQueryInfo {
  """
  The noun to use in a Magic Query string, e.g. 'jobs' in 'jobs?limit=10'.
  """
  noun: String!
  """
  SINGLE (needs an identifier, `noun#<id>`) or COLLECTION (filterable and paginated).
  """
  kind: MagicQueryKind!
  """The GraphQL type name this noun's query returns, e.g. 'JobState'."""
  returnType: String!
  """Short, LLM-friendly description of what this noun returns."""
  description: String!
  """Accepted option names for this noun."""
  parameters: [String!]!
}