42 lines
1.8 KiB
Markdown
42 lines
1.8 KiB
Markdown
# Platform Service (StellaOps.Platform)
|
|
|
|
## Mission
|
|
Define and deliver the Platform Service that aggregates cross-service views for the Console UI and CLI (health, quotas, onboarding, preferences, global search).
|
|
|
|
## Roles
|
|
- Backend engineer: service APIs, aggregation, caching, and contracts.
|
|
- QA automation engineer: deterministic tests, offline cache coverage, integration harness.
|
|
- Docs maintainer: platform service architecture, API contracts, and runbooks.
|
|
|
|
## Operating principles
|
|
- Aggregation-only: never mutate raw evidence or policy results.
|
|
- Deterministic outputs: stable ordering, UTC timestamps, content-addressed cache keys.
|
|
- Offline-first: cache last-known snapshots and surface "data as of" metadata.
|
|
- Tenancy-aware: enforce Authority claims and scope filters on every request.
|
|
|
|
## Required reading
|
|
- `docs/modules/platform/architecture-overview.md`
|
|
- `docs/modules/platform/architecture.md`
|
|
- `docs/modules/platform/platform-service.md`
|
|
- `docs/07_HIGH_LEVEL_ARCHITECTURE.md`
|
|
- `docs/modules/gateway/architecture.md`
|
|
- `docs/modules/authority/architecture.md`
|
|
|
|
## Working directory
|
|
- `src/Platform/StellaOps.Platform.WebService` (to be created)
|
|
|
|
## Testing expectations
|
|
- Unit tests for aggregation ordering and error handling.
|
|
- Integration tests for fan-out to downstream services with deterministic fixtures.
|
|
- Offline cache tests that validate "data as of" metadata and read-only behavior.
|
|
|
|
## Working agreement
|
|
- Update sprint status in `docs/implplan/SPRINT_*.md` when starting/stopping work.
|
|
- Document cross-module contract changes in sprint Decisions & Risks.
|
|
- Avoid non-deterministic data ordering or timestamps in responses.
|
|
|
|
## Service Endpoints
|
|
- Development: https://localhost:10010, http://localhost:10011
|
|
- Local alias: https://platform.stella-ops.local, http://platform.stella-ops.local
|
|
- Env var: STELLAOPS_PLATFORM_URL
|