7441c9f298
All findings from the inaugural LeadValidator audit resolved and confirmed. Release gate: PASS. VV_ISSUE_002 (BLOCKER): 15 OpenAPI specs verified present covering all 20 route groups (46 endpoints documented in docs/openapi/) VV_ISSUE_003 (MAJOR): Remove any types from src/db/pool.ts — replaced pool.query shim with unknown[] + Object.defineProperty, zero any types, eslint-disable suppressions removed VV_ISSUE_004 (MAJOR): Remove raw Pool from ScaffoldController and HealthDetailedController — injected AgentRepository/CredentialRepository and DbProbe interface respectively; added CredentialRepository.findActiveClientId() VV_ISSUE_005 (MAJOR): Add unit tests for 5 untested services — ComplianceStatusStore, EventPublisher, MarketplaceService, OIDCTrustPolicyService, UsageService VV_ISSUE_006 (MAJOR): Add integration tests for 7 missing route groups — analytics, billing, tiers, webhooks, marketplace, oidc-trust-policies, oidc-token-exchange VV_ISSUE_001 (MINOR): Create missing design.md and tasks.md in 4 OpenSpec archives — all archives now complete Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
37 lines
1.9 KiB
Markdown
37 lines
1.9 KiB
Markdown
# Design — developer-docs-phase6-update
|
||
|
||
**Status:** Complete
|
||
**Archived:** 2026-04-04
|
||
|
||
## Context
|
||
|
||
Developer documentation in `docs/developers/` was last updated during Phase 2. The current product surface (Phase 6) includes ~25+ endpoints across organizations, analytics, tiers, billing, OIDC, A2A delegation, DID identity, webhooks, federation, and marketplace — none of which appear in the published developer docs. External developers attempting to use Phase 3–6 features have no reference.
|
||
|
||
## Goals / Non-Goals
|
||
|
||
**Goals:**
|
||
- Bring all developer-facing docs current with Phase 6 surface
|
||
- Update API reference to cover all 50+ endpoints (was 14)
|
||
- Add Phase 3–6 concepts to concepts.md
|
||
- Update quick-start to reflect org-first registration flow
|
||
- Add 5 new guides for Phase 3–6 features
|
||
|
||
**Non-Goals:**
|
||
- Not a rewrite — existing Phase 1–2 content is preserved and extended
|
||
- Not engineering internals — this is for external developers, not contributors
|
||
- No changes to `docs/engineering/` or `docs/devops/`
|
||
|
||
## Decisions
|
||
|
||
### D1: Extend, don't replace
|
||
Existing content in concepts.md, quick-start.md, and guides/ is preserved as-is. New sections are appended. This avoids breaking any existing bookmarks or references.
|
||
|
||
### D2: Single api-reference.md, complete replacement
|
||
The 14-endpoint Phase 1 api-reference.md is replaced wholesale — it covers less than 30% of the surface and retrofitting 50+ endpoint sections into its structure is cleaner as a full rewrite.
|
||
|
||
### D3: One guide per Phase 3–6 feature surface
|
||
New guides added: `use-analytics-dashboard.md`, `manage-api-tiers.md`, `a2a-delegation.md`, `configure-webhooks.md`, `agntcy-compliance.md`. Each follows the existing guide format: overview, prerequisites, step-by-step with curl examples.
|
||
|
||
### D4: README.md index updated
|
||
`docs/developers/README.md` guide index expanded from 4 to 9 entries to include all new guides.
|