---
title: "Update the document"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-0/versions/eaee49c0-67ee-4e12-b121-f29cae48c1a7/operations/updateDocument"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-documenthub-admin-api-0/versions/eaee49c0-67ee-4e12-b121-f29cae48c1a7.md

# Update the document

`PUT` `/{resourceKind}/{resourceId}/documents/{documentId}`

Operation ID: `updateDocument`

Update the document

## Path parameters

- `resourceKind` (string, required) - Kind of the Konnect resource
- `resourceId` (string, uuid, required) - Id of the Konnect resource
- `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
  version: 0.0.1
servers:
  - url: http://documenthub.documenthub.svc.cluster.local:4400/v0
    description: Konnect cluster
paths:
  /{resourceKind}/{resourceId}/documents/{documentId}:
    put:
      operationId: updateDocument
      summary: Update the document
      description: Update the document
      parameters:
        - $ref: "#/components/parameters/resourceKind"
        - $ref: "#/components/parameters/resourceId"
        - $ref: "#/components/parameters/documentId"
      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:
        - Customization
security:
  - bearerAuth: []
components:
  parameters:
    resourceKind:
      name: resourceKind
      in: path
      required: true
      description: Kind of the Konnect resource
      example: services
      schema:
        type: string
        enum:
          - services
    resourceId:
      name: resourceId
      in: path
      required: true
      description: Id of the Konnect resource
      example: bf138ba2-c9b1-4229-b268-04d9d8a6410b
      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
        status:
          $ref: "#/components/schemas/PublishStatus"
        parent_document_id:
          type: string
          format: uuid
          example: dd4e1b98-3629-4dd3-acc0-759a726ffee2
          nullable: true
        slug:
          $ref: "#/components/schemas/Slug"
        created_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
        modified_at:
          type: string
          format: date-time
          example: 2023-01-11T02:30:42.227Z
        revision:
          $ref: "#/components/schemas/Revision"
      required:
        - id
        - parent_document_id
        - slug
        - revision
        - status
        - modified_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:
          type: object
          nullable: true
      title: UpdateDocumentPayload
    PublishStatus:
      type: string
      enum:
        - published
        - unpublished
    Slug:
      description: document slug
      type: string
      example: path-for-seo
      maxLength: 80
      pattern: ^[\w-]+$
    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:
          type: object
          example:
            author: John Doe
        title:
          type: string
          example: Hello world
        raw_md_content:
          description: raw markdown content
          type: string
          format: byte
          example: I0ludHJvZHVjdGlvbg==
        str_md_content:
          description: markdown content
          type: string
          example: "## My Markdown"
        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
    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
    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
    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"
    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
    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"
    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:
      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
    TableAlignments:
      type: object
      properties:
        alignments:
          type: array
          items:
            $ref: "#/components/schemas/AlignmentKind"
          nullable: true
      required:
        - alignments
    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:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
```
