Skip to content
Ishvana Ishvana Docs

Compare Document Versions

GET
/api/writing/documents/{document_id}/versions/compare

Compare two document versions and return a structured diff.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
document_id
required
Document Id
string

Query Parameters

Section titled “Query Parameters ”
v1
required
V1

First version number

integer

First version number

v2
required
V2

Second version number

integer

Second version number

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

VersionComparisonResponse

Response for comparing two document versions.

object
documentId
required
Documentid
string
version1
required
VersionComparisonSide

Metadata for one side of a version comparison.

object
number
required
Number
integer
wordCount
Wordcount
integer
0
characterCount
Charactercount
integer
0
createdAt
Createdat
string
""
version2
required
VersionComparisonSide

Metadata for one side of a version comparison.

object
number
required
Number
integer
wordCount
Wordcount
integer
0
characterCount
Charactercount
integer
0
createdAt
Createdat
string
""
statistics
required
VersionComparisonStats

Statistics for a version comparison.

object
additions
Additions
integer
0
deletions
Deletions
integer
0
wordCountChange
Wordcountchange
integer
0
characterCountChange
Charactercountchange
integer
0
differences
required
Differences
Array<object>
VersionComparisonDiffLine

A single line in a version comparison diff.

object
type
required
Type

Line type: addition, deletion, or unchanged

string
content
required
Content

Line content

string
totalDifferences
Totaldifferences
integer
0

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object