---
title: "Document"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-v2-0/versions/de89c41a-3213-4ea1-ba03-774a702c2f4a/schemas/DocumentRaw"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-v2-0/versions/de89c41a-3213-4ea1-ba03-774a702c2f4a.md

# Document

a document

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal DocumentHub admin Api v2
  version: 0.0.2
servers:
  - url: http://documenthub.documenthub.svc.cluster.local:4400/v2
    description: Konnect cluster
components:
  schemas:
    PublishStatus:
      description: document publish status. Default to published.
      type: string
      enum:
        - published
        - unpublished
    RevisionRaw:
      description: revision of a document
      type: object
      properties:
        id:
          description: the id of the revision
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        document_id:
          description: the id of the document
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        content:
          description: Markdown document
          type: string
        metadata:
          $ref: "#/components/schemas/Metadata"
        title:
          description: the title of the document
          type: string
          example: Hello World
      required:
        - id
        - document_id
        - content
        - metadata
        - title
      title: Revision
    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
    Metadata:
      description: Contains key value pairs information about entity's metadata.
      type: object
      example:
        owner: John Appleseed
      additionalProperties: true
    DocumentRaw:
      description: a document
      type: object
      properties:
        id:
          description: the id of the document
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        parent_document_id:
          description: the id of the parent document
          type: string
          format: uuid
          example: dd4e1b98-3629-4dd3-acc0-759a726ffee2
          nullable: true
        slug:
          description: the slug of the document
          type: string
          example: getting-started
        status:
          $ref: "#/components/schemas/PublishStatus"
        revision:
          $ref: "#/components/schemas/RevisionRaw"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - slug
        - revision
        - status
        - created_at
        - updated_at
      title: Document
```
