← All types
Sales & CRMOb Object

TopicExample

A validated example. JSON strings contain illustrative inputs and responses, never live customer data.

Fields

name

String!Non-null

Stable catalogue name, such as commerce.create-order.

title

String!Non-null

Short human-readable title.

Name of the operation in document.

GraphQL document, validated against the schema it ships with.

Illustrative variables for document, as a JSON object string.

Illustrative response as a JSON string; null when the example shows no response.

Referenced by (1)
Exact type SDL
"""
A validated example. JSON strings contain illustrative inputs and responses, never live customer data.
"""
type TopicExample {
  """Stable catalogue name, such as `commerce.create-order`."""
  name: String!
  """Short human-readable title."""
  title: String!
  """Name of the operation in `document`."""
  operationName: String!
  """GraphQL document, validated against the schema it ships with."""
  document: String!
  """Illustrative variables for `document`, as a JSON object string."""
  variablesJSON: String!
  """
  Illustrative response as a JSON string; null when the example shows no response.
  """
  illustrativeResponseJSON: String
}