---
title: "API Document"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6/schemas/ApiDocument"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-catalog-3/versions/b74d7c76-ffb8-4e47-b70c-11184b8918a6.md

# API Document

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Catalog
  version: 3.1.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
components:
  schemas:
    ApiDocumentId:
      description: The API document identifier.
      type: string
      format: uuid
      example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb
      readOnly: true
      title: API Document ID
    ApiDocumentContent:
      description: Raw markdown content to display in your Portal
      type: string
      title: API Document Content
    ApiDocumentTitle:
      description: The title of the document. Used to populate the `<title>` tag for
        the page
      type: string
      example: API Document
      title: API Document Title
    ApiDocumentSlug:
      description: |
        The `slug` is used in generated URLs to provide human readable paths.

        Defaults to `slugify(title)`
      type: string
      example: api-document
      pattern: ^[\w-]+$
      title: API Document Slug
    ApiDocumentStatus:
      description: If `status=published` the document will be visible in your live portal
      type: string
      default: unpublished
      enum:
        - published
        - unpublished
    ApiDocumentParentDocumentId:
      description: >
        API Documents may be rendered as a tree of files.


        Specify the `id` of another API Document as the `parent_document_id` to
        add some heirarchy do your documents.
      type: string
      format: uuid
      example: null
      nullable: true
      title: API Document Parent Document ID
    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
    ApiDocument:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/ApiDocumentId"
        content:
          $ref: "#/components/schemas/ApiDocumentContent"
        title:
          $ref: "#/components/schemas/ApiDocumentTitle"
        slug:
          $ref: "#/components/schemas/ApiDocumentSlug"
        status:
          $ref: "#/components/schemas/ApiDocumentStatus"
        parent_document_id:
          $ref: "#/components/schemas/ApiDocumentParentDocumentId"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      title: API Document
```
