Skip to content
Tablewalk

App: api

The App-shaped HTTP API an App can opt into. Every key here is stable (status). All parts.

api

Section titled “api”
Key Type Status What it does
api apiRead Stable Exposure metadata; it opens no routes by itself. Commands must be targeted and are served only beside their –commands registry. Runtime checks logical catalog, roles, the command registry and authority lock.

api.commands

Section titled “api.commands”
Key Type Status What it does
api.commands array Stable Used in examples/apps/lintel/app.ts.

api.commands[]

Section titled “api.commands[]”
Key Type Status What it does
api.commands[].command string Stable A command, by its name in the App’s commands module (defineCommands). The server fills in its input, target and version from the registration; tablewalk-commands.d.ts types the names. Used in examples/apps/lintel/app.ts.
api.commands[].description string Stable Used in examples/apps/lintel/app.ts.
api.commands[].label string Stable

api.description

Section titled “api.description”
Key Type Status What it does
api.description string Stable Used in examples/apps/lintel/app.ts.

api.events

Section titled “api.events”
Key Type Status What it does
api.events array Stable Command events the event feed serves, each its own token operation (event:<name>). Used in examples/apps/lintel/commands/ledger.ts.

api.network

Section titled “api.network”
Key Type Status What it does
api.network boolean Stable Let the API and its MCP endpoint answer beyond loopback when the server listens there (–host, –allowed-host, –trust-proxy). Absent, they answer loopback only and a wider listener refuses to start. Recorded in authority.lock.

api.publicSpec

Section titled “api.publicSpec”
Key Type Status What it does
api.publicSpec boolean Stable Serve the OpenAPI document at …/$openapi without a token: every operation the API declares, without its roles or standing queries. Absent or false, the document is a token’s own, narrowed to what it may do.

api.resources

Section titled “api.resources”
Key Type Status What it does
api.resources object Stable Used in examples/apps/tick/app.ts.
api.resources.*.create Stable One of true. Used in examples/apps/lintel/app.ts.
api.resources.*.delete Stable One of true. Used in examples/apps/tick/app.ts.
api.resources.*.description string Stable Used in examples/apps/lintel/app.ts.
api.resources.*.fields array Stable Used in examples/apps/tick/app.ts.
api.resources.*.filters array Stable Used in examples/apps/lintel/views.ts.
api.resources.*.sorts array Stable
api.resources.*.update Stable One of true.

api.roles

Section titled “api.roles”
Key Type Status What it does
api.roles array Stable

api.version

Section titled “api.version”
Key Type Status What it does
api.version integer Stable

api.views

Section titled “api.views”
Key Type Status What it does
api.views array Stable Used in examples/apps/tick/app.ts.

api.views[]

Section titled “api.views[]”
Key Type Status What it does
api.views[].description string Stable Used in examples/apps/lintel/app.ts.
api.views[].label string Stable
api.views[].view string Stable Used in examples/apps/lintel/app.ts.