Skip to main content

Glossary

TermMeaning
SuiteThe commercial studio beside Apiome: the Designer canvas and workspace, Authoring, Scribe, Slate and the hosted-plan surfaces. Served by the apiome-suite image at suite.apiome.dev
StudioThe designer application that serves every Suite surface. "Standalone" when it serves unprefixed routes; "suite-embedded" when the main app links to it under /ade/studio/*
Main appThe open-source Apiome application (apiome-ui) at main.apiome.dev: Control Panel, catalog, versions, governance and sign-in
WorkspaceThe unified Design surface at /workspace: schemas and paths in one domain-scoped view with three lenses
LensA view of the workspace: Schemas, Paths or Combined
DomainA folder that scopes the workspace to one part of a version's catalog; carried in the URL as domain
Classic canvasThe Data Designer (/editor) and Paths editor (/paths) the workspace unifies; retired at the only rollout stage
Draft lockThe lock a user holds on a version while editing it; a source apply that collides with another editor's lock is refused
Version branch, version tagA branch of a project's version history, and a named point on it. Part of the git-like layer, which is off in shipped builds (FEATURE_GITLIKE)
AuthoringThe documentation half of the Suite: Overview, Scribe, Slate, Guides, Changelog and the hosted-plan pages
ScribeAI-assisted writing of cited reference content and guides, grounded in the version's source
SlateThe visual portal builder: theme, navigation, content blocks, preview, build, export and publish
SpireThe FastAPI service behind Scribe and Slate
Canonical targetSpire's identity for a documentable node — (artifact_version_id, canonical_kind, stable_key, source_pointer) folded with the tenant into a target_id — so every format (OpenAPI, AsyncAPI, GraphQL, gRPC, JSON Schema, Arazzo) documents the same way
Canonical kindOne of artifact, service, operation, message, channel, type, field, parameter, response, workflow_step
ProvenanceThe envelope Spire keeps per target: native source pointer, content digest, format adapter identity and dependency edges — what citations and stale detection get back to the source with
Stale alertA notice that a target's source changed after its documentation was written
CoverageThe share of a version's targets that have documentation, by kind
Style guideA project's tone preset, terminology and custom guidance, injected into every generation prompt
ProposalA grounded AI suggestion with citations, validated and redacted before it reaches the editor
Release CenterThe hosted-plan page where portal builds are promoted to preview or production and rolled back
EntitlementA license feature flag — designer, paths, authoring, scribe, slate, hosted — that unlocks a surface
PreviewThe chip the product shows beside Scribe, Slate, Releases and Insights while they are in preview
Suite hostThe @suite/host package that registers the Suite's destinations, home cards and entitlement flags into the main app's suite dropdown
BFFBackend-for-frontend: the studio's /api/* routes that forward to apiome-rest, Spire and Ollama with a service bearer
Service bearerThe one-hour JWT the studio signs with the shared sign-in secret for every call to apiome-rest and Spire