Context

The context is the metadata snapshot that apply to a given log size.

type Context =
  { id : Name
  , copyright : Maybe String
  , custodian : Maybe String
  , description : Maybe String
  , hashingAlgorithm : HashingAlgorithm
  , licence : Maybe String
  , rootHash : Hash
  , schema : Schema
  , statistics : Statistics
  , status : Status
  , title : Maybe String
  }

Attributes

Id

The register identifier.

The register copyright. E.g. © Crown copyright. A register SHOULD have an explicit copyright.

Custodian

The data owner. A register SHOULD have an explicit owner.

Description

The human readable description of the register.

Hashing algorithm

  • Type: HashingAlgorithm

The hashing algorithm for the register.

Licence

The licence the data is released under. A register SHOULD have an explicit licence to ensure users know under what terms they can use the data.

Root hash

The root hash for the register.

Schema

The set of attributes that define the data allowed in the register.

Statistics

  • Type: Statistics

The summary of objects stored in the register.

type Statistics =
  { totalEntries : Integer
  , totalRecords : Integer
  , totalBlobs : Integer
  }

Status

  • Type: Status

The status of the register. Either active or retired.

type Status
  = Active { startDate : Timestamp }
  | Retired { startDate : Timestamp
            , endDate : Timestamp
            , replacement : Maybe Url
            , reason : Text
            }

Title

The human readable name of the register.

© Crown copyright released under the Open Government Licence.