stella-ops.org/git.stella-ops.org
1
0
Fork 0
Code Issues Pull Requests Actions 16 Releases Wiki Activity
Files
b83aa1aa0b040cb378c02c24a4082c1aa34a68ac
git.stella-ops.org/docs/modules/policy/prep/2025-11-20-snapshot-api-prep.md
master d519782a8f
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
Details
prep docs and service updates
2025-11-21 06:56:36 +00:00

1.2 KiB
Raw Blame History

Snapshot API Prep — PREP-POLICY-ENGINE-35-201-SNAPSHOT-API-WAITS-

Status: Draft (2025-11-20) Owners: Policy Guild Scope: Describe the snapshot API contract that follows ledger export (34-101).

Dependencies

  • Ledger export schema (34-101).
  • Snapshot stream parameters (retention, pagination) from Policy data store.

Draft API surface

  • GET /policy/snapshots?tenant_id=&after_cursor=&limit= → returns {items:[{snapshot_id, generated_at, ledger_export_id, overlay_hash, status_counts}], next_cursor}.
  • GET /policy/snapshots/{snapshot_id} → returns snapshot detail with materialized results (same ordering as ledger export).
  • Determinism: snapshot_id = hash of ledger_export_id + overlay_hash; ordering by generated_at then snapshot_id.

Acceptance

  • Draft schema at docs/modules/policy/schemas/policy-snapshot@draft.json and sample at docs/modules/policy/samples/policy-snapshot@draft.json.
  • Cursor format defined (opaque base64 of (generated_at, snapshot_id) suggested).

Handoff

This document is the prep artefact for PREP-POLICY-ENGINE-35-201-SNAPSHOT-API-WAITS-. Update with cursor and retention details once ledger export shape is frozen.