Technical documentation

The technical section is auto-populated from opsclaw-product/tools/api-inventory/.

Each service has a dedicated page under Services with:

• A Swagger-UI-like endpoints table (method + path + summary + side-effects chips)
• The per-service event-flow diagram (Mermaid, server-rendered to SVG)
• The full OpenAPI 3.1 YAML for the service, downloadable

Cross-cutting diagrams

System map

      
        mmdc render failed: Command failed: npx --no-install mmdc -i "/home/runner/_work/opstech-site/opstech-site/docs-site/.mermaid-cache/9a94ab4c2ee7ac35.mmd" -o "/home/runner/_work/opstech-site/opstech-site/docs-site/.mermaid-cache/9a94ab4c2ee7ac35.svg" -b transparent 2>&1
      
    

Every service → every persistent store it touches.

External-systems matrix

      
        mmdc render failed: Command failed: npx --no-install mmdc -i "/home/runner/_work/opstech-site/opstech-site/docs-site/.mermaid-cache/05c3fbbba4540d2b.mmd" -o "/home/runner/_work/opstech-site/opstech-site/docs-site/.mermaid-cache/05c3fbbba4540d2b.svg" -b transparent 2>&1
      
    

Outbound third-party calls only (Stripe, Postmark, Telegram, Cloudflare, LLM, Browser-Use).

How auto-sync works

1. A PR in opsclaw-product adds/changes a route. The api-drift CI gate forces the author to update the OpenAPI fragment + Mermaid diagram in the same PR.
2. On merge to opsclaw-product:main, the docs-propagate.yml workflow regenerates everything and opens an auto-PR here under automation/openapi-sync-<sha>.
3. A human reviews the preview deploy URL (pr-<n>.opstech-docs.pages.dev) and merges.
4. deploy-prod.yml rebuilds the live docs.opstech.dev.

Trust signals

• The list of services and operations comes from the same scanner that runs in opsclaw-product CI. No drift is possible: any mismatch fails the api-drift step.
• Every operation has an x-opstech-status field: verified-from-code (the scanner agrees), declared-only (forward-looking, no code yet), or legacy-untracked (deprecated). The endpoints table surfaces this.