Bootstrap reanimator chart viewer
This commit is contained in:
35
bible-local/architecture/api-surface.md
Normal file
35
bible-local/architecture/api-surface.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# API Surface
|
||||
|
||||
## Primary Integration Style
|
||||
|
||||
The package is intended to be embedded by other Go applications.
|
||||
|
||||
Expected package shape:
|
||||
|
||||
- `viewer.RenderHTML(snapshot []byte) ([]byte, error)`
|
||||
- `viewer.NewHandler(...) http.Handler`
|
||||
|
||||
Exact signatures may change during implementation, but the integration model is fixed:
|
||||
|
||||
- embedding app provides the JSON
|
||||
- chart renders HTML
|
||||
|
||||
## Expected Runtime Endpoints
|
||||
|
||||
These endpoints are expected for the standalone binary only:
|
||||
|
||||
- `GET /` - viewer page
|
||||
- `POST /render` - accept one Reanimator JSON payload and return rendered HTML or JSON render result
|
||||
- `GET /healthz` - basic process health
|
||||
|
||||
## UI Route Rules
|
||||
|
||||
- No multi-product navigation
|
||||
- No upload wizard with preview/confirm/execute stages
|
||||
- No collector/API-connect workflow
|
||||
- No background job polling API
|
||||
|
||||
## Response Rules
|
||||
|
||||
- HTML pages are read-only views of one snapshot
|
||||
- API responses must not modify or augment the input payload semantics
|
||||
Reference in New Issue
Block a user