Appearance
LuaSample
Type: Object
A Lua sample script with its source
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| apis | [String!]! | Every ctx.* function the sample calls, derived from its source rather than declared | ||
| description | String! | One line saying what the sample demonstrates | ||
| entry | String | The export to call on a DISPATCHING surface — handler for a webhook, a method name for a custom app. Null when the surface evaluates the chunk and uses its return value instead. | ||
| id | String! | Stable identifier, e.g. "graphql-list-customers" | ||
| role | LuaScriptRole! | Which scripting surface the sample is written against | ||
| source | String! | The runnable Lua source, front-matter stripped | ||
| tier | LuaSampleTier! | RECIPE for task-shaped examples, SNIPPET for one function | ||
| title | String! | Short human-readable name, for a menu entry |