Skip to content

Commit 4bab9b6

Browse files
committed
docs(readme): refresh JSON schema version + add v0.3.0 keys table
JSON schema example showed 0.2.0; bump to 0.3.0 to match the published package. Replace the single "New keys in v0.2.0" table with a versioned "Keys by version" table spanning 0.1.2 → 0.3.0 so readers see the full shape of what each release added, including the v0.3 bidirectional nest-parser disclosure and the global-guard limitation entry.
1 parent 2bbeb8f commit 4bab9b6

1 file changed

Lines changed: 17 additions & 10 deletions

File tree

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ Each run writes:
399399

400400
```json
401401
{
402-
"version": "0.2.0",
402+
"version": "0.3.0",
403403
"rubricVersion": "v1",
404404
"riskVersion": "v1",
405405
"timestamp": "ISO 8601",
@@ -470,15 +470,22 @@ Each run writes:
470470
}
471471
```
472472

473-
### New keys in v0.2.0
474-
475-
| Key | Why |
476-
|------------------------------|----------------------------------------------------------------------------------------------|
477-
| `refDiff{}` | PR-aware diff vs a git ref. Surfaces added/removed endpoints + posture/risk regressions. |
478-
| `endpoints[].risk` / `riskReason` | Per-endpoint HIGH/MED/LOW tier. Triage aid. Frozen v1 ladder; `severityOverrides` config to pin. |
479-
| `summary.risk{}` | HIGH/MED/LOW counts. New score-hero sub-line and KPI tiles surface these. |
480-
| `riskTier{}` + `riskVersion` | Rubric version of the risk ladder that produced the tiers. |
481-
| `filter` | The filter expression in effect (view-only — `summary` always reflects the full scan). |
473+
### Keys by version
474+
475+
| Added in | Key | Why |
476+
|---|---|---|
477+
| 0.1.2 | `gate.reasons[]` | Enum-locked list of gates that fired. CI grep target. |
478+
| 0.1.2 | `endpoints[].matchedAuthMarker` | First declared identifier that triggered a GUARDED classification. |
479+
| 0.1.2 | `summary.unknownReasons{}` | Per-`unresolvedReason` counts. |
480+
| 0.1.2 | `parserCapabilities{}` | Frozen matrix of what each parser sees vs. leaves unresolved. |
481+
| 0.2.0 | `refDiff{}` | PR-aware diff vs a git ref. Surfaces added / removed / changedPosture / changedRisk. |
482+
| 0.2.0 | `endpoints[].risk` / `riskReason` | Per-endpoint HIGH/MED/LOW tier. Frozen v1 ladder. |
483+
| 0.2.0 | `summary.risk{}` | HIGH/MED/LOW counts. |
484+
| 0.2.0 | `riskTier{}` + `riskVersion` | Rubric version of the risk ladder. |
485+
| 0.2.0 | `filter` | The filter expression in effect (view-only). |
486+
| 0.3.0 | `parserCapabilities.nest.methodDecoratorsBelowAnchor` | Now `true` — bidirectional decorator scan captures markers above AND below `@Get`/`@Post`. |
487+
| 0.3.0 | `parserCapabilities.nest.globalGuardDetection` | Documented as `NOT DETECTED` — NestJS `APP_GUARD` / `useGlobalGuards` providers are invisible. Use `auth.nest` overrides or `severityOverrides`. |
488+
| 0.3.0 | LIMITATIONS entry #7 | Global-guard blind spot disclosed in every printed report. |
482489

483490
### Posture tiers
484491

0 commit comments

Comments
 (0)