Lookup pages with source-backed item details.

Stornamics reference pages use one schema for API routes, CLI commands, configuration keys, SDK entry points, errors, limits, examples, maturity, and evidence, so readers can scan current behavior without mixing it with future or verification-required surfaces.

Schema Snapshot

Required item fields: 12
Surface families: 6
First E05 pages: 8

Reference Contract

API Routes

DOCS-028

HTTP, S3-compatible, OTLP, gRPC, diagnostic, and admin routes.

Required coverage

Method, route path, version, and auth expectations.
Request body, query params, headers, response shape, and status codes.
Errors, unsupported behavior, examples, maturity, and item-level evidence.

CLI Commands

DOCS-028

Product binaries, developer utilities, diagnostics, and data tools.

Required coverage

Command, subcommand, flags, arguments, and working-directory assumptions.
Required local state, permissions, expected output, and stderr behavior.
Copy/paste examples, maturity, limits, and source or test evidence.

Configuration Keys

DOCS-028

Environment variables, config file keys, ports, bind addresses, and deployment values.

Required coverage

Key name, scope, accepted values, defaults, and restart requirements.
Auth or secret handling, validation errors, and unsafe values.
Examples, maturity, deployment boundaries, and evidence.

SDK Entry Points

DOCS-028

Public client methods, structs, packages, options, and application examples.

Required coverage

Package path, symbol, method, input model, and response model.
Auth context, retry or error behavior, and version assumptions.
Examples, maturity, limits, and source or generated-reference evidence.

Errors

DOCS-028

Structured errors, unsupported-surface responses, validation failures, and retry guidance.

Required coverage

Identifier, applies-to surface, trigger condition, and recovery guidance.
Request or response impact, status code, stderr message, and compatibility links.
Examples when safe, maturity, limits, and review evidence.

Limits

DOCS-028

Quotas, runtime boundaries, unsupported behavior, local-only constraints, and preview gaps.

Required coverage

Limit key, product scope, affected routes or commands, and maturity.
Request, response, auth, scale, storage, or runtime impact.
Examples when safe, workaround guidance, and source-backed evidence.

Item Field Model

Required fields for every reference item
Field	Purpose	Reader Value
ID	Stable identifier for links, evidence, and review comments.	Gives each item a durable anchor.
Type	API, CLI, configuration, SDK, error, or limit.	Sets the reader's lookup mode.
Name	Human-readable route, command, key, symbol, error, or limit name.	Provides the scannable label.
Method	HTTP verb, protocol action, command verb, or `n/a`.	Shows how the item is invoked.
Path	Route, flag, key, symbol, error code, or limit key.	Gives a stable lookup handle.
Auth	Token, permission, trusted header, local-only context, or `n/a`.	Prevents hidden access assumptions.
Request	Body, params, flags, arguments, config value, or SDK input.	Defines what the reader supplies.
Response	Status, body, output, side effect, or persisted state.	Defines what the reader can expect back.
Errors	Statuses, validation failures, stderr, or unsupported behavior.	Shows failure modes and recovery paths.
Examples	Copy/paste request, command, config, SDK snippet, or safety rationale.	Makes the reference concrete without unsafe credentials.
Maturity	Live, Controlled Beta, Alpha, Preview Contract, Future, or Verification Required.	Keeps shipped behavior separate from planned behavior.
Evidence	Source, test, fixture, generated reference, release note, or signoff.	Shows why the item can be trusted.

Planned Product References

Available: DOCS-029
ObjectDB S3 and HTTP reference
Health, platform capabilities, endpoint routes, S3 Core route shape, limits, errors, and local adapter constraints.
ObjectDB
Available: DOCS-030
ObjectDB configuration reference
Bind address, data directory, S3 base domains, fixed request limits, and platform capability requirements.
ObjectDB
Available: DOCS-031
Message Broker HTTP reference
Streams, records, cursors, queues, replication, audit, metrics, storage admin, auth, examples, and controlled-beta limits.
Message Broker
Available: DOCS-032
Message Broker CLI and SDK reference
Lifecycle flags, diagnostics, data CLI, remote CLI, and Rust SDK publish and replay entry points.
Message Broker
Available: DOCS-033
LogDB OTLP and query reference
OTLP HTTP/protobuf, optional gRPC, JSON compatibility, custom endpoints, `/v1/query`, headers, limits, errors, and examples.
LogDB
Available: DOCS-034
LogDB configuration and BYOC reference
Runtime env vars, S3 query-read settings, WAL modes, gRPC bind, AWS BYOC Terraform values, Helm values, and handoff preflight boundaries.
LogDB
Available: DOCS-035
Concordia runtime reference
Product binaries, Cache and Gateway routes, Storage flags, active compatibility service, and protocol registry boundaries.
Concordia
Available: DOCS-036
Shared error and limits catalog
Common HTTP errors, unsupported behavior, limits, retry guidance, and product-specific reference links.
Cross-product

Review Model

Standard

Reference standards define supported surfaces, required item fields, evidence rules, and review routing.

Template

Reference templates keep API, CLI, configuration, SDK, error, and limit pages consistent.

Validation

npm run validate:reference-schema verifies that the template and shared schema preserve the DOCS-028 field contract.

Evidence

Product references should link item-level evidence through each product evidence index before publication.