← All types
Ob Object

LuaSampleSummary

A Lua sample script without its source

Fields

id

String!Non-null

Stable identifier, e.g. "graphql-list-customers"

title

String!Non-null

Short human-readable name, for a menu entry

One line saying what the sample demonstrates

Which scripting surface the sample is written against

Possible values (4)
NORMAL

Every platform capability. Runs playground and stored scripts, workflow script nodes, custom workflow actions, incoming webhooks, custom app server functions, workspace handlers, portal handlers, MCP tools, archive jobs, quote price tuning, plugin seeds and integration extensions.

INTEGRATION

The Normal functions except ctx.twin., with devices, templates and scripts reached only through the instance's bindings, cache, config, protobuf and store belonging to the instance, plus ctx.integration. metadata. Runs integration lifecycle hooks, integration handler scripts, integration server functions, integration workflow actions, integration API client setup and integration upgrade scripts.

PURE

The language only, with no ctx and no modules. Runs data pipeline stages, report preparation scripts, portal component exports, plugin middleware hooks, plugin event handlers, scheduler penalty functions, product template resolvers and JDF and JMF templates.

EDGE_APP

Edge app bundle handlers on the bridge: the bridge.* global, SwiftLua-in-Go runtime, no ctx.

RECIPE for task-shaped examples, SNIPPET for one function

Possible values (2)
RECIPE

Task-shaped and multi-API — start here

SNIPPET

One host function, in isolation

apis

[String!]!Non-null

Every ctx.* function the sample calls, derived from its source rather than declared

Referenced by (1)
Exact type SDL
"""A Lua sample script without its source"""
type LuaSampleSummary {
  """
  Stable identifier, e.g. "graphql-list-customers"
  """
  id: String!
  """Short human-readable name, for a menu entry"""
  title: String!
  """One line saying what the sample demonstrates"""
  description: String!
  """Which scripting surface the sample is written against"""
  role: LuaScriptRole!
  """RECIPE for task-shaped examples, SNIPPET for one function"""
  tier: LuaSampleTier!
  """
  Every ctx.* function the sample calls, derived from its source rather than declared
  """
  apis: [String!]!
}