Furries PH Docs
Dashboard
Platform API docs

Testing

Contract and Route Inventory Checks

How to keep generated endpoint documentation aligned with partners-api source.

First created Last updated

End-to-end developer runbook

  1. Step 1 - Confirm the API area: Identify the product area, route module, endpoint path, and consumer before writing or calling code.
  2. Step 2 - Read the endpoint contract: Check method, auth, parameters, response, errors, side effects, and related docs.
  3. Step 3 - Prepare authentication and input: Use the right session, bearer token, webhook secret, or internal header. Validate body and query data before sending it.
  4. Step 4 - Make the request: Call the endpoint from the correct origin and environment. Keep credentials and secrets out of logs.
  5. Step 5 - Verify response, side effects, and records: Confirm status code, response shape, database records, external side effects, and audit evidence.
  6. Step 6 - Add tests, docs, and handoff notes: Update route inventory, consumer notes, and certification checks before depending on the change.

Inventory workflow

  1. Step 1 - Change routes: Modify partners-api/src/index.ts, src/routes/*.ts, middleware, or helper code.
  2. Step 2 - Regenerate docs: Run node scripts/generate-platform-api-docs.mjs from docs.furries.ph.
  3. Step 3 - Review generated diff: Confirm new, removed, alias, duplicate, and dynamic routes are expected.
  4. Step 4 - Fill manual unknowns where needed: Generated Unknown from source scan fields are prompts for handler review.
  5. Step 5 - Run docs validation: Run pnpm check, pnpm build, and unlabeled-number checks.

Required checks

pnpm check
pnpm build
rg -n --pcre2 "^\d+\. (?!\*\*)" src/pages/platform-api -g "*.md"

All docs