---
title: "BlockNode"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-0/versions/e30c6169-1eab-485d-8526-f80b29f34b35/schemas/BlockNode"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-0/versions/e30c6169-1eab-485d-8526-f80b29f34b35.md

# BlockNode

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal DocumentHub Developer Api
  version: 0.0.1
servers:
  - url: http://documenthub.documenthub.svc.cluster.local:4400/developer/v0
    description: Konnect cluster
components:
  schemas:
    BaseNode:
      type: object
      properties:
        type:
          type: string
      required:
        - type
    AnyNode:
      discriminator:
        propertyName: type
        mapping:
          document: "#/components/schemas/DocumentBlock"
          heading: "#/components/schemas/HeadingBlock"
          blockquote: "#/components/schemas/BlockQuoteBlock"
          paragraph: "#/components/schemas/ParagraphBlock"
          text_block: "#/components/schemas/TextBlock"
          break: "#/components/schemas/BreakBlock"
          code_block: "#/components/schemas/CodeBlock"
          list: "#/components/schemas/ListBlock"
          list_item: "#/components/schemas/ListItemBlock"
          text: "#/components/schemas/Text"
          emphasis: "#/components/schemas/Emphasis"
          code: "#/components/schemas/Code"
          link: "#/components/schemas/Link"
          image: "#/components/schemas/Image"
          strikethrough: "#/components/schemas/StrikeThrough"
          task_checkbox: "#/components/schemas/TaskCheckbox"
          table: "#/components/schemas/TableBlock"
          table_header: "#/components/schemas/TableHeaderBlock"
          table_cell: "#/components/schemas/TableCellBlock"
          table_row: "#/components/schemas/TableRowBlock"
      oneOf:
        - $ref: "#/components/schemas/DocumentBlock"
        - $ref: "#/components/schemas/HeadingBlock"
        - $ref: "#/components/schemas/BlockQuoteBlock"
        - $ref: "#/components/schemas/ParagraphBlock"
        - $ref: "#/components/schemas/TextBlock"
        - $ref: "#/components/schemas/BreakBlock"
        - $ref: "#/components/schemas/CodeBlock"
        - $ref: "#/components/schemas/ListBlock"
        - $ref: "#/components/schemas/ListItemBlock"
        - $ref: "#/components/schemas/Text"
        - $ref: "#/components/schemas/Emphasis"
        - $ref: "#/components/schemas/Code"
        - $ref: "#/components/schemas/Link"
        - $ref: "#/components/schemas/Image"
        - $ref: "#/components/schemas/StrikeThrough"
        - $ref: "#/components/schemas/TableBlock"
        - $ref: "#/components/schemas/TableHeaderBlock"
        - $ref: "#/components/schemas/TableCellBlock"
        - $ref: "#/components/schemas/TableRowBlock"
        - $ref: "#/components/schemas/TaskCheckbox"
    DocumentBlock:
      description: content of the document
      example:
        type: doc
        content:
          - type: paragraph
            content:
              - text: Hello World
                type: text
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - type: object
          properties:
            version:
              type: string
    HeadingBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - type: object
          properties:
            level:
              description: Level of the heading which maps to HTML <h> tag
              type: number
              maximum: 6
              minimum: 1
    BlockQuoteBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
    ParagraphBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
    TextBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
    BreakBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
    CodeBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - type: object
          properties:
            lang:
              type: string
    ListBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - type: object
          properties:
            isOrdered:
              description: Defines if the list is ordered or not
              type: boolean
    ListItemBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
    Text:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
        - $ref: "#/components/schemas/BlockNode"
        - type: object
          properties:
            text:
              type: string
            hardBreak:
              description: >
                If this property is true the end of this block should

                be a carriage return and not concatenated to the next Text
                block.
              type: boolean
            softBreak:
              description: >
                If this property is true the end of this block should should be

                concatenated with a space caracter before the next block. This
                is

                the flag showing that the parsed markdown block was at the end
                of

                the line.
              type: boolean
    Emphasis:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
        - $ref: "#/components/schemas/BlockNode"
        - type: object
          properties:
            level:
              description: |
                Level of emphasis
                1 - italic
                2 - bold
              type: number
              maximum: 2
              minimum: 1
    Code:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
        - $ref: "#/components/schemas/BlockNode"
    Link:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
        - type: object
          properties:
            href:
              description: Target url of the link
              type: string
            title:
              description: Title of the link
              type: string
    Image:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
        - type: object
          properties:
            url:
              description: Url of the image
              type: string
            alt:
              description: Alternate tag of the image
              type: string
            title:
              description: Title of the image
              type: string
    StrikeThrough:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
    TableBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - $ref: "#/components/schemas/TableAlignments"
    TableHeaderBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - $ref: "#/components/schemas/TableAlignments"
    TableCellBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - type: object
          properties:
            alignment:
              $ref: "#/components/schemas/AlignmentKind"
    TableRowBlock:
      allOf:
        - $ref: "#/components/schemas/BlockNode"
        - $ref: "#/components/schemas/TableAlignments"
    TaskCheckbox:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
        - type: object
          properties:
            checked:
              description: State of the checkbox
              type: boolean
          required:
            - checked
    BlockNode:
      allOf:
        - $ref: "#/components/schemas/BaseNode"
        - type: object
          properties:
            children:
              description: List of children nodes of the current node
              type: array
              items:
                $ref: "#/components/schemas/AnyNode"
    TableAlignments:
      type: object
      properties:
        alignments:
          type: array
          items:
            $ref: "#/components/schemas/AlignmentKind"
          nullable: true
      required:
        - alignments
    AlignmentKind:
      type: string
      enum:
        - left
        - right
        - center
        - none
```
