pub.chive.eprint.changelog

chive.pub

Documentation

Structured changelog entry for eprint version

main record

Structured changelog entry for eprint version

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When this changelog was created

eprintUri string at-uri Required

URI of the eprint this changelog belongs to

reviewerResponse string Optional

Response to peer review feedback (if applicable)

maxLength: 10000 bytes
schemaRevision integer Optional

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

minimum: 1
sections array of ref #changelogSection Required

Structured changelog sections

maxLength: 20 items
summary string Optional

One-line summary of changes

maxLength: 500 bytes
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "eprintUri",
      "version",
      "sections",
      "createdAt"
    ],
    "properties": {
      "summary": {
        "type": "string",
        "maxLength": 500,
        "description": "One-line summary of changes"
      },
      "version": {
        "ref": "pub.chive.eprint.submission#semanticVersion",
        "type": "ref",
        "description": "Semantic version this changelog describes"
      },
      "sections": {
        "type": "array",
        "items": {
          "ref": "#changelogSection",
          "type": "ref"
        },
        "maxLength": 20,
        "description": "Structured changelog sections"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When this changelog was created"
      },
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "URI of the eprint this changelog belongs to"
      },
      "schemaRevision": {
        "type": "integer",
        "minimum": 1,
        "description": "Schema revision this record was created with. Absent means revision 1."
      },
      "previousVersion": {
        "ref": "pub.chive.eprint.submission#semanticVersion",
        "type": "ref",
        "description": "Previous semantic version"
      },
      "reviewerResponse": {
        "type": "string",
        "maxLength": 10000,
        "description": "Response to peer review feedback (if applicable)"
      }
    }
  },
  "description": "Structured changelog entry for eprint version"
}
changeItem object

Individual change entry

Properties

changeType string Optional

Type of change

Known values: added, changed, removed, fixed, deprecated
description string Required

Description of the change

maxLength: 2000 bytes
location string Optional

Location in document (e.g., Section 3.2, Figure 5)

maxLength: 100 bytes
reviewReference string Optional

Reference to reviewer comment being addressed

maxLength: 200 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "description"
  ],
  "properties": {
    "location": {
      "type": "string",
      "maxLength": 100,
      "description": "Location in document (e.g., Section 3.2, Figure 5)"
    },
    "changeType": {
      "type": "string",
      "description": "Type of change",
      "knownValues": [
        "added",
        "changed",
        "removed",
        "fixed",
        "deprecated"
      ]
    },
    "description": {
      "type": "string",
      "maxLength": 2000,
      "description": "Description of the change"
    },
    "reviewReference": {
      "type": "string",
      "maxLength": 200,
      "description": "Reference to reviewer comment being addressed"
    }
  },
  "description": "Individual change entry"
}
changelogSection object

A section of changes grouped by category

Properties

category string Required

Category of changes (kebab-case per ATProto style guide)

Known values: methodology, results, analysis, discussion, conclusions, data, figures, tables, references, supplementary-materials, corrections, formatting, language-editing, acknowledgments, authorship, other
items array of ref#changeItem Required

Individual change items in this section

maxLength: 50 items
View raw schema 
{
  "type": "object",
  "required": [
    "category",
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "#changeItem",
        "type": "ref"
      },
      "maxLength": 50,
      "description": "Individual change items in this section"
    },
    "category": {
      "type": "string",
      "description": "Category of changes (kebab-case per ATProto style guide)",
      "knownValues": [
        "methodology",
        "results",
        "analysis",
        "discussion",
        "conclusions",
        "data",
        "figures",
        "tables",
        "references",
        "supplementary-materials",
        "corrections",
        "formatting",
        "language-editing",
        "acknowledgments",
        "authorship",
        "other"
      ]
    }
  },
  "description": "A section of changes grouped by category"
}

Lexicon Garden

@