Skip to content

Latest commit

 

History

History
28 lines (27 loc) · 3 KB

File metadata and controls

28 lines (27 loc) · 3 KB

Glossary

Term Meaning
C1 The combined contract surface formed by the REST control-plane and the streaming delivery-plane.
REST channel HTTP API used for transactional operations: create session, inspect session, start checkout, receive webhook.
Stream channel Long-lived transport (e.g. WebSocket) that delivers ordered JSON events with analysis output and visibility decisions.
sessionId Server-generated identifier for an analysis session; anchors all subsequent operations in that session.
Session Ephemeral container for analysis input and per-topic results, keyed by sessionId.
topic Client-chosen label identifying a logical analysis under a given session. Multiple topics can coexist per session.
resultKey Opaque backend correlation key used for replay and consistency; not interpreted by clients.
analysisStatus Stream event type that reports lifecycle transitions of an analysis run (e.g. started, completed).
analysisChunk Stream event type that carries incremental content fragments during execution.
paywall Stream event type that stops further visible content until entitlement is granted for (sessionId, topic).
unlock Stream event type emitted after entitlement is granted; may carry full content or an informative hint that follow-up retrieval may be needed.
response Stream event type that returns a complete result in a single message (non-streamed delivery).
error Stream event type indicating terminal failure for a request or execution.
Entitlement Whether a given (sessionId, topic) is allowed full visibility of the result.
Preview Client state where a bounded subset of the result is visible and a paywall invites upgrade.
Full Client state where the full result is visible, typically via a terminal response event.
Streaming (state) Client state where incremental analysisChunk events are being received and rendered.
SessionExpired Client-visible state where a held sessionId is no longer recognized by the backend (TTL elapsed).
Payment provider External billing system responsible for processing payments and sending webhooks (e.g. checkout completion).
Checkout session Payment-provider-side session created via POST /api/checkout that the user completes in the provider’s UI.
Webhook Server-to-server HTTP callback from the payment provider to POST /api/webhook, used to notify payment completion.
Termination (stream) The point after which no further analysisChunk events are valid; defined by a small set of terminal events in the stream protocol (visibility termination; execution may continue).
Visibility What portion of the underlying result the client is allowed to render, as determined by stream events and entitlement.
Execution The backend process that generates analysis results, independent of what is currently visible to the user.