docs: declare institutional architecture boundary
This commit is contained in:
@@ -0,0 +1,16 @@
|
||||
# GovOPlaN REST Connector Codex Guide
|
||||
|
||||
## Scope
|
||||
|
||||
This repository owns governed REST publication, HTTP binding, serialization, connector policy, throttling, and transport diagnostics.
|
||||
|
||||
## Documentation Contract
|
||||
|
||||
- Treat documentation as part of every behavior change. Update this module's manifest-driven `DocumentationTopic` contributions for affected user and administrator behavior.
|
||||
- Keep feature content here; `govoplan-docs` projects it without importing REST internals.
|
||||
- Maintain a static user/admin baseline and run `/mnt/DATA/git/govoplan/tools/checks/check-manifest-shapes.py` after behavior or manifest changes.
|
||||
|
||||
## Boundaries
|
||||
|
||||
- Published modules retain validation, authorization, idempotency, and side-effect ownership.
|
||||
- Never expose an unrestricted proxy to internal APIs.
|
||||
Reference in New Issue
Block a user