Chronicle.Compliance.ComplianceMetadataType (cratis_chronicle v1.0.1)

Copy Markdown View Source

Identifies a kind of compliance metadata that can be attached to a property or type in a generated JSON schema.

The Chronicle kernel matches the metadataType value carried in a schema's compliance array against its registered compliance handlers. The value is a string; for personally identifiable information it is the well-known "PII" string (the same value the C# and TypeScript clients use).

Summary

Functions

The compliance metadata type for Personally Identifiable Information (PII) according to the definition of personal data in GDPR.

Functions

pii()

@spec pii() :: String.t()

The compliance metadata type for Personally Identifiable Information (PII) according to the definition of personal data in GDPR.

Returns the string the Chronicle kernel uses to select its PII (GDPR) compliance handler, which encrypts the adorned values.