Handbook

Scenario — API workspace scan rehearsal

Use documented GET endpoints to list workspace roots, confirm slugs match disk layout, then graduate to Wizard or Docs Health overlays.

Updated

Scenario summary

Use documented GET endpoints to list workspace roots, confirm slugs match disk layout, then graduate to Wizard or Docs Health overlays.

User role

Integrator validating automation harnesses.

Starting state

  • Local Lenses up with repos registered in Studio.
  • HTTP client restricted to localhost.

Steps

  1. Read Schemas and API for builders for /api/repo families.
  2. Issue GET-only probes mirroring CI smoke tests (curl snippets stay local).
  3. Compare payloads with filesystem paths under $LENSES_WORKSPACE_ROOT.

Example input

curl http://127.0.0.1:8080/api/repo/status once per handbook guidance (swap port).

Example output or expected state

Structured JSON referencing discovered repos without surfacing PAT material.

Verification

Responses match swagger-level descriptions in handbook tables; failures route to Troubleshooting.

Failure / recovery

Reset .lenses-local caches per Security and local-first, rescan host via Workspace setup — scan host.

Generated HTTP routes + docs/generated/openapi.json (partial catalog).