Compare document versions | Grist Octri Preview

4 parameters

docIdstringrequired

A string id (UUID)

leftstringoptional

Hash of the left version to compare (defaults to HEAD)

rightstringoptional

Hash of the right version to compare (defaults to HEAD)

maxRowsintegeroptional

Maximum number of row changes to include in details

2 status codes

200Comparison result

detailsobjectoptional

Detailed change information (when requested)

leftobjectrequired

Left/local document state

parentobjectrequired

Most recent common ancestor state

rightobjectrequired

Right/remote document state

summarystringrequired

Relationship summary: - same: documents have the same most recent state - left: the left document has actions not yet in the right - right: the right document has actions not yet in the left - both: both documents have changes (possible divergence) - unrelated: no common history found

Allowed:sameleftrightbothunrelated

403Insufficient access to compare documents

Error handling

A 403 is returned: Insufficient access to compare documents.

import { GristFullAPIOctriPreview } from "grist-octri-preview-sdk";

const client = new GristFullAPIOctriPreview({
  baseUrl: "https://docs.getgrist.com/api",
  auth: { apiKey: process.env.API_TOKEN! },
});

const result = await client.docs.compareVersions({ docId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "left": {
    "h": "example_value",
    "n": 1
  },
  "parent": {
    "h": "example_value",
    "n": 1
  },
  "right": {
    "h": "example_value",
    "n": 1
  },
  "summary": "same"
}

Request

Response

Errors