---
title: "Internal DocumentHub Developer Api"
url: "https://nov18-dev.movespot.fyi/apis/internal-documenthub-developer-api-0/versions/e30c6169-1eab-485d-8526-f80b29f34b35"
---

# Internal DocumentHub Developer Api

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal DocumentHub Developer Api","description":"DocumentHub Developer Api","version":"0.0.1","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"http://documenthub.documenthub.svc.cluster.local:4400/developer/v0","description":"Konnect cluster"}],"paths":{"/{resourceKind}/{resourceId}/documents":{"get":{"operationId":"getManyDocuments","summary":"Get many documents","description":"Get many documents","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentContentTypeEnum"}},{"$ref":"#/components/parameters/resourceKindParam"},{"$ref":"#/components/parameters/resourceId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"description":"Tree of documents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDocumentsPortal"}},"application/vnd.konnect.document-tree+json":{"schema":{"$ref":"#/components/schemas/ListDocumentsTree"}},"text/markdown":{"schema":{"description":"the markdown content","type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["Customization"]}},"/{resourceKind}/{resourceId}/documents/tree":{"get":{"operationId":"getDocumentTree","summary":"Get Document Tree","description":"get the document tree","parameters":[{"$ref":"#/components/parameters/resourceKindParam"},{"$ref":"#/components/parameters/resourceId"}],"responses":{"200":{"description":"Tree of documents","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTree"}}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Customization"]}},"/{resourceKind}/{resourceId}/documents/{documentId}":{"get":{"operationId":"getDocumentById","summary":"Get Document by ID","description":"get the document by its id","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentFormatContentTypeEnum"}},{"$ref":"#/components/parameters/resourceKindParam"},{"$ref":"#/components/parameters/resourceId"},{"$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"}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Customization"]}},"/{resourceKind}/{resourceId}/documents/slug/{slug}":{"get":{"operationId":"getDocumentBySlug","summary":"Get Document by Slug","description":"get the document by its slug","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentFormatContentTypeEnum"}},{"$ref":"#/components/parameters/resourceKindParam"},{"$ref":"#/components/parameters/resourceId"},{"name":"slug","in":"path","description":"slug of the document","required":true,"schema":{"type":"string"},"example":"getting-started"}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRaw"}},"application/vnd.konnect.document-nodes+json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Customization"]}},"/has-documentation":{"post":{"operationId":"has-documentation","summary":"Has documentation","description":"Returns whether the resourceKind resourceId pairs has documentation","requestBody":{"$ref":"#/components/requestBodies/HasDocumentation"},"responses":{"200":{"description":"Has Documentation response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HasDocumentationResponse"}}}}}}}},"components":{"parameters":{"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}},"resourceId":{"name":"resourceId","in":"path","required":true,"description":"Id of the Konnect resource","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"type":"string","format":"uuid"}},"resourceKindParam":{"name":"resourceKind","in":"path","required":true,"description":"Kind of the Konnect resource","example":"services","schema":{"type":"string","enum":["services"]}}},"schemas":{"ResourceKind":{"type":"string","enum":["services"]},"HasDocumentationRequestPayload":{"type":"object","properties":{"resource_kind":{"$ref":"#/components/schemas/ResourceKind"},"resource_ids":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100,"minItems":1,"uniqueItems":true}},"required":["resource_kind","resource_ids"]},"HasDocumentationResponse":{"type":"array","items":{"$ref":"#/components/schemas/HasDocumentationItem"}},"HasDocumentationItem":{"type":"object","properties":{"resource_kind":{"type":"string"},"resource_id":{"type":"string","format":"uuid"},"has_documentation":{"type":"boolean"},"document_count":{"type":"integer"}},"required":["resource_kind","resource_id","has_documentation","document_count"]},"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"},"revision":{"$ref":"#/components/schemas/Revision"}},"required":["id","slug","revision"],"title":"Document"},"Revision":{"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":{"$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","document_id","content","meta","title"],"title":"Revision"},"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"}},"required":["id","slug","revision"],"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"},"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","document_id","content","meta","title"],"title":"Revision"},"DocumentContentTypeEnum":{"type":"string","default":"application/json","enum":["application/json","application/vnd.konnect.document-tree+json"]},"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"},"DocumentItemPortal":{"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"}},"additionalProperties":false,"required":["id","parent_document_id","slug","title"],"title":"Document item"},"ListDocumentsPortal":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentItemPortal"}}},"additionalProperties":false,"required":["meta","data"]},"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"},"meta":{"description":"the metadata of the document","type":"object","example":{"author":"Jane Doe","description":"This is a description","keywords":"hello, world"}},"children":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTree"}}},"required":["id","title","slug","meta","children"],"title":"DocumentTree"},"ListDocumentsTree":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTree"}}},"required":["meta","data"]},"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"},"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"}}}]},"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"}}}]},"DocumentFormatContentTypeEnum":{"type":"string","default":"application/json","enum":["text/markdown","application/json","application/vnd.konnect.document-nodes+json"]},"BaseNode":{"type":"object","properties":{"type":{"type":"string"}},"required":["type"]},"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"}}}]},"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"}}}}]},"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\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"}}}]},"Emphasis":{"allOf":[{"$ref":"#/components/schemas/BaseNode"},{"$ref":"#/components/schemas/BlockNode"},{"type":"object","properties":{"level":{"description":"Level of emphasis\n1 - italic\n2 - bold\n","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"}]},"TaskCheckbox":{"allOf":[{"$ref":"#/components/schemas/BaseNode"},{"type":"object","properties":{"checked":{"description":"State of the checkbox","type":"boolean"}},"required":["checked"]}]},"AlignmentKind":{"type":"string","enum":["left","right","center","none"]},"TableAlignments":{"type":"object","properties":{"alignments":{"type":"array","items":{"$ref":"#/components/schemas/AlignmentKind"},"nullable":true}},"required":["alignments"]},"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"}]},"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"}]}},"examples":{"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"HasDocumentation":{"description":"has documentation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HasDocumentationRequestPayload"}}}}},"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"}}}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"tags":[{"name":"Customization","description":"customization operations"}],"security":[{"bearerAuth":[]}]}
```
