---
title: "Internal DocumentHub Developer Api v2"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-v2-0/versions/c8b8112f-9ae4-40f3-b57a-26511040e856"
---

# Internal DocumentHub Developer Api v2

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal DocumentHub Developer Api v2","description":"DocumentHub developer Api","version":"0.0.2","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"http://documenthub.documenthub.svc.cluster.local:4400/developer/v2","description":"Konnect cluster"}],"paths":{"/collections/{collectionId}/documents":{"get":{"operationId":"listDocuments","summary":"List collection documents","description":"List documents in a collection","parameters":[{"$ref":"#/components/parameters/collectionId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter[field]","in":"query","description":"A field to filter on. Supported fields: slug, metadata.\n","schema":{"type":"string","example":"filter[name]=my-doc"}}],"responses":{"200":{"description":"Documents in the collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDocuments"}},"application/vnd.konnect.document-tree+json":{"schema":{"$ref":"#/components/schemas/ListDocumentsTree"}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Documents"]}},"/collections/{collectionId}/documents/slug":{"get":{"operationId":"getDocumentBySlug","summary":"Get a document by slug","description":"Get a document. Will be removed after","parameters":[{"$ref":"#/components/parameters/collectionId"},{"name":"slug","in":"query","description":"Unique slug of the document.","required":true,"schema":{"type":"string"},"example":"/about/company"}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRaw"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Documents"]}},"/collections/{collectionId}/documents/{documentId}":{"get":{"operationId":"getDocument","summary":"Get the document","description":"Get the document","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentFormatContentTypeEnum"}},{"$ref":"#/components/parameters/collectionId"},{"$ref":"#/components/parameters/documentId"}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRaw"}},"application/vnd.konnect.document-nodes+json":{"schema":{"$ref":"#/components/schemas/Document"}},"text/markdown":{"schema":{"description":"the markdown content","type":"string"}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Documents"]}}},"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"}},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}}},"schemas":{"ListDocumentsTree":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTree"}}},"required":["meta","data"]},"ListDocuments":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentItem"}}},"additionalProperties":false,"required":["meta","data"]},"DocumentItem":{"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"},"title":{"description":"the title of the document","type":"string","example":"Getting Started"},"metadata":{"$ref":"#/components/schemas/Metadata"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["id","parent_document_id","slug","title","metadata","created_at","updated_at"],"title":"Document item"},"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"},"revision":{"$ref":"#/components/schemas/RevisionRaw"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","slug","revision","created_at","updated_at"],"title":"Document"},"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"},"Document":{"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"},"content":{"$ref":"#/components/schemas/DocumentBlock"},"meta":{"description":"the metadata of the document","type":"object","example":{"title":"Hello World","description":"This is a description","keywords":"hello, world"}},"title":{"description":"the title of the document","type":"string","example":"Hello World"}},"required":["id","slug","meta","title","content"],"title":"Document"},"DocumentTree":{"description":"a document tree","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},"title":{"description":"the title of the document","type":"string","example":"Getting Started"},"slug":{"description":"the slug of the document","type":"string","example":"getting-started"},"metadata":{"$ref":"#/components/schemas/Metadata"},"children":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTree"}},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","title","slug","metadata","children","created_at","updated_at"],"title":"DocumentTree"},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"Metadata":{"description":"Contains key value pairs information about entity's metadata.","type":"object","example":{"owner":"John Appleseed"},"additionalProperties":true},"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},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","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\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"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"}}}]},"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},"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"]},"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},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"DocumentFormatContentTypeEnum":{"type":"string","default":"application/json","enum":["text/markdown","application/json","application/vnd.konnect.document-nodes+json"]},"NodeChildren":{"description":"List of children nodes of the current node","type":"array","items":{"$ref":"#/components/schemas/ChildNode"}},"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\nbe a carriage return and not concatenated to the next Text block.\n","type":"boolean"},"softBreak":{"description":"If this property is true the end of this block should should be\nconcatenated with a space caracter before the next block. This is\nthe flag showing that the parsed markdown block was at the end of\nthe line.\n","type":"boolean"},"children":{"$ref":"#/components/schemas/NodeChildren"}},"required":["type"]},"Emphasis":{"type":"object","properties":{"type":{"type":"string","enum":["emphasis"]},"level":{"description":"Level of emphasis\n1 - italic\n2 - bold\n","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"]},"AlignmentKind":{"type":"string","enum":["left","right","center","none"]},"TableAlignments":{"type":"array","items":{"$ref":"#/components/schemas/AlignmentKind"},"nullable":true},"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"]},"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"}]},"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"]}},"examples":{"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{},"responses":{"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}}},"securitySchemes":{"portalAccessToken":{"type":"apiKey","in":"cookie","name":"portalaccesstoken","description":"The Developer portal cookie is meant to be used by the Developer API to authenticate with.\n"}}},"tags":[{"name":"Documents","description":"document operations"}],"security":[{"portalAccessToken":[]}]}
```
