@poseidat/schemas/lib/schema/core/base-entry.json

The core schemas for the PoseiDAT data interchange formats

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://poseidat.org/schema/core/base-entry.json",
  "title": "Base entry",
  "description": "The shared properties for all entries",
  "properties": {
    "journal_id": {
      "description": "The unique identifier of the journal (UUID v4) this entry belongs to",
      "type": "string",
      "format": "uuid"
    },
    "entry_id": {
      "description": "The unique identifier for the entry (UUID v4)",
      "type": "string",
      "format": "uuid"
    },
    "entry_type": {
      "description": "The journal entry type identifier",
      "type": "string"
    },
    "entry_datetime": {
      "description": "The date and time the entry was logged in UTC in RFC3339 format",
      "type": "string",
      "format": "date-time"
    },
    "revision": {
      "description": "The revision timestamp of this entry. Should be the time it was created.",
      "type": "string",
      "format": "date-time"
    },
    "immutable": {
      "description": "Indicates this entry cannot be replaced with future revisions (default)",
      "type": "boolean",
      "default": false
    },
    "remarks": {
      "description": "Free form remarks that are to be added to this journal entry",
      "type": "string"
    }
 },
  "required": [
    "journal_id",
    "entry_id",
    "entry_type",
    "revision",
    "immutable"
  ],
  "type": "object",
  "additionalProperties": true
}