Skip to content
Ishvana Ishvana Docs

Get Fork Tree

GET
/api/writing/documents/{document_id}/forks

Get the full fork tree for a document.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
document_id
required
Document Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

ForkTreeResponse

Full fork tree for a document. Main is virtual — rendered by frontend.

object
rootDocumentId
required
Rootdocumentid
string
rootTitle
required
Roottitle
string
rootWordCount
required
Rootwordcount
integer
branches
required
Branches
Array<object>
DocumentFork

Metadata for a single fork branch.

object
forkId
required
Forkid
string
rootDocumentId
required
Rootdocumentid
string
documentId
required
Documentid
string
parentForkId
required
Any of:
string
label
required
Label
string
status
required
ForkStatus

Status of a fork branch.

string
Allowed values: active archived
forkPointVersion
required
Any of:
integer
forkPointWordCount
required
Forkpointwordcount
integer
sortOrder
required
Sortorder
integer
wordCount
required
Wordcount
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
tree
required
Tree
Array<object>
ForkTreeNode

Recursive node in a fork tree.

object
fork
required
DocumentFork

Metadata for a single fork branch.

object
forkId
required
Forkid
string
rootDocumentId
required
Rootdocumentid
string
documentId
required
Documentid
string
parentForkId
required
Any of:
string
label
required
Label
string
status
required
ForkStatus

Status of a fork branch.

string
Allowed values: active archived
forkPointVersion
required
Any of:
integer
forkPointWordCount
required
Forkpointwordcount
integer
sortOrder
required
Sortorder
integer
wordCount
required
Wordcount
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
children
required
Array<object> recursive
hasForks
required
Hasforks
boolean

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