---
title: "DocumentTree"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-0/versions/eaee49c0-67ee-4e12-b121-f29cae48c1a7/schemas/DocumentTree"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-0/versions/eaee49c0-67ee-4e12-b121-f29cae48c1a7.md

# DocumentTree

a document tree

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal DocumentHub admin Api
  version: 0.0.1
servers:
  - url: http://documenthub.documenthub.svc.cluster.local:4400/v0
    description: Konnect cluster
components:
  schemas:
    PublishStatus:
      type: string
      enum:
        - published
        - unpublished
    DocumentTree:
      description: a document tree
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        parent_document_id:
          type: string
          format: uuid
          example: dd4e1b98-3629-4dd3-acc0-759a726ffee2
          nullable: true
        title:
          type: string
        slug:
          description: document slug
          type: string
          example: path-for-seo
        metadata:
          description: metadata of the document
          type: object
          example:
            author: John Doe
        status:
          $ref: "#/components/schemas/PublishStatus"
        children:
          description: children of the document
          type: array
          items:
            $ref: "#/components/schemas/DocumentTree"
          example:
            - id: d32d905a-ed33-46a3-a093-d8f536af9a8a
              title: Hello world
              status: published
              slug: hello-world
              metadata:
                author: John Doe
              children: []
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - title
        - slug
        - metadata
        - children
        - status
        - created_at
        - updated_at
      title: DocumentTree
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
```
