README
Documentation
¶
Overview ¶
Package tsvsheetapi is the module root for tsvsheet-api — the sheet API server that carries the tsvsheet edit language over HTTP: a document plane (versioned .tsvt storage edited by op batches), a change feed (Server-Sent Events replaying the same batches), and a compute plane serving computed values in the SPECIFICATION §9 vendor media types, so any served sheet is IMPORT*-able by any other sheet. The runnable entry point is cmd/tsvsheet-api; the HTTP surface lives under internal/api, the confined document store under internal/store, and the engine itself is github.com/tsvsheet/go-tsvsheet.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api is the sheet API's HTTP surface: one URL per document, the action selected by method × media type.
|
Package api is the sheet API's HTTP surface: one URL per document, the action selected by method × media type. |
|
Package client is the document plane's remote adapter: a document.Port implemented over the sheet API, so a frontend that can edit a local file can edit a document on a server without knowing the difference.
|
Package client is the document plane's remote adapter: a document.Port implemented over the sheet API, so a frontend that can edit a local file can edit a document on a server without knowing the difference. |
|
cmd
|
|
|
tsvsheet-api
command
Command tsvsheet-api is the sheet API server: the tsvsheet edit language over HTTP.
|
Command tsvsheet-api is the sheet API server: the tsvsheet edit language over HTTP. |
|
Package conformance is the document plane's shared behaviour suite: one table of assertions every document.Port implementation must satisfy, runnable against any of them.
|
Package conformance is the document plane's shared behaviour suite: one table of assertions every document.Port implementation must satisfy, runnable against any of them. |
|
Package document states the sheet API's document plane as an interface, so a frontend edits a .tsvt the same way whether the document sits on the local filesystem or behind an HTTP server it addresses.
|
Package document states the sheet API's document plane as an interface, so a frontend edits a .tsvt the same way whether the document sits on the local filesystem or behind an HTTP server it addresses. |
|
internal
|
|
|
constants
Package constants declares tsvsheet.api's sentinel error values.
|
Package constants declares tsvsheet.api's sentinel error values. |
|
Package observe is the ecosystem's request observability: one structured record and one metric observation per served request, applied as a decorator so every serving surface gets the same fields, the same level grading and the same counters rather than each one inventing its own (R17, R18).
|
Package observe is the ecosystem's request observability: one structured record and one metric observation per served request, applied as a decorator so every serving surface gets the same fields, the same level grading and the same counters rather than each one inventing its own (R17, R18). |
|
The store's own failures — the mechanical ones a filesystem can produce.
|
The store's own failures — the mechanical ones a filesystem can produce. |
Click to show internal directories.
Click to hide internal directories.