pub.chive.eprint.submission

lexicons.governance.chive.pub

Documentation

A scholarly eprint submission record

main record

A scholarly eprint submission record

Record Key tid Timestamp-based ID

Properties

abstract array of union Required

Rich abstract with text, formatting, and entity references

maxLength: 500 items

Known types:

abstractPlainText string Optional

Plain text abstract for search indexing (auto-generated)

maxLength: 10000 bytes

authors array of ref pub.chive.eprint.authorContribution Required

All authors with contributions, affiliations, and metadata

maxLength: 100 itemsminLength: 1 items

conferencePresentation ref #conferencePresentation Optional

Conference where this work was presented

createdAt string datetime Required

Creation timestamp

document blob Required

Primary manuscript document (PDF, DOCX, HTML, Markdown, LaTeX, or Jupyter)

maxSize: 52.4 MB

documentFormatSlug ref pub.chive.defs#documentFormat Optional

Document format slug for display fallback

documentFormatUri string at-uri Optional

AT-URI to document format node (subkind=document-format)

externalIds ref #externalIds Optional

External persistent identifiers

facetUris array of string at-uri Optional

Facet node references (subkind=facet)

maxLength: 30 items

fieldUris array of string at-uri Optional

Field node references (subkind=field)

maxLength: 10 items

funding array of ref #fundingSource Optional

Funding sources and grants

maxLength: 20 items

keywords array of string Optional

Author-provided keywords

maxLength: 20 items

licenseSlug string Required

SPDX license identifier for display fallback

Known values: CC-BY-4.0, CC-BY-SA-4.0, CC0-1.0, MIT, Apache-2.0

licenseUri string at-uri Optional

AT-URI to license node (subkind=license)

paperDid string did Optional

DID of the paper's own account (if paper has its own PDS)

paperTypeSlug string Optional

Paper type slug for display fallback

Known values: original-research, review, meta-analysis, case-study, commentary, tutorial, survey

paperTypeUri string at-uri Optional

AT-URI to paper type node (subkind=paper-type)

previousVersion string at-uri Optional

Previous version URI

publicationStatusSlug ref pub.chive.defs#publicationStatus Optional

Publication status slug for display fallback. The Lexicon spec allows `default` only on primitive types, not on a ref, so the `default: preprint` that used to sit here was never applied — a record omitting this field got nothing, not a preprint. Removing it changes no behaviour and stops the schema promising one it does not keep; consumers supply their own fallback.

publicationStatusUri string at-uri Optional

AT-URI to publication status node (subkind=publication-status)

publishedVersion ref #publishedVersion Optional

Link to the published version (Version of Record)

relatedWorks array of ref #relatedWork Optional

Related eprints, datasets, software, and prior versions

maxLength: 50 items

repositories ref #repositories Optional

Linked code, data, and materials repositories

schemaRevision integer Optional

Schema revision this record was created with. Absent means revision 1.

minimum: 1

submittedBy string did Required

DID of the human user who submitted this eprint

supplementaryMaterials array of ref #supplementaryItem Optional

Additional materials (appendices, data, code, figures)

maxLength: 50 items

title string Required

Eprint title

maxLength: 500 bytes

titleRich array of union Optional

Rich title with formatting and entity references (for titles with LaTeX, etc.)

maxLength: 50 items

Known types:

topicUris array of string at-uri Optional

Topic node references (subkind=topic)

maxLength: 20 items

version ref #semanticVersion Optional

Semantic version of this eprint

versionNumber integer Optional

Legacy version number (1-indexed), deprecated in favor of semanticVersion

minimum: 1

View raw schema

{
  "description": "A scholarly eprint submission record",
  "key": "tid",
  "record": {
    "properties": {
      "abstract": {
        "description": "Rich abstract with text, formatting, and entity references",
        "items": {
          "refs": [
            "pub.chive.richtext.defs#textItem",
            "pub.chive.richtext.defs#nodeRefItem",
            "pub.chive.richtext.defs#wikidataRefItem",
            "pub.chive.richtext.defs#fieldRefItem",
            "pub.chive.richtext.defs#facetRefItem",
            "pub.chive.richtext.defs#eprintRefItem",
            "pub.chive.richtext.defs#annotationRefItem",
            "pub.chive.richtext.defs#authorRefItem",
            "pub.chive.richtext.defs#mentionItem",
            "pub.chive.richtext.defs#linkItem",
            "pub.chive.richtext.defs#tagItem",
            "pub.chive.richtext.defs#latexItem",
            "pub.chive.richtext.defs#codeBlockItem",
            "pub.chive.richtext.defs#headingItem",
            "pub.chive.richtext.defs#listItem",
            "pub.chive.richtext.defs#blockquoteItem"
          ],
          "type": "union"
        },
        "maxLength": 500,
        "type": "array"
      },
      "abstractPlainText": {
        "description": "Plain text abstract for search indexing (auto-generated)",
        "maxLength": 10000,
        "type": "string"
      },
      "authors": {
        "description": "All authors with contributions, affiliations, and metadata",
        "items": {
          "ref": "pub.chive.eprint.authorContribution",
          "type": "ref"
        },
        "maxLength": 100,
        "minLength": 1,
        "type": "array"
      },
      "conferencePresentation": {
        "description": "Conference where this work was presented",
        "ref": "#conferencePresentation",
        "type": "ref"
      },
      "createdAt": {
        "description": "Creation timestamp",
        "format": "datetime",
        "type": "string"
      },
      "document": {
        "accept": [
          "application/pdf",
          "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
          "text/html",
          "text/markdown",
          "text/x-markdown",
          "text/x-tex",
          "application/x-tex",
          "application/x-ipynb+json",
          "application/vnd.oasis.opendocument.text",
          "application/rtf",
          "application/epub+zip",
          "text/plain"
        ],
        "description": "Primary manuscript document (PDF, DOCX, HTML, Markdown, LaTeX, or Jupyter)",
        "maxSize": 52428800,
        "type": "blob"
      },
      "documentFormatSlug": {
        "description": "Document format slug for display fallback",
        "ref": "pub.chive.defs#documentFormat",
        "type": "ref"
      },
      "documentFormatUri": {
        "description": "AT-URI to document format node (subkind=document-format)",
        "format": "at-uri",
        "type": "string"
      },
      "externalIds": {
        "description": "External persistent identifiers",
        "ref": "#externalIds",
        "type": "ref"
      },
      "facetUris": {
        "description": "Facet node references (subkind=facet)",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 30,
        "type": "array"
      },
      "fieldUris": {
        "description": "Field node references (subkind=field)",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 10,
        "type": "array"
      },
      "funding": {
        "description": "Funding sources and grants",
        "items": {
          "ref": "#fundingSource",
          "type": "ref"
        },
        "maxLength": 20,
        "type": "array"
      },
      "keywords": {
        "description": "Author-provided keywords",
        "items": {
          "maxLength": 100,
          "type": "string"
        },
        "maxLength": 20,
        "type": "array"
      },
      "licenseSlug": {
        "description": "SPDX license identifier for display fallback",
        "knownValues": [
          "CC-BY-4.0",
          "CC-BY-SA-4.0",
          "CC0-1.0",
          "MIT",
          "Apache-2.0"
        ],
        "type": "string"
      },
      "licenseUri": {
        "description": "AT-URI to license node (subkind=license)",
        "format": "at-uri",
        "type": "string"
      },
      "paperDid": {
        "description": "DID of the paper's own account (if paper has its own PDS)",
        "format": "did",
        "type": "string"
      },
      "paperTypeSlug": {
        "description": "Paper type slug for display fallback",
        "knownValues": [
          "original-research",
          "review",
          "meta-analysis",
          "case-study",
          "commentary",
          "tutorial",
          "survey"
        ],
        "type": "string"
      },
      "paperTypeUri": {
        "description": "AT-URI to paper type node (subkind=paper-type)",
        "format": "at-uri",
        "type": "string"
      },
      "previousVersion": {
        "description": "Previous version URI",
        "format": "at-uri",
        "type": "string"
      },
      "publicationStatusSlug": {
        "description": "Publication status slug for display fallback. The Lexicon spec allows `default` only on primitive types, not on a ref, so the `default: preprint` that used to sit here was never applied — a record omitting this field got nothing, not a preprint. Removing it changes no behaviour and stops the schema promising one it does not keep; consumers supply their own fallback.",
        "ref": "pub.chive.defs#publicationStatus",
        "type": "ref"
      },
      "publicationStatusUri": {
        "description": "AT-URI to publication status node (subkind=publication-status)",
        "format": "at-uri",
        "type": "string"
      },
      "publishedVersion": {
        "description": "Link to the published version (Version of Record)",
        "ref": "#publishedVersion",
        "type": "ref"
      },
      "relatedWorks": {
        "description": "Related eprints, datasets, software, and prior versions",
        "items": {
          "ref": "#relatedWork",
          "type": "ref"
        },
        "maxLength": 50,
        "type": "array"
      },
      "repositories": {
        "description": "Linked code, data, and materials repositories",
        "ref": "#repositories",
        "type": "ref"
      },
      "schemaRevision": {
        "description": "Schema revision this record was created with. Absent means revision 1.",
        "minimum": 1,
        "type": "integer"
      },
      "submittedBy": {
        "description": "DID of the human user who submitted this eprint",
        "format": "did",
        "type": "string"
      },
      "supplementaryMaterials": {
        "description": "Additional materials (appendices, data, code, figures)",
        "items": {
          "ref": "#supplementaryItem",
          "type": "ref"
        },
        "maxLength": 50,
        "type": "array"
      },
      "title": {
        "description": "Eprint title",
        "maxLength": 500,
        "type": "string"
      },
      "titleRich": {
        "description": "Rich title with formatting and entity references (for titles with LaTeX, etc.)",
        "items": {
          "refs": [
            "pub.chive.richtext.defs#textItem",
            "pub.chive.richtext.defs#nodeRefItem",
            "pub.chive.richtext.defs#wikidataRefItem",
            "pub.chive.richtext.defs#fieldRefItem",
            "pub.chive.richtext.defs#latexItem",
            "pub.chive.richtext.defs#mentionItem",
            "pub.chive.richtext.defs#linkItem",
            "pub.chive.richtext.defs#tagItem"
          ],
          "type": "union"
        },
        "maxLength": 50,
        "type": "array"
      },
      "topicUris": {
        "description": "Topic node references (subkind=topic)",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 20,
        "type": "array"
      },
      "version": {
        "description": "Semantic version of this eprint",
        "ref": "#semanticVersion",
        "type": "ref"
      },
      "versionNumber": {
        "description": "Legacy version number (1-indexed), deprecated in favor of semanticVersion",
        "minimum": 1,
        "type": "integer"
      }
    },
    "required": [
      "title",
      "abstract",
      "document",
      "licenseSlug",
      "authors",
      "submittedBy",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

codeRepository object

A code repository link

Properties

archiveUrl string uri Optional

Software Heritage archive URL

label string Optional

User-provided label

platformSlug string Optional

Platform slug for display fallback

Known values: github, gitlab, bitbucket, huggingface, paperswithcode, codeberg, sourcehut, tangled, software_heritage, colab, kaggle, other

platformUri string at-uri Optional

AT-URI to platform node (subkind=platform-code)

recordUri string at-uri Optional

AT-URI of the repository record when the host is an ATProto application, such as sh.tangled.repo. Addresses the repository on the network rather than at one web host, so it survives the host moving or disappearing.

swhid string Optional

Software Heritage Identifier

url string uri Optional

Repository URL

View raw schema

{
  "description": "A code repository link",
  "properties": {
    "archiveUrl": {
      "description": "Software Heritage archive URL",
      "format": "uri",
      "type": "string"
    },
    "label": {
      "description": "User-provided label",
      "type": "string"
    },
    "platformSlug": {
      "description": "Platform slug for display fallback",
      "knownValues": [
        "github",
        "gitlab",
        "bitbucket",
        "huggingface",
        "paperswithcode",
        "codeberg",
        "sourcehut",
        "tangled",
        "software_heritage",
        "colab",
        "kaggle",
        "other"
      ],
      "type": "string"
    },
    "platformUri": {
      "description": "AT-URI to platform node (subkind=platform-code)",
      "format": "at-uri",
      "type": "string"
    },
    "recordUri": {
      "description": "AT-URI of the repository record when the host is an ATProto application, such as sh.tangled.repo. Addresses the repository on the network rather than at one web host, so it survives the host moving or disappearing.",
      "format": "at-uri",
      "type": "string"
    },
    "swhid": {
      "description": "Software Heritage Identifier",
      "type": "string"
    },
    "url": {
      "description": "Repository URL",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}

conferencePresentation object

Conference where this work was presented

Properties

conferenceAcronym string Optional

Conference acronym

maxLength: 50 bytes

conferenceIteration string Optional

Specific year or iteration of the conference (e.g., NeurIPS 2024)

maxLength: 100 bytes

conferenceLocation string Optional

Conference location

conferenceName string Optional

Conference name

maxLength: 500 bytes

conferenceUri string at-uri Optional

AT-URI to conference/event node (subkind=event)

conferenceUrl string uri Optional

Conference website URL

presentationDate string datetime Optional

Presentation date

presentationTypeSlug string Optional

Presentation type slug for display fallback

Known values: oral, poster, keynote, workshop, demo, other

presentationTypeUri string at-uri Optional

AT-URI to presentation type node (subkind=presentation-type)

proceedingsDoi string Optional

Proceedings DOI

View raw schema

{
  "description": "Conference where this work was presented",
  "properties": {
    "conferenceAcronym": {
      "description": "Conference acronym",
      "maxLength": 50,
      "type": "string"
    },
    "conferenceIteration": {
      "description": "Specific year or iteration of the conference (e.g., NeurIPS 2024)",
      "maxLength": 100,
      "type": "string"
    },
    "conferenceLocation": {
      "description": "Conference location",
      "type": "string"
    },
    "conferenceName": {
      "description": "Conference name",
      "maxLength": 500,
      "type": "string"
    },
    "conferenceUri": {
      "description": "AT-URI to conference/event node (subkind=event)",
      "format": "at-uri",
      "type": "string"
    },
    "conferenceUrl": {
      "description": "Conference website URL",
      "format": "uri",
      "type": "string"
    },
    "presentationDate": {
      "description": "Presentation date",
      "format": "datetime",
      "type": "string"
    },
    "presentationTypeSlug": {
      "description": "Presentation type slug for display fallback",
      "knownValues": [
        "oral",
        "poster",
        "keynote",
        "workshop",
        "demo",
        "other"
      ],
      "type": "string"
    },
    "presentationTypeUri": {
      "description": "AT-URI to presentation type node (subkind=presentation-type)",
      "format": "at-uri",
      "type": "string"
    },
    "proceedingsDoi": {
      "description": "Proceedings DOI",
      "type": "string"
    }
  },
  "type": "object"
}

dataRepository object

A data repository link

Properties

accessStatement string Optional

Data availability statement

doi string Optional

Dataset DOI

label string Optional

User-provided label

platformSlug string Optional

Platform slug for display fallback

Known values: huggingface, zenodo, figshare, dryad, osf, dataverse, mendeley_data, kaggle, wandb, other

platformUri string at-uri Optional

AT-URI to platform node (subkind=platform-data)

recordUri string at-uri Optional

AT-URI of the dataset record when the data lives in an ATProto application, such as pub.layers.catalog.collection. Addresses the dataset on the network rather than at one web host, so it survives the host moving or disappearing. A dataset published this way commonly has no web address at all, which is why it cannot simply go in `url`: that field is a URL a browser can open, and an at-uri is not one.

url string uri Optional

Repository URL

View raw schema

{
  "description": "A data repository link",
  "properties": {
    "accessStatement": {
      "description": "Data availability statement",
      "type": "string"
    },
    "doi": {
      "description": "Dataset DOI",
      "type": "string"
    },
    "label": {
      "description": "User-provided label",
      "type": "string"
    },
    "platformSlug": {
      "description": "Platform slug for display fallback",
      "knownValues": [
        "huggingface",
        "zenodo",
        "figshare",
        "dryad",
        "osf",
        "dataverse",
        "mendeley_data",
        "kaggle",
        "wandb",
        "other"
      ],
      "type": "string"
    },
    "platformUri": {
      "description": "AT-URI to platform node (subkind=platform-data)",
      "format": "at-uri",
      "type": "string"
    },
    "recordUri": {
      "description": "AT-URI of the dataset record when the data lives in an ATProto application, such as pub.layers.catalog.collection. Addresses the dataset on the network rather than at one web host, so it survives the host moving or disappearing. A dataset published this way commonly has no web address at all, which is why it cannot simply go in `url`: that field is a URL a browser can open, and an at-uri is not one.",
      "format": "at-uri",
      "type": "string"
    },
    "url": {
      "description": "Repository URL",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}

externalIds object

External persistent identifiers

Properties

arxivId string Optional

arXiv identifier

coreSid string Optional

CORE identifier

magId string Optional

Microsoft Academic Graph ID (legacy)

openAlexId string Optional

OpenAlex identifier

osf string Optional

OSF identifier

pmcid string Optional

PubMed Central ID

pmid string Optional

PubMed ID

semanticScholarId string Optional

Semantic Scholar identifier

ssrnId string Optional

SSRN identifier

zenodoDoi string Optional

Zenodo DOI

View raw schema

{
  "description": "External persistent identifiers",
  "properties": {
    "arxivId": {
      "description": "arXiv identifier",
      "type": "string"
    },
    "coreSid": {
      "description": "CORE identifier",
      "type": "string"
    },
    "magId": {
      "description": "Microsoft Academic Graph ID (legacy)",
      "type": "string"
    },
    "openAlexId": {
      "description": "OpenAlex identifier",
      "type": "string"
    },
    "osf": {
      "description": "OSF identifier",
      "type": "string"
    },
    "pmcid": {
      "description": "PubMed Central ID",
      "type": "string"
    },
    "pmid": {
      "description": "PubMed ID",
      "type": "string"
    },
    "semanticScholarId": {
      "description": "Semantic Scholar identifier",
      "type": "string"
    },
    "ssrnId": {
      "description": "SSRN identifier",
      "type": "string"
    },
    "zenodoDoi": {
      "description": "Zenodo DOI",
      "type": "string"
    }
  },
  "type": "object"
}

fundingSource object

A funding source

Properties

funderDoi string Optional

CrossRef Funder Registry DOI

funderName string Optional

Funder name

maxLength: 300 bytes

funderRor string Optional

ROR identifier

funderUri string at-uri Optional

AT-URI to funder institution node (subkind=institution)

grantNumber string Optional

Grant number

maxLength: 100 bytes

grantTitle string Optional

Grant title

maxLength: 500 bytes

grantUrl string uri Optional

Grant URL

View raw schema

{
  "description": "A funding source",
  "properties": {
    "funderDoi": {
      "description": "CrossRef Funder Registry DOI",
      "type": "string"
    },
    "funderName": {
      "description": "Funder name",
      "maxLength": 300,
      "type": "string"
    },
    "funderRor": {
      "description": "ROR identifier",
      "type": "string"
    },
    "funderUri": {
      "description": "AT-URI to funder institution node (subkind=institution)",
      "format": "at-uri",
      "type": "string"
    },
    "grantNumber": {
      "description": "Grant number",
      "maxLength": 100,
      "type": "string"
    },
    "grantTitle": {
      "description": "Grant title",
      "maxLength": 500,
      "type": "string"
    },
    "grantUrl": {
      "description": "Grant URL",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}

material object

A physical material, reagent, or plasmid

Properties

label string Optional

User-provided label

rrid string Optional

Research Resource Identifier

url string uri Optional

Material URL

View raw schema

{
  "description": "A physical material, reagent, or plasmid",
  "properties": {
    "label": {
      "description": "User-provided label",
      "type": "string"
    },
    "rrid": {
      "description": "Research Resource Identifier",
      "type": "string"
    },
    "url": {
      "description": "Material URL",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}

preregistration object

Pre-registration or registered report link

Properties

platformSlug string Optional

Platform slug for display fallback

Known values: osf, aspredicted, clinicaltrials, prospero, other

platformUri string at-uri Optional

AT-URI to platform node (subkind=platform-preregistration)

registrationDate string datetime Optional

Registration date

url string uri Optional

Pre-registration URL

View raw schema

{
  "description": "Pre-registration or registered report link",
  "properties": {
    "platformSlug": {
      "description": "Platform slug for display fallback",
      "knownValues": [
        "osf",
        "aspredicted",
        "clinicaltrials",
        "prospero",
        "other"
      ],
      "type": "string"
    },
    "platformUri": {
      "description": "AT-URI to platform node (subkind=platform-preregistration)",
      "format": "at-uri",
      "type": "string"
    },
    "registrationDate": {
      "description": "Registration date",
      "format": "datetime",
      "type": "string"
    },
    "url": {
      "description": "Pre-registration URL",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}

protocol object

A protocol link

Properties

doi string Optional

Protocol DOI

platformSlug string Optional

Platform slug for display fallback

Known values: protocols_io, bio_protocol, other

platformUri string at-uri Optional

AT-URI to platform node (subkind=platform-protocol)

url string uri Optional

Protocol URL

View raw schema

{
  "description": "A protocol link",
  "properties": {
    "doi": {
      "description": "Protocol DOI",
      "type": "string"
    },
    "platformSlug": {
      "description": "Platform slug for display fallback",
      "knownValues": [
        "protocols_io",
        "bio_protocol",
        "other"
      ],
      "type": "string"
    },
    "platformUri": {
      "description": "AT-URI to platform node (subkind=platform-protocol)",
      "format": "at-uri",
      "type": "string"
    },
    "url": {
      "description": "Protocol URL",
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}

publishedVersion object

Link to the published version (Version of Record)

Properties

accessType string Optional

Open access status

Known values: open_access, green_oa, gold_oa, hybrid_oa, bronze_oa, closed

articleNumber string Optional

Article number

maxLength: 50 bytes

doi string Optional

DOI of the published version (e.g., 10.1234/example)

eLocationId string Optional

Electronic location ID for online-only journals

issue string Optional

Issue number

maxLength: 50 bytes

journal string Optional

Journal name

maxLength: 500 bytes

journalAbbreviation string Optional

Journal abbreviation

maxLength: 100 bytes

journalIssn string Optional

Journal ISSN

licenseUrl string uri Optional

License URL

pages string Optional

Page range

maxLength: 50 bytes

publishedAt string datetime Optional

Publication date

publisher string Optional

Publisher name

maxLength: 300 bytes

url string uri Optional

URL to the published version

volume string Optional

Volume number

maxLength: 50 bytes

View raw schema

{
  "description": "Link to the published version (Version of Record)",
  "properties": {
    "accessType": {
      "description": "Open access status",
      "knownValues": [
        "open_access",
        "green_oa",
        "gold_oa",
        "hybrid_oa",
        "bronze_oa",
        "closed"
      ],
      "type": "string"
    },
    "articleNumber": {
      "description": "Article number",
      "maxLength": 50,
      "type": "string"
    },
    "doi": {
      "description": "DOI of the published version (e.g., 10.1234/example)",
      "type": "string"
    },
    "eLocationId": {
      "description": "Electronic location ID for online-only journals",
      "type": "string"
    },
    "issue": {
      "description": "Issue number",
      "maxLength": 50,
      "type": "string"
    },
    "journal": {
      "description": "Journal name",
      "maxLength": 500,
      "type": "string"
    },
    "journalAbbreviation": {
      "description": "Journal abbreviation",
      "maxLength": 100,
      "type": "string"
    },
    "journalIssn": {
      "description": "Journal ISSN",
      "type": "string"
    },
    "licenseUrl": {
      "description": "License URL",
      "format": "uri",
      "type": "string"
    },
    "pages": {
      "description": "Page range",
      "maxLength": 50,
      "type": "string"
    },
    "publishedAt": {
      "description": "Publication date",
      "format": "datetime",
      "type": "string"
    },
    "publisher": {
      "description": "Publisher name",
      "maxLength": 300,
      "type": "string"
    },
    "url": {
      "description": "URL to the published version",
      "format": "uri",
      "type": "string"
    },
    "volume": {
      "description": "Volume number",
      "maxLength": 50,
      "type": "string"
    }
  },
  "type": "object"
}

relatedWork object

A related work with DataCite-compatible relation type

Properties

description string Optional

Description of the relation

identifier string Required

Identifier value

identifierType string Required

Type of identifier

Known values: doi, arxiv, pmid, pmcid, url, urn, handle, isbn, issn, at-uri

relationType string Required

DataCite-compatible relation type

Known values: isPreprintOf, hasPreprint, isVersionOf, hasVersion, isNewVersionOf, isPreviousVersionOf, isPartOf, hasPart, references, isReferencedBy, isSupplementTo, isSupplementedBy, isContinuedBy, continues, isDocumentedBy, documents, isCompiledBy, compiles, isVariantFormOf, isOriginalFormOf, isIdenticalTo, isReviewedBy, reviews, isDerivedFrom, isSourceOf, isRequiredBy, requires, isObsoletedBy, obsoletes

title string Optional

Title of the related work

View raw schema

{
  "description": "A related work with DataCite-compatible relation type",
  "properties": {
    "description": {
      "description": "Description of the relation",
      "type": "string"
    },
    "identifier": {
      "description": "Identifier value",
      "type": "string"
    },
    "identifierType": {
      "description": "Type of identifier",
      "knownValues": [
        "doi",
        "arxiv",
        "pmid",
        "pmcid",
        "url",
        "urn",
        "handle",
        "isbn",
        "issn",
        "at-uri"
      ],
      "type": "string"
    },
    "relationType": {
      "description": "DataCite-compatible relation type",
      "knownValues": [
        "isPreprintOf",
        "hasPreprint",
        "isVersionOf",
        "hasVersion",
        "isNewVersionOf",
        "isPreviousVersionOf",
        "isPartOf",
        "hasPart",
        "references",
        "isReferencedBy",
        "isSupplementTo",
        "isSupplementedBy",
        "isContinuedBy",
        "continues",
        "isDocumentedBy",
        "documents",
        "isCompiledBy",
        "compiles",
        "isVariantFormOf",
        "isOriginalFormOf",
        "isIdenticalTo",
        "isReviewedBy",
        "reviews",
        "isDerivedFrom",
        "isSourceOf",
        "isRequiredBy",
        "requires",
        "isObsoletedBy",
        "obsoletes"
      ],
      "type": "string"
    },
    "title": {
      "description": "Title of the related work",
      "type": "string"
    }
  },
  "required": [
    "identifier",
    "identifierType",
    "relationType"
  ],
  "type": "object"
}

repositories object

Linked code, data, and materials repositories

Properties

code array of ref#codeRepository Optional

Code repositories

maxLength: 10 items

data array of ref#dataRepository Optional

Data repositories

maxLength: 20 items

materials array of ref#material Optional

Physical materials, reagents, plasmids, etc.

maxLength: 20 items

preregistration ref #preregistration Optional

Pre-registration or registered report link

protocols array of ref#protocol Optional

Protocol links

maxLength: 10 items

View raw schema

{
  "description": "Linked code, data, and materials repositories",
  "properties": {
    "code": {
      "description": "Code repositories",
      "items": {
        "ref": "#codeRepository",
        "type": "ref"
      },
      "maxLength": 10,
      "type": "array"
    },
    "data": {
      "description": "Data repositories",
      "items": {
        "ref": "#dataRepository",
        "type": "ref"
      },
      "maxLength": 20,
      "type": "array"
    },
    "materials": {
      "description": "Physical materials, reagents, plasmids, etc.",
      "items": {
        "ref": "#material",
        "type": "ref"
      },
      "maxLength": 20,
      "type": "array"
    },
    "preregistration": {
      "description": "Pre-registration or registered report link",
      "ref": "#preregistration",
      "type": "ref"
    },
    "protocols": {
      "description": "Protocol links",
      "items": {
        "ref": "#protocol",
        "type": "ref"
      },
      "maxLength": 10,
      "type": "array"
    }
  },
  "type": "object"
}

semanticVersion object

Semantic version following MAJOR.MINOR.PATCH

Properties

major integer Required

Major version for fundamental revisions or breaking changes

minimum: 1

minor integer Required

Minor version for new content or significant additions

minimum: 0

patch integer Required

Patch version for corrections, typo fixes, formatting

minimum: 0

prerelease string Optional

Pre-release identifier (e.g., draft, rc1)

maxLength: 20 bytes

View raw schema

{
  "description": "Semantic version following MAJOR.MINOR.PATCH",
  "properties": {
    "major": {
      "description": "Major version for fundamental revisions or breaking changes",
      "minimum": 1,
      "type": "integer"
    },
    "minor": {
      "description": "Minor version for new content or significant additions",
      "minimum": 0,
      "type": "integer"
    },
    "patch": {
      "description": "Patch version for corrections, typo fixes, formatting",
      "minimum": 0,
      "type": "integer"
    },
    "prerelease": {
      "description": "Pre-release identifier (e.g., draft, rc1)",
      "maxLength": 20,
      "type": "string"
    }
  },
  "required": [
    "major",
    "minor",
    "patch"
  ],
  "type": "object"
}

supplementaryItem object

A supplementary material item with metadata

Properties

blob blob Required

Supplementary file blob reference

maxSize: 104.9 MB

categorySlug ref pub.chive.defs#supplementaryCategory Optional

Category slug for display fallback

categoryUri string at-uri Optional

AT-URI to supplementary category node (subkind=supplementary-category)

description string Optional

Description of the supplementary material

maxLength: 1000 bytes

detectedFormat string Optional

Auto-detected file format

label string Required

User-provided label (e.g., 'Appendix A', 'Figure S1')

maxLength: 200 bytes

order integer Optional

Display order (1-indexed)

minimum: 1

View raw schema

{
  "description": "A supplementary material item with metadata",
  "properties": {
    "blob": {
      "description": "Supplementary file blob reference",
      "maxSize": 104857600,
      "type": "blob"
    },
    "categorySlug": {
      "description": "Category slug for display fallback",
      "ref": "pub.chive.defs#supplementaryCategory",
      "type": "ref"
    },
    "categoryUri": {
      "description": "AT-URI to supplementary category node (subkind=supplementary-category)",
      "format": "at-uri",
      "type": "string"
    },
    "description": {
      "description": "Description of the supplementary material",
      "maxLength": 1000,
      "type": "string"
    },
    "detectedFormat": {
      "description": "Auto-detected file format",
      "type": "string"
    },
    "label": {
      "description": "User-provided label (e.g., 'Appendix A', 'Figure S1')",
      "maxLength": 200,
      "type": "string"
    },
    "order": {
      "description": "Display order (1-indexed)",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "blob",
    "label"
  ],
  "type": "object"
}