bitemporal-runtime 0.1.0

Bitemporal truth primitives — valid_time/recorded_time tracking, append-supersede, as-of queries, temporal snapshots.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

//! JSON Schema generation for the public bitemporal types.
//!
//! Enabled with the `schema` cargo feature. The schemas are
//! generated via `schemars::schema_for!` so they stay in lockstep
//! with the type definitions.

#![cfg(feature = "schema")]

use schemars::{schema::RootSchema, schema_for};

use crate::{BitemporalRecord, SupersessionReceipt, SupersessionTarget};

/// JSON Schema for [`BitemporalRecord<serde_json::Value>`]. The
/// value is left as an open `Value` so consumers can record any
/// JSON-serializable payload.
pub fn bitemporal_record_schema() -> RootSchema {
    schema_for!(BitemporalRecord<serde_json::Value>)
}

/// JSON Schema for [`SupersessionReceipt`].
pub fn supersession_receipt_schema() -> RootSchema {
    schema_for!(SupersessionReceipt)
}

/// JSON Schema for [`SupersessionTarget`].
pub fn supersession_target_schema() -> RootSchema {
    schema_for!(SupersessionTarget)
}