Skip to main content

Module reference_api

Module reference_api 

Source

Enums§

RiskClearReferenceError
struct for typed errors of method risk_clear_reference
RiskReferenceError
struct for typed errors of method risk_reference
RiskReferenceSetsError
struct for typed errors of method risk_reference_sets
RiskRefreshReferenceError
struct for typed errors of method risk_refresh_reference
RiskResolveReferenceError
struct for typed errors of method risk_resolve_reference
RiskSetReferenceError
struct for typed errors of method risk_set_reference

Functions§

risk_clear_reference
Removes one of your organisation’s overrides. It removes an entry your organisation wrote, never a baseline member: the published set is not writable from here, so a removal can only ever restore the baseline’s own answer.
risk_reference
Reference describes one set and lists your org’s overrides in it. The set half is public data about a published list — its version, its publishers, their licences and how current each one is. The overrides half is yours alone: it is read from your organisation’s own store, and no other organisation’s entries can appear in it.
risk_reference_sets
Lists every set this plane publishes, with its version and how fresh it is. Read the Stale and Refused lists first: they are the two ways this plane can be quietly wrong, and they are reported rather than inferred. A set in Refused answers nothing — it has never loaded, it is held by another component, or it names a source we hold no licence for.
risk_refresh_reference
Takes a new version of one set. SuperAdmin only. It is platform work, not tenant work: it writes the shared baseline every organisation reads, so it is gated to the platform’s own identity. Nothing here can write an organisation’s overrides, and nothing an organisation sends can reach this route. Idempotent. A version is the content digest of what was taken, so refreshing an unchanged publisher writes no rows and reports unchanged. Resumable: a run that died half-way is continued from where it stopped rather than restarted. A set whose source needs a licence we do not hold is refused with the reason, rather than being quietly skipped.
risk_resolve_reference
Looks keys up against the reference plane. Your organisation’s own overrides are consulted FIRST and win outright; the shared baseline answers everything they do not cover. Every answer names the version that produced it, when that version was current and whether it is stale, so a decision can record exactly what it consulted. Read Refusal before reading Hit. A set that has never loaded, one held by the component that screens against it, and one whose source needs a licence we do not hold all answer with a refusal — and a miss on a refusing set means nothing is known, not that the key is clean.
risk_set_reference
Writes your organisation’s own allow and deny entries over a set. Idempotent on the key: writing the same entry twice is one entry, and writing it again replaces the verdict and the note. The whole batch is one transaction, so a batch that would cross the per-set bound writes nothing rather than half of itself — a half-applied deny list is worse than a refused one, because nobody can tell which half applied. Your entries are held in your organisation’s own store and are never visible to another organisation, and they never change what any other organisation sees. The shared baseline is not writable from here at all.