Refactor code structure for improved readability and maintainability
This commit is contained in:
16
docs/api/console/exception-schema.md
Normal file
16
docs/api/console/exception-schema.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Console Exceptions API Schema (draft placeholder)
|
||||
|
||||
**Status:** TODO · awaiting Policy Guild + Platform Events
|
||||
|
||||
## Scope
|
||||
- `/exceptions` CRUD/workflow (create, propose, approve, revoke, list, history) proxied by Web gateway.
|
||||
- Audit logging, pagination, notification hooks, rate limits, RBAC scopes.
|
||||
|
||||
## Needed from owners
|
||||
- JSON schema for exception entity and workflow transitions; validation rules.
|
||||
- Required scopes/roles; audit fields; pagination/sorting defaults; max durations/guardrails.
|
||||
- Notification hook contract (`exception.*` events) and rate-limit policy.
|
||||
- Sample payloads for each state and error cases.
|
||||
|
||||
## TODO
|
||||
- Replace with ratified schema + samples; log hash/date; link from Web I/II sprint logs.
|
||||
17
docs/api/gateway/export-center.md
Normal file
17
docs/api/gateway/export-center.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Export Center Gateway Contract (draft placeholder)
|
||||
|
||||
**Status:** TODO · awaiting Export Center Guild inputs
|
||||
|
||||
## Scope
|
||||
- Profile, run, download, and distribution routes proxied via Web gateway.
|
||||
- Tenant scoping, RBAC/ABAC, streaming limits, retention/encryption parameters, signed URL policy.
|
||||
|
||||
## Needed from owners
|
||||
- OpenAPI/JSON schema for: profiles, runs, downloads, distributions (OCI/object storage).
|
||||
- Range/streaming limits; retry/backoff guidance; checksum/manifest format.
|
||||
- Required headers (tenant/project, idempotency, auth) and rate limits.
|
||||
- Example payloads/NDJSON streams for happy-path and error cases.
|
||||
|
||||
## TODO
|
||||
- Replace this file with the ratified contract and sample payloads.
|
||||
- Record schema hash and date when published; link from Web II sprint Execution Log.
|
||||
16
docs/api/graph/overlay-schema.md
Normal file
16
docs/api/graph/overlay-schema.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Graph Overlay & Cache Schema (draft placeholder)
|
||||
|
||||
**Status:** TODO · awaiting Graph Platform Guild ratification
|
||||
|
||||
## Scope
|
||||
- Overlay/cache schema for graph tiles used by Web gateway and UI overlays.
|
||||
- Validation rules for bbox/zoom/path; pagination tokens; deterministic ordering.
|
||||
- Error codes and sampling/telemetry fields.
|
||||
|
||||
## Needed from owners
|
||||
- JSON schema (or OpenAPI fragment) for overlay response and cache metadata.
|
||||
- Allowed zoom levels/coordinate system; max nodes/edges per tile; hashing/etag rules.
|
||||
- Sample overlay bundle (happy path + rate-limit + validation error).
|
||||
|
||||
## TODO
|
||||
- Insert ratified schema + samples; note schema hash/date; link from Web II sprint log.
|
||||
15
docs/api/signals/reachability-contract.md
Normal file
15
docs/api/signals/reachability-contract.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Signals Reachability API Contract (draft placeholder)
|
||||
|
||||
**Status:** TODO · awaiting Signals Guild
|
||||
|
||||
## Scope
|
||||
- `/signals/callgraphs`, `/signals/facts`, reachability scoring overlays feeding UI/Web.
|
||||
- Deterministic fixtures for SIG-26 chain (columns/badges, call paths, timelines, overlays, coverage).
|
||||
|
||||
## Needed from owners
|
||||
- OpenAPI/JSON schema for callgraphs and facts (request/response, pagination, ETags).
|
||||
- Reachability score model, states, and filtering parameters.
|
||||
- Fixture bundle (JSON/NDJSON) with checksums and performance budgets (target FPS/node caps).
|
||||
|
||||
## TODO
|
||||
- Replace with ratified contract and fixtures; record schema hash/date; link from Web V and UI III logs.
|
||||
14
docs/api/vex-consensus.md
Normal file
14
docs/api/vex-consensus.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# VEX Consensus Stream Contract (draft placeholder)
|
||||
|
||||
**Status:** TODO · awaiting VEX Lens Guild
|
||||
|
||||
## Scope
|
||||
- `/vex/consensus` streaming APIs via Web gateway with tenant RBAC/ABAC, caching, and telemetry.
|
||||
|
||||
## Needed from owners
|
||||
- SSE/stream envelope (fields, heartbeats, retry/backoff headers), sample NDJSON stream.
|
||||
- RBAC/ABAC requirements and caching rules; idempotency/correlation headers.
|
||||
- Error codes and rate limits.
|
||||
|
||||
## TODO
|
||||
- Insert finalized contract + samples; note schema hash/date; reference in Web V sprint log.
|
||||
Reference in New Issue
Block a user