Furries PH Docs
Dashboard
Platform API docs

Schemas

Pagination, Filtering, and Sorting

How to document list options and avoid fragile client assumptions.

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.

List option rules

  1. Action 1 - Find query reads: Search for c.req.query(), new URL(c.req.url), and Supabase range/order/filter calls.
  2. Action 2 - Document defaults: Record default page size, maximum page size, default sort, and missing-filter behavior.
  3. Action 3 - Keep filters named: A filter is not part of the API contract until its name, type, and allowed values are documented.
  4. Action 4 - Verify empty states: Consumers need to know the difference between no results, forbidden results, and broken queries.

All docs