paperspec/schemas/document.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://paperspec.scient.ing/schemas/document.schema.json",
  "title": "Document",
  "description": "document.json of a scienting-doc/1 package; spec/02-model.md and spec/12-package.md.",
  "type": "object",
  "properties": {
    "format": {
      "const": "scienting-doc/1"
    },
    "key": {
      "$ref": "common.schema.json#/$defs/key"
    },
    "store": {
      "$ref": "common.schema.json#/$defs/key"
    },
    "aliases": {
      "type": "array",
      "items": {
        "$ref": "common.schema.json#/$defs/key"
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "kind": {
      "enum": [
        "article",
        "supplement",
        "chapter",
        "book",
        "thesis",
        "report",
        "draft",
        "course-material",
        "other"
      ]
    },
    "work": {
      "type": "object",
      "properties": {
        "key": {
          "$ref": "common.schema.json#/$defs/key"
        },
        "same_as": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^(doi|arxiv|isbn|pmid|pmcid|url|lode):[^ ]+$"
          },
          "uniqueItems": true
        }
      },
      "required": [
        "key",
        "same_as"
      ],
      "additionalProperties": false
    },
    "version": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "preprint",
            "submitted",
            "accepted",
            "version-of-record",
            "erratum",
            "retraction",
            "supplement",
            "draft",
            "other"
          ]
        },
        "seq": {
          "type": "integer",
          "minimum": 1
        },
        "date": {
          "$ref": "common.schema.json#/$defs/date"
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false
    },
    "relations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "supplement-of",
              "part-of",
              "version-of",
              "erratum-of",
              "retraction-of",
              "translation-of"
            ]
          },
          "target": {
            "$ref": "common.schema.json#/$defs/qualifiedKey"
          }
        },
        "required": [
          "type",
          "target"
        ],
        "additionalProperties": false
      }
    },
    "meta": {
      "type": "object",
      "description": "A CSL-JSON item for the version."
    },
    "language": {
      "$ref": "common.schema.json#/$defs/language"
    },
    "license": {
      "$ref": "common.schema.json#/$defs/license"
    },
    "policy": {
      "enum": [
        "full",
        "checks-only"
      ]
    },
    "hashing": {
      "$ref": "common.schema.json#/$defs/hashing"
    },
    "root": {
      "$ref": "common.schema.json#/$defs/hash"
    },
    "meta_hash": {
      "$ref": "common.schema.json#/$defs/hash"
    },
    "rev": {
      "type": "integer",
      "minimum": 0
    },
    "counts": {
      "type": "object",
      "properties": {
        "nodes": {
          "type": "integer",
          "minimum": 1
        },
        "leaves": {
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "nodes",
        "leaves"
      ],
      "additionalProperties": false
    },
    "fidelity": {
      "type": "object",
      "properties": {
        "lowest": {
          "anyOf": [
            {
              "$ref": "common.schema.json#/$defs/level"
            },
            {
              "type": "null"
            }
          ]
        },
        "counts": {
          "type": "object",
          "properties": {
            "F0": {
              "type": "integer",
              "minimum": 0
            },
            "F1": {
              "type": "integer",
              "minimum": 0
            },
            "F2": {
              "type": "integer",
              "minimum": 0
            },
            "F3": {
              "type": "integer",
              "minimum": 0
            }
          },
          "required": [
            "F0",
            "F1",
            "F2",
            "F3"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "lowest",
        "counts"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "format",
    "key",
    "kind",
    "work",
    "version",
    "relations",
    "meta",
    "language",
    "policy",
    "hashing",
    "root",
    "meta_hash",
    "rev",
    "counts",
    "fidelity"
  ],
  "additionalProperties": false
}