---
title: "Update the document"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-v2-0/versions/de89c41a-3213-4ea1-ba03-774a702c2f4a/operations/updateDocument"
---

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

# Update the document

`PATCH` `/collections/{collectionId}/documents/{documentId}`

Operation ID: `updateDocument`

Update the document

## Path parameters

- `collectionId` (string, uuid, required) - Targeted collection
- `documentId` (string, uuid, required) - Targeted document

## Request body

Content types: `application/json`

## Responses

- `200` - The document has been updated
- `400` - Bad Request
- `404` - Not Found

## 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
paths:
  /collections/{collectionId}/documents/{documentId}:
    parameters:
      - $ref: "#/components/parameters/collectionId"
      - $ref: "#/components/parameters/documentId"
    patch:
      operationId: updateDocument
      summary: Update the document
      description: Update the document
      requestBody:
        $ref: "#/components/requestBodies/UpdateDocument"
      responses:
        "200":
          description: The document has been updated
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Document"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Documents
security:
  - konnectAccessToken: []
components:
  parameters:
    collectionId:
      name: collectionId
      in: path
      required: true
      description: Targeted collection
      example: bb84c46a-432d-4314-81e4-478614a52dcb
      schema:
        type: string
        format: uuid
    documentId:
      name: documentId
      in: path
      required: true
      description: Targeted document
      example: bb84c46a-432d-4314-81e4-478614a52dcb
      schema:
        type: string
        format: uuid
  requestBodies:
    UpdateDocument:
      description: document update
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/UpdateDocumentPayload"
  schemas:
    Document:
      description: a document
      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
        slug:
          $ref: "#/components/schemas/Slug"
        status:
          $ref: "#/components/schemas/PublishStatus"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        revision:
          $ref: "#/components/schemas/Revision"
      required:
        - id
        - parent_document_id
        - slug
        - revision
        - status
        - updated_at
        - created_at
      title: Document
    UpdateDocumentPayload:
      description: a document payload
      type: object
      properties:
        parent_document_id:
          description: >
            Parent document Id. If this value is explicitly set to null, the

            document will be put as a top level document at the bottom of the
            tree.
          type: string
          format: uuid
          example: dd4e1b98-3629-4dd3-acc0-759a726ffee2
          nullable: true
        slug:
          $ref: "#/components/schemas/Slug"
        status:
          $ref: "#/components/schemas/PublishStatus"
        title:
          description: document title
          type: string
          example: How to update a document in Konnect DocumentHub
        raw_content:
          description: base64 encoded string of the document content
          type: string
          format: byte
          example: YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
        str_md_content:
          description: markdown content
          type: string
          example: "## My Markdown"
        filename:
          description: name of the uploaded file
          type: string
          example: my_doc.md
        metadata:
          $ref: "#/components/schemas/MetadataNullable"
      title: UpdateDocumentPayload
    Slug:
      description: document slug
      type: string
      example: path-for-seo
      maxLength: 512
      pattern: ^[\w\/-]+$
    PublishStatus:
      description: document publish status. Default to published.
      type: string
      enum:
        - published
        - unpublished
    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
    Revision:
      description: revision of a document
      type: object
      properties:
        id:
          description: revision id
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
        document_id:
          description: document id
          type: string
          format: uuid
          example: 2272b454-4af6-4c56-8a02-d6145ac62e67
        content:
          $ref: "#/components/schemas/DocumentBlock"
        metadata:
          $ref: "#/components/schemas/Metadata"
        title:
          type: string
          example: Hello world
        raw_md_content:
          description: raw markdown content
          type: string
          format: byte
          example: I0ludHJvZHVjdGlvbg==
        file:
          description: file of the revision
          type: object
          properties:
            filename:
              type: string
              example: my_doc.md
            modified_at:
              type: string
              format: date-time
              example: 2023-01-11T02:30:42.227Z
          required:
            - filename
            - modified_at
      required:
        - content
        - document_id
        - id
        - metadata
        - title
        - file
      title: Revision
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    MetadataNullable:
      description: Contains key value pairs information about entity's metadata.
      type: object
      additionalProperties: true
      nullable: true
    DocumentBlock:
      description: content of the document
      type: object
      properties:
        type:
          type: string
          enum:
            - document
        version:
          type: string
        children:
          $ref: "#/components/schemas/NodeChildren"
      example:
        type: document
        content:
          - type: paragraph
            content:
              - text: Hello World
                type: text
      required:
        - type
    Metadata:
      description: Contains key value pairs information about entity's metadata.
      type: object
      example:
        owner: John Appleseed
      additionalProperties: true
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    NodeChildren:
      description: List of children nodes of the current node
      type: array
      items:
        $ref: "#/components/schemas/ChildNode"
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    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"
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      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
    TableAlignments:
      type: array
      items:
        $ref: "#/components/schemas/AlignmentKind"
      nullable: true
    AlignmentKind:
      type: string
      enum:
        - left
        - right
        - center
        - none
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
