Skip to main content

Module api_log

Expand description

The Suotar API log tab: one row per HTTP call to the study registry, and what each covered.

The stored bodies are scrubbed at write time — names, student numbers and email addresses read [redacted] while their keys survive — and are returned exactly as stored. What makes the log navigable is not the body but credit_registration_ids: every call resolves to the ledger rows it carried, and those hold the real values.

Structs§

ListSuotarApiCallsQuery
SuotarApiCallDetails
SuotarApiCallEvent
A timeline entry written against this call, one per item the answer moved.
SuotarApiCallLedgerReference
One ledger row a call carried, resolved from credit_registration_ids. This is what stands in for the redacted body: the identifiers are here, beside the item they belong to.
SuotarApiCallRow
SuotarApiCallsPage

Constants§

MAX_REFERENCED_ROWS 🔒
How many ledger rows one call may resolve. A batch is capped well below this by the endpoint’s own batch size.

Functions§

_add_routes
get_suotar_api_call
GET /api/v0/main-frontend/credit-registration-admin/suotar-api-calls/{suotar_api_call_id} - One call with its stored bodies, the ledger rows it covered and the timeline entries it produced.
list_suotar_api_calls
GET /api/v0/main-frontend/credit-registration-admin/suotar-api-calls - A page of the study registry call log, newest first.
resolve_ledger_references 🔒
The ledger rows a call named, in the order the call listed them, so the reference table lines up with the stored body’s items.
to_call_row 🔒
to_call_row_from_full 🔒
The same summary, from the detail endpoint’s full row rather than the bodyless listing one.