---
title: "ApiProductDocument"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550/schemas/APIProductDocument"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550.md

# ApiProductDocument

an api product document

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Products
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    ChildNode:
      type: object
      discriminator:
        propertyName: type
      oneOf:
        - $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"
    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
    HeadingBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - heading
        level:
          description: Level of the heading which maps to HTML <h> tag
          type: number
          maximum: 6
          minimum: 1
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    BlockQuoteBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - blockquote
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    ParagraphBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - paragraph
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    TextBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - text_block
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    BreakBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - break
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    CodeBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - code_block
        lang:
          type: string
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    ListBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - list
        isOrdered:
          description: Defines if the list is ordered or not
          type: boolean
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    ListItemBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - list_item
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Text:
      type: object
      properties:
        type:
          type: string
          enum:
            - text
        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
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Emphasis:
      type: object
      properties:
        type:
          type: string
          enum:
            - emphasis
        level:
          description: |
            Level of emphasis
            1 - italic
            2 - bold
          type: number
          maximum: 2
          minimum: 1
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Code:
      type: object
      properties:
        type:
          type: string
          enum:
            - code
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    Link:
      type: object
      properties:
        type:
          type: string
          enum:
            - link
        href:
          description: Target url of the link
          type: string
        title:
          description: Title of the link
          type: string
      required:
        - type
    Image:
      type: object
      properties:
        type:
          type: string
          enum:
            - image
        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
      required:
        - type
    StrikeThrough:
      type: object
      properties:
        type:
          type: string
          enum:
            - strikethrough
      required:
        - type
    TableBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table
        alignments:
          $ref: "#/components/schemas/TableAlignments"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
        - alignments
    TableHeaderBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table_header
        alignments:
          $ref: "#/components/schemas/TableAlignments"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
        - alignments
    TableCellBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table_cell
        alignment:
          $ref: "#/components/schemas/AlignmentKind"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
    TableRowBlock:
      type: object
      properties:
        type:
          type: string
          enum:
            - table_row
        alignments:
          $ref: "#/components/schemas/TableAlignments"
        children:
          $ref: "#/components/schemas/NodeChildren"
      required:
        - type
        - alignments
    TaskCheckbox:
      type: object
      properties:
        type:
          type: string
          enum:
            - task_checkbox
        checked:
          description: State of the checkbox
          type: boolean
      required:
        - checked
        - type
    NodeChildren:
      description: List of children nodes of the current node
      type: array
      items:
        $ref: "#/components/schemas/ChildNode"
    TableAlignments:
      type: array
      items:
        $ref: "#/components/schemas/AlignmentKind"
      nullable: true
    AlignmentKind:
      type: string
      enum:
        - left
        - right
        - center
        - none
    APIProductDocument:
      description: an api product document
      type: object
      properties:
        id:
          type: string
          format: uuid
        parent_document_id:
          type: string
          format: uuid
          nullable: true
        title:
          type: string
        slug:
          type: string
        status:
          type: string
          enum:
            - unpublished
            - published
        metadata:
          type: object
        content:
          description: The unencoded markdown string of the api product document.
          type: string
        ast:
          type: array
          items:
            $ref: "#/components/schemas/ChildNode"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - parent_document_id
        - title
        - slug
        - status
        - metadata
        - content
        - ast
        - updated_at
        - created_at
      title: ApiProductDocument
```
