docs(api): dokumentera batch-rapport API #1
Merged
Peter Wickenberg opened 6 months ago

Sammanfattning

Skapar docs/API.md med komplett API-dokumentation för batch-rapport API:et (fixes #2).

Innehåll

  • Alla endpoints: GET /health, GET /api/check, POST /api/batch/check, GET /api/batch/download/{job_id}
  • SSE-eventstruktur: start, progress, complete — med fältbeskrivningar och exempelflöde
  • Datamodeller: CheckResult, Provider, statusnivåer
  • Felkoder: Komplett tabell med HTTP-koder per endpoint
  • Exempel: curl och PowerShell-anrop för samtliga endpoints
  • Begränsningar: Rate limits, max domäner, filstorlek, jobblivslängd

Hur man testar

Dokumentation — ingen funktionell ändring. Granska docs/API.md för korrekthet mot faktisk implementation i backend/app/main.py och backend/app/batch.py.

Risker

Ingen — enbart dokumentation.

Commits were squashed into a single commit on target branch
1/1
Submitter Peter Wickenberg
Target main
Source docs/batch-api-dokumentation
Merge Strategy
Squash Source Branch Commits
Watchers (1)
Reference
PR m365-dns-checkup#1
Please wait...
Connection lost or session expired, reload to recover
Page is in error, reload to recover