Documentation Index
Fetch the complete documentation index at: https://docs.skrmir.com/llms.txt
Use this file to discover all available pages before exploring further.
API Reference
Formal OpenAPI is not linked yet, but the following control-plane surfaces are now frozen as the minimum pre-OpenAPI contract.Currently Frozen Minimal Control-Plane Surfaces
| Path | Method | Purpose | Frozen Semantics |
|---|---|---|---|
/api/v1/system/info | GET | platform aggregated status entry | returns a platform summary plus runtime persistence-capability summary and does not replace /healthz or /readyz |
/api/v1/authn/status | GET | AuthN wiring/status visibility | reports authentication-surface status only; no token or session inventory leakage |
/api/v1/authz/status | GET | AuthZ wiring/status visibility | reports authorization-surface status only; no raw policy dump or live per-subject decision output |
/api/v1/approvals | POST | approval-ticket creation entry | returns 201 Created when the repository is configured and the request is valid; returns a structured 503 Service Unavailable when it is not |
/api/v1/compose/import | POST | Compose import preflight/report | currently frozen as matrix evaluation plus reporting, not the full AppSpec/deployment pipeline |
/api/v1/installer/actions | POST | installer execution entrypoint | currently frozen as an installer run intent surface that narrows into step-event writes without taking task/deploy authority |
/api/v1/databases | GET | database visibility | currently frozen as a read-only visibility surface that may return placeholder with an empty list |
/api/v1/storage/objects | GET | object-storage visibility | currently frozen as a read-only visibility surface that may return placeholder with an empty list |
/api/v1/aidb/query | POST | historical AI DB compatibility shell | currently frozen as a legacy-only migration surface and not a place for new long-term capability |
Current Constraints
- The three status surfaces are intended to return
200 OKwith a JSON status object that distinguishesplaceholder / ready / degraded. /api/v1/system/infomay additionally expose aruntimesummary describing the current runtime mode and persistence-capability boundary, but it must not leak DSN values, tokens, or other sensitive configuration.POST /api/v1/approvalsis now a shipped approval-ticket creation API; it returns201 Createdwith the full binding context when the approval repository is configured, and a structured503 Service Unavailablewhen it is not.- approval binding semantics remain frozen around at least
subject_id,env,resource, andaction;command_hashremains the recommended CLI/Agent binding. POST /api/v1/compose/importcurrently takes normalized Composefieldsplus optionalstrict; successful report generation returns200 OKeven whenpassed=false.POST /api/v1/installer/actionscurrently requirestask_id,action,resource, andenv;actionis frozen toinstaller.run.execute.correlation_idmay be supplied explicitly or inherited from the current request context correlation ID./api/v1/databasesand/api/v1/storage/objectsare visibility-only surfaces for now; they do not execute queries, upload/delete objects, or expose provider control./api/v1/aidb/queryshould now return a structured legacy-only / migration-needed response instead of raw501.