pub.chive.eprint.submission

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

Default: preprint

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

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "abstract",
      "document",
      "licenseSlug",
      "authors",
      "submittedBy",
      "createdAt"
    ],
    "properties": {
      "title": {
        "type": "string",
        "maxLength": 500,
        "description": "Eprint title"
      },
      "authors": {
        "type": "array",
        "items": {
          "ref": "pub.chive.eprint.authorContribution",
          "type": "ref"
        },
        "maxLength": 100,
        "minLength": 1,
        "description": "All authors with contributions, affiliations, and metadata"
      },
      "funding": {
        "type": "array",
        "items": {
          "ref": "#fundingSource",
          "type": "ref"
        },
        "maxLength": 20,
        "description": "Funding sources and grants"
      },
      "version": {
        "ref": "#semanticVersion",
        "type": "ref",
        "description": "Semantic version of this eprint"
      },
      "abstract": {
        "type": "array",
        "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,
        "description": "Rich abstract with text, formatting, and entity references"
      },
      "document": {
        "type": "blob",
        "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"
        ],
        "maxSize": 52428800,
        "description": "Primary manuscript document (PDF, DOCX, HTML, Markdown, LaTeX, or Jupyter)"
      },
      "keywords": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 100
        },
        "maxLength": 20,
        "description": "Author-provided keywords"
      },
      "paperDid": {
        "type": "string",
        "format": "did",
        "description": "DID of the paper's own account (if paper has its own PDS)"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Creation timestamp"
      },
      "facetUris": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 30,
        "description": "Facet node references (subkind=facet)"
      },
      "fieldUris": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 10,
        "description": "Field node references (subkind=field)"
      },
      "titleRich": {
        "type": "array",
        "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,
        "description": "Rich title with formatting and entity references (for titles with LaTeX, etc.)"
      },
      "topicUris": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 20,
        "description": "Topic node references (subkind=topic)"
      },
      "licenseUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI to license node (subkind=license)"
      },
      "externalIds": {
        "ref": "#externalIds",
        "type": "ref",
        "description": "External persistent identifiers"
      },
      "licenseSlug": {
        "type": "string",
        "description": "SPDX license identifier for display fallback",
        "knownValues": [
          "CC-BY-4.0",
          "CC-BY-SA-4.0",
          "CC0-1.0",
          "MIT",
          "Apache-2.0"
        ]
      },
      "submittedBy": {
        "type": "string",
        "format": "did",
        "description": "DID of the human user who submitted this eprint"
      },
      "paperTypeUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI to paper type node (subkind=paper-type)"
      },
      "relatedWorks": {
        "type": "array",
        "items": {
          "ref": "#relatedWork",
          "type": "ref"
        },
        "maxLength": 50,
        "description": "Related eprints, datasets, software, and prior versions"
      },
      "repositories": {
        "ref": "#repositories",
        "type": "ref",
        "description": "Linked code, data, and materials repositories"
      },
      "paperTypeSlug": {
        "type": "string",
        "description": "Paper type slug for display fallback",
        "knownValues": [
          "original-research",
          "review",
          "meta-analysis",
          "case-study",
          "commentary",
          "tutorial",
          "survey"
        ]
      },
      "versionNumber": {
        "type": "integer",
        "minimum": 1,
        "description": "Legacy version number (1-indexed), deprecated in favor of semanticVersion"
      },
      "schemaRevision": {
        "type": "integer",
        "minimum": 1,
        "description": "Schema revision this record was created with. Absent means revision 1."
      },
      "previousVersion": {
        "type": "string",
        "format": "at-uri",
        "description": "Previous version URI"
      },
      "publishedVersion": {
        "ref": "#publishedVersion",
        "type": "ref",
        "description": "Link to the published version (Version of Record)"
      },
      "abstractPlainText": {
        "type": "string",
        "maxLength": 10000,
        "description": "Plain text abstract for search indexing (auto-generated)"
      },
      "documentFormatUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI to document format node (subkind=document-format)"
      },
      "documentFormatSlug": {
        "ref": "pub.chive.defs#documentFormat",
        "type": "ref",
        "description": "Document format slug for display fallback"
      },
      "publicationStatusUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI to publication status node (subkind=publication-status)"
      },
      "publicationStatusSlug": {
        "ref": "pub.chive.defs#publicationStatus",
        "type": "ref",
        "default": "preprint",
        "description": "Publication status slug for display fallback"
      },
      "conferencePresentation": {
        "ref": "#conferencePresentation",
        "type": "ref",
        "description": "Conference where this work was presented"
      },
      "supplementaryMaterials": {
        "type": "array",
        "items": {
          "ref": "#supplementaryItem",
          "type": "ref"
        },
        "maxLength": 50,
        "description": "Additional materials (appendices, data, code, figures)"
      }
    }
  },
  "description": "A scholarly eprint submission 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, software_heritage, colab, kaggle, other

platformUri string at-uri Optional

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

swhid string Optional

Software Heritage Identifier

url string uri Optional

Repository URL

View raw schema

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Repository URL"
    },
    "label": {
      "type": "string",
      "description": "User-provided label"
    },
    "swhid": {
      "type": "string",
      "description": "Software Heritage Identifier"
    },
    "archiveUrl": {
      "type": "string",
      "format": "uri",
      "description": "Software Heritage archive URL"
    },
    "platformUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI to platform node (subkind=platform-code)"
    },
    "platformSlug": {
      "type": "string",
      "description": "Platform slug for display fallback",
      "knownValues": [
        "github",
        "gitlab",
        "bitbucket",
        "huggingface",
        "paperswithcode",
        "codeberg",
        "sourcehut",
        "software_heritage",
        "colab",
        "kaggle",
        "other"
      ]
    }
  },
  "description": "A code repository link"
}

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

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

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)

url string uri Optional

Repository URL

View raw schema

{
  "type": "object",
  "properties": {
    "doi": {
      "type": "string",
      "description": "Dataset DOI"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Repository URL"
    },
    "label": {
      "type": "string",
      "description": "User-provided label"
    },
    "platformUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI to platform node (subkind=platform-data)"
    },
    "platformSlug": {
      "type": "string",
      "description": "Platform slug for display fallback",
      "knownValues": [
        "huggingface",
        "zenodo",
        "figshare",
        "dryad",
        "osf",
        "dataverse",
        "mendeley_data",
        "kaggle",
        "wandb",
        "other"
      ]
    },
    "accessStatement": {
      "type": "string",
      "description": "Data availability statement"
    }
  },
  "description": "A data repository link"
}

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

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

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

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

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

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

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

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

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

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

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

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

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

{
  "type": "object",
  "required": [
    "identifier",
    "identifierType",
    "relationType"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the related work"
    },
    "identifier": {
      "type": "string",
      "description": "Identifier value"
    },
    "description": {
      "type": "string",
      "description": "Description of the relation"
    },
    "relationType": {
      "type": "string",
      "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"
      ]
    },
    "identifierType": {
      "type": "string",
      "description": "Type of identifier",
      "knownValues": [
        "doi",
        "arxiv",
        "pmid",
        "pmcid",
        "url",
        "urn",
        "handle",
        "isbn",
        "issn",
        "at-uri"
      ]
    }
  },
  "description": "A related work with DataCite-compatible relation type"
}

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

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

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

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

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

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