Skip to content

API Documentation — Completion checklist

Template: TPL-06-05 ../02-Templates/API-Documentation-Template.md | Version: 0.3
How to use: tick an item only after inspecting the completed record and its evidence. Every unticked item needs an OPEN- entry with an owner, or a written, approved disposition.

Content checks

  • [ ] 01. Service catalog and source ownership — Every service in the inventory is covered.
  • [ ] 02. Complete endpoint inventory and code references — Count of documented endpoints equals the inventory count.
  • [ ] 03. OpenAPI operation parameters and schemas — Docs are generated from OpenAPI or diffed against it in CI.
  • [ ] 04. Authentication scopes and tenant boundaries — Scopes are listed per operation.
  • [ ] 05. Success failure and synthetic payload samples — Samples contain no real data.
  • [ ] 06. Timeout retry idempotency and pagination — Retry guidance matches server idempotency behavior.
  • [ ] 07. External API and webhook dependencies — Webhook signing verification is documented.
  • [ ] 08. Contract tests versions and change history — Docs version equals API version.

Record control checks

  • [x] Document ID follows KAI-<PRODUCT>-APID-NNN and is unique in the product.
  • [x] Product, version and commit SHA match the related records.
  • [x] No placeholder rows remain; every gap names an owner and an OPEN- item.
  • [x] Every cited link, file path and ID resolves.
  • [ ] Security, privacy, AI/ML and medical-software applicability checked and routed to qualified reviewers where relevant.
  • [x] No patient identifiers, secrets or production data copied into the record.
  • [x] Nothing was taken from the worked examples as if it were evidence.
  • [ ] Named independent reviewer completed review; approval recorded with date.

Reviewer: Technical reviewer (name to be assigned — OPEN-001) | Date: Pending | Outcome: [Complete / Returned with actions]

Self-check by Claude Code, 2026-10-28, at a6b4429. Ticked items were verified mechanically in this session: sdlc.py validate 0 errors (75 records, stages 01–10); sdlc.py trace no duplicate IDs and every REQ linked to design and test; code citations resolve at a6b4429 (except files in the separate Visionary_oral_ML repository, labelled as external). Content checks are left for the named reviewer; every gap is an owned OPEN- item in the record. Reviewer and approval items are for people.