Schemas

Machine-readable contracts

HTML is this page. Raw JSON is the $id URL — the address tools should fetch.

mx file-types

Canonical file type record used by DAVIT validation and archive ingest.

/schemas/mx/file-types.json
https://davit.in/schemas/mx/file-types.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://davit.in/schemas/mx/file-types.json",
  "title": "mx file-types",
  "description": "Canonical file type record used by DAVIT validation and archive ingest.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "extension",
    "mediaType",
    "kind"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^ft:[a-z0-9][a-z0-9.-]+$",
      "description": "Stable file-type identifier."
    },
    "extension": {
      "type": "string",
      "pattern": "^\\.[a-z0-9.]+$"
    },
    "mediaType": {
      "type": "string",
      "description": "IANA media type or x-davit vendor type."
    },
    "kind": {
      "type": "string",
      "enum": [
        "document",
        "image",
        "audio",
        "video",
        "archive",
        "data",
        "code",
        "other"
      ]
    },
    "aliases": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "preservation": {
      "type": "string",
      "enum": [
        "preferred",
        "acceptable",
        "normalize",
        "reject"
      ]
    },
    "notes": {
      "type": "string"
    }
  },
  "examples": [
    {
      "id": "ft:markdown",
      "extension": ".md",
      "mediaType": "text/markdown",
      "kind": "document",
      "preservation": "preferred"
    }
  ]
}

mx id-types

Identifier type registry for records, objects, and archival entities.

/schemas/mx/id-types.json
https://davit.in/schemas/mx/id-types.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://davit.in/schemas/mx/id-types.json",
  "title": "mx id-types",
  "description": "Identifier type registry for records, objects, and archival entities.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "pattern",
    "scope"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^id:[a-z0-9][a-z0-9.-]+$"
    },
    "label": {
      "type": "string"
    },
    "pattern": {
      "type": "string",
      "description": "Regular expression describing valid values."
    },
    "scope": {
      "type": "string",
      "enum": [
        "global",
        "system",
        "collection",
        "object",
        "file"
      ]
    },
    "resolver": {
      "type": "string",
      "format": "uri"
    },
    "persistent": {
      "type": "boolean"
    }
  },
  "examples": [
    {
      "id": "id:ark",
      "label": "ARK",
      "pattern": "^ark:[/]?[0-9]+/.+",
      "scope": "global",
      "persistent": true
    }
  ]
}