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.
|
||||
@@ -1,7 +1,8 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER
|
||||
from govoplan_core.core.modules import ModuleContext, ModuleInterfaceProvider, ModuleManifest, PermissionDefinition, RoleTemplate
|
||||
from govoplan_core.core.modules import DocumentationTopic, ModuleContext, ModuleInterfaceProvider, ModuleManifest, PermissionDefinition, RoleTemplate
|
||||
from govoplan_core.core.provider_governance import declared_module_architecture
|
||||
|
||||
REST_READ_SCOPE = "rest:endpoint:read"
|
||||
REST_READ_SCOPES = (REST_READ_SCOPE, "system:settings:read", "admin:settings:read")
|
||||
@@ -49,7 +50,31 @@ manifest = ModuleManifest(
|
||||
level="system",
|
||||
),
|
||||
),
|
||||
documentation=(
|
||||
DocumentationTopic(
|
||||
id="rest.published-function-boundary",
|
||||
title="Use governed REST publications",
|
||||
summary="REST exposes explicitly published module functions through a transport adapter without taking ownership of their business behavior.",
|
||||
body="Only functions registered through the publication contract are discoverable. The source module still owns validation, authorization facts, idempotency, and side effects; REST owns HTTP binding, serialization, transport policy, throttling, and diagnostics. The current surface is a provider contract and discovery API, not an unrestricted proxy to internal endpoints.",
|
||||
documentation_types=("admin", "user"),
|
||||
audience=("integration_user", "operator", "module_admin"),
|
||||
related_modules=("policy", "audit", "docs"),
|
||||
metadata={"kind": "reference"},
|
||||
),
|
||||
),
|
||||
route_factory=_route_factory,
|
||||
architecture=declared_module_architecture(
|
||||
layer="data_reporting_integration",
|
||||
kind="integration",
|
||||
maturity="vertical_slice",
|
||||
documentation_ref="README.md",
|
||||
test_ref="tests/test_rest_module_contract.py",
|
||||
known_limits=("Only governed function discovery/publication contracts are implemented; arbitrary endpoint proxying is excluded.",),
|
||||
supported_authority_modes=("governance_overlay", "linked_reference"),
|
||||
owned_concepts=("REST transport binding", "HTTP serialization", "transport diagnostics"),
|
||||
non_owned_concepts=("published business function", "domain authorization", "domain effect"),
|
||||
security_docs=("README.md",),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user