docs consolidation

This commit is contained in:
master
2026-01-07 10:23:21 +02:00
parent 4789027317
commit 044cf0923c
515 changed files with 5460 additions and 5292 deletions

View File

@@ -24,7 +24,7 @@ Orchestrator events share a deterministic JSON envelope:
| `attributes` | `object` | Flat string map for frequently queried metadata (e.g., policy revision). |
| `payload` | `object` | Event-specific body (see §2). |
Canonical schemas live under `docs/events/scanner.event.*@1.json`. Samples that round-trip through `NotifyCanonicalJsonSerializer` are stored in `docs/events/samples/`.
Canonical schemas live under `docs/modules/signals/events/scanner.event.*@1.json`. Samples that round-trip through `NotifyCanonicalJsonSerializer` are stored in `docs/modules/signals/events/samples/`.
## 2. Event kinds and payloads
@@ -53,8 +53,8 @@ Emitted once a signed report is persisted and attested. Payload highlights:
- `dsse` — embedded DSSE envelope (payload, type, signature list).
- `report` — canonical report document; identical to the DSSE payload.
Schema: `docs/events/scanner.event.report.ready@1.json`
Sample: `docs/events/samples/scanner.event.report.ready@1.sample.json`
Schema: `docs/modules/signals/events/scanner.event.report.ready@1.json`
Sample: `docs/modules/signals/events/samples/scanner.event.report.ready@1.sample.json`
### 2.2 `scanner.event.scan.completed`
@@ -67,8 +67,8 @@ Emitted after scan execution finishes (success or policy failure). Payload highl
- `findings` — array of surfaced findings with `id`, `severity`, optional `cve`, `purl`, and `reachability`.
- `links`, `dsse`, `report` — same structure as §2.1 (allows Notifier to reuse signatures).
Schema: `docs/events/scanner.event.scan.completed@1.json`
Sample: `docs/events/samples/scanner.event.scan.completed@1.sample.json`
Schema: `docs/modules/signals/events/scanner.event.scan.completed@1.json`
Sample: `docs/modules/signals/events/samples/scanner.event.scan.completed@1.sample.json`
### 2.3 Relationship to legacy events