pub.chive.eprint.updateSubmission

chive.pub View official

Documentation

Update an eprint submission with a new version

main procedure

Update an eprint submission with a new version

Input

Encodingapplication/json
abstract array Optional

Updated rich abstract

maxLength: 100 items
authors array Optional

Updated authors with contributions, affiliations, and metadata

maxLength: 100 itemsminLength: 1 items
changelog ref#changelogInput Optional

Structured changelog for this update

document blob Optional

Updated document (if replacing)

maxSize: 52.4 MB
fieldUris array Optional

Updated field node references

maxLength: 10 items
funding array Optional

Funding sources

maxLength: 20 items
keywords array Optional

Updated keywords

maxLength: 20 items
title string Optional

Updated title

maxLength: 500 bytes
uri stringat-uri Required

AT-URI of the eprint to update

versionBump string Required

Type of version increment

Output

Encodingapplication/json
changelogUri stringat-uri Optional

URI of the created changelog record

expectedCid stringcid Required

CID of the current indexed version for optimistic concurrency control. The frontend should pass this to the PDS when updating; if the CID has changed, the PDS will reject the update to prevent race conditions.

uri stringat-uri Required

URI of the updated eprint

Errors

NotFound Eprint not found
Unauthorized User is not authorized to update this eprint
ValidationError Invalid update data
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema
{
  "description": "Update an eprint submission with a new version",
  "errors": [
    {
      "description": "Eprint not found",
      "name": "NotFound"
    },
    {
      "description": "User is not authorized to update this eprint",
      "name": "Unauthorized"
    },
    {
      "description": "Invalid update data",
      "name": "ValidationError"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "abstract": {
          "description": "Updated rich abstract",
          "items": {
            "refs": [
              "pub.chive.richtext.defs#textItem",
              "pub.chive.richtext.defs#nodeRefItem"
            ],
            "type": "union"
          },
          "maxLength": 100,
          "type": "array"
        },
        "authors": {
          "description": "Updated authors with contributions, affiliations, and metadata",
          "items": {
            "ref": "pub.chive.eprint.authorContribution",
            "type": "ref"
          },
          "maxLength": 100,
          "minLength": 1,
          "type": "array"
        },
        "changelog": {
          "description": "Structured changelog for this update",
          "ref": "#changelogInput",
          "type": "ref"
        },
        "conferencePresentation": {
          "description": "Conference presentation metadata",
          "ref": "pub.chive.eprint.submission#conferencePresentation",
          "type": "ref"
        },
        "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": "Updated document (if replacing)",
          "maxSize": 52428800,
          "type": "blob"
        },
        "externalIds": {
          "description": "External identifiers (arXiv, PubMed, SSRN, etc.)",
          "ref": "pub.chive.eprint.submission#externalIds",
          "type": "ref"
        },
        "fieldUris": {
          "description": "Updated field node references",
          "items": {
            "format": "at-uri",
            "type": "string"
          },
          "maxLength": 10,
          "type": "array"
        },
        "funding": {
          "description": "Funding sources",
          "items": {
            "ref": "pub.chive.eprint.submission#fundingSource",
            "type": "ref"
          },
          "maxLength": 20,
          "type": "array"
        },
        "keywords": {
          "description": "Updated keywords",
          "items": {
            "maxLength": 100,
            "type": "string"
          },
          "maxLength": 20,
          "type": "array"
        },
        "publishedVersion": {
          "description": "Published version metadata (journal, DOI, etc.)",
          "ref": "pub.chive.eprint.submission#publishedVersion",
          "type": "ref"
        },
        "repositories": {
          "description": "Code, data, and other repositories",
          "ref": "pub.chive.eprint.submission#repositories",
          "type": "ref"
        },
        "title": {
          "description": "Updated title",
          "maxLength": 500,
          "type": "string"
        },
        "uri": {
          "description": "AT-URI of the eprint to update",
          "format": "at-uri",
          "type": "string"
        },
        "versionBump": {
          "description": "Type of version increment",
          "knownValues": [
            "major",
            "minor",
            "patch"
          ],
          "type": "string"
        }
      },
      "required": [
        "uri",
        "versionBump"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "changelogUri": {
          "description": "URI of the created changelog record",
          "format": "at-uri",
          "type": "string"
        },
        "expectedCid": {
          "description": "CID of the current indexed version for optimistic concurrency control. The frontend should pass this to the PDS when updating; if the CID has changed, the PDS will reject the update to prevent race conditions.",
          "format": "cid",
          "type": "string"
        },
        "uri": {
          "description": "URI of the updated eprint",
          "format": "at-uri",
          "type": "string"
        },
        "version": {
          "description": "New semantic version",
          "ref": "pub.chive.eprint.submission#semanticVersion",
          "type": "ref"
        }
      },
      "required": [
        "uri",
        "version",
        "expectedCid"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}
changelogInput object

Changelog input for update operation

Properties

reviewerResponse string Optional

Response to peer review feedback

maxLength: 10000 bytes
summary string Optional

One-line summary of changes

maxLength: 500 bytes
View raw schema
{
  "description": "Changelog input for update operation",
  "properties": {
    "reviewerResponse": {
      "description": "Response to peer review feedback",
      "maxLength": 10000,
      "type": "string"
    },
    "sections": {
      "description": "Structured changelog sections",
      "items": {
        "ref": "pub.chive.eprint.changelog#changelogSection",
        "type": "ref"
      },
      "maxLength": 20,
      "type": "array"
    },
    "summary": {
      "description": "One-line summary of changes",
      "maxLength": 500,
      "type": "string"
    }
  },
  "type": "object"
}

Lexicon Garden

@