Sync

One round-trip the polling client uses to refresh its view.

Side effects:

  • Pings the caller's presence so they appear as active to other clients without a separate request.
  • Reconciles the caller's lock state from the optional held_locks query string (format: block_id:token,block_id:token): tokens still claimed are heartbeated; locks held by the caller that aren't in the list are released immediately.

All DB calls are synchronous psycopg under the hood; each runs on the threadpool via asyncio.to_thread so the event-loop worker isn't parked, and asyncio.gather collapses them to one wall-clock round-trip.

get/api/workbooks/{workbook_id}/sync

Request

  • Base URL: https://app.bitboard.work (the document declares no server; this is the origin it was published from)
  • URL: https://app.bitboard.work/api/workbooks/{workbook_id}/sync
  • Auth: none declared

Path parameters

workbook_idstring required

Query parameters

held_locksstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.