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

# Internal DocumentHub admin Api v2

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Internal DocumentHub admin Api v2","description":"DocumentHub admin Api","version":"0.0.2","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"http://documenthub.documenthub.svc.cluster.local:4400/v2","description":"Konnect cluster"}],"paths":{"/collections":{"get":{"operationId":"listCollections","summary":"List collections","description":"Create a document collection","parameters":[{"$ref":"#/components/parameters/SortCollections"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter","in":"query","description":"Filter documents returned in the response.","required":false,"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"name":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}}},"style":"deepObject"}],"responses":{"200":{"description":"The collection has been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCollectionResponse"}}}}},"tags":["Collections"]},"post":{"operationId":"createCollection","summary":"Create collection","description":"Create a document collection","requestBody":{"$ref":"#/components/requestBodies/CreateCollection"},"responses":{"201":{"description":"The collection has been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCollection"}}}},"400":{"$ref":"#/components/responses/BadRequest"}},"tags":["Collections"]}},"/collections/{collectionId}":{"parameters":[{"$ref":"#/components/parameters/collectionId"}],"get":{"operationId":"getCollection","summary":"Get document collection","description":"Get document collection","responses":{"200":{"description":"Document collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCollection"}}}},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Collections"]},"put":{"operationId":"putCollection","summary":"Create or Update collection","description":"Create or Update the document collection. collectionId must be globally unique. A collectionId of a different kind (service/portal) must not already exist.","requestBody":{"$ref":"#/components/requestBodies/PutCollection"},"responses":{"200":{"description":"The document collection has been updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCollection"}}}},"201":{"description":"The document collection has been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCollection"}}}},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Collections"]},"patch":{"operationId":"updateCollection","summary":"Update collection","description":"Update the document collection","requestBody":{"$ref":"#/components/requestBodies/UpdateCollection"},"responses":{"201":{"description":"The document collection has been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCollection"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Collections"]},"delete":{"operationId":"deleteCollection","summary":"Delete collection","description":"Delete the document collection","responses":{"204":{"description":"The document collection has been deleted"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Collections"]}},"/collections/{collectionId}/documents":{"parameters":[{"$ref":"#/components/parameters/collectionId"}],"get":{"operationId":"listDocuments","summary":"List collection documents","description":"List documents in a collection","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentContentTypeEnum"}},{"$ref":"#/components/parameters/SortDocuments"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"},{"name":"filter","in":"query","description":"Filter documents returned in the response.\n","required":false,"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UuidFieldFilter"},"slug":{"$ref":"#/components/schemas/StringFieldFilter"},"title":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"metadata":{"$ref":"#/components/schemas/StringFieldFilter"},"status":{"$ref":"#/components/schemas/PublishStatus"}}},"style":"deepObject"}],"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"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Documents"]},"post":{"operationId":"createDocument","summary":"Create document","description":"Create document and put it in a collection","requestBody":{"$ref":"#/components/requestBodies/CreateDocument"},"responses":{"201":{"description":"The document has been created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreationResponsePayload"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Documents"]}},"/collections/{collectionId}/documents/slug":{"get":{"operationId":"getDocumentBySlug","summary":"Get a document by slug","description":"Get a document","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}":{"parameters":[{"$ref":"#/components/parameters/collectionId"},{"$ref":"#/components/parameters/documentId"}],"get":{"operationId":"getDocument","summary":"Get the document","description":"Get the document","parameters":[{"name":"Accept","in":"header","schema":{"$ref":"#/components/schemas/DocumentFormatContentTypeEnum"}}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRaw"}},"application/parsed":{"schema":{"$ref":"#/components/schemas/DocumentParsed"}},"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"]},"delete":{"operationId":"deleteDocument","summary":"Delete the document","description":"Delete the document. \nReturns 404 if the document cannot be found, 409 if deleting the document would result in other orphaned documents.\n","responses":{"204":{"description":"The document has been deleted"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}},"tags":["Documents"]},"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"]}},"/collections/{collectionId}/documents/{documentId}/move":{"put":{"operationId":"moveDocument","summary":"Move a document","description":"This api allows the user to move a document within the document tree using the\nparameters parent_document_id and index. If parent_document_id is not\nprovided, the document will be placed at the top level of the document tree.\nindex represents a zero-indexed document order relative to its siblings under\nthe same parent. For example, if we want to put the document at top level in\nfirst position we would send parent_document_id: null and index: 0. This api\nalso supports using a negative index to count backwards from the end of the\ndocument list, which means you can put the document in last position by using\nindex: -1.\n","parameters":[{"$ref":"#/components/parameters/collectionId"},{"$ref":"#/components/parameters/documentId"}],"requestBody":{"$ref":"#/components/requestBodies/MoveDocument"},"responses":{"200":{"description":"The document has been moved"},"400":{"$ref":"#/components/responses/BadRequest"},"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}},"SortCollections":{"name":"sort","description":"Sorts a list of collections. Supported sort attributes are:\n  - created_at\n  - updated_at\n  - name\n","in":"query","required":false,"schema":{"type":"string"}},"SortDocuments":{"name":"sort","description":"Sorts a collection of documents. \nThe sort parameter is only applied for 'application/json' content-type.\nSupported sort attributes are:\n  - created_at\n  - updated_at\n  - slug\n  - title\n","in":"query","required":false,"schema":{"type":"string"}}},"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"},"filename":{"description":"the filename of the document","type":"string","example":"myDocument.md"},"status":{"$ref":"#/components/schemas/PublishStatus"},"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","filename","status","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"},"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"},"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"},"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"]},"ListCollectionResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PaginatedMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentCollection"}}},"required":["meta","data"]},"DocumentCollection":{"description":"a document collection","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string","example":"my document collection"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","name","created_at","updated_at"],"title":"Document Collection"},"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"},"DocumentParsed":{"type":"object","properties":{"content":{"items":{"type":"object","properties":{"text":{"type":"string"}},"required":["text"],"additionalProperties":false},"type":"array"}},"additionalProperties":false,"required":["content"]},"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":{"type":"string"},"filename":{"type":"string","example":"myDocument.md"},"slug":{"description":"document slug","type":"string","example":"path-for-seo"},"metadata":{"$ref":"#/components/schemas/Metadata"},"status":{"$ref":"#/components/schemas/PublishStatus"},"children":{"description":"children of the document","type":"array","items":{"$ref":"#/components/schemas/DocumentTree"},"example":[{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","title":"Hello world","filename":"myDocument.md","slug":"hello-world","status":"published","created_at":"2023-01-11T02:30:42.227Z","updated_at":"2023-01-11T02:30:42.227Z","metadata":{"author":"John Doe"},"children":[]}]},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","title","filename","slug","metadata","children","status","created_at","updated_at"],"title":"DocumentTree"},"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"},"CreateCollectionPayload":{"description":"payload to create the document collection","type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"CreateCollectionPayload"},"UpdateCollectionPayload":{"description":"payload to update the document collection","type":"object","properties":{"name":{"type":"string"}},"required":["name"],"title":"UpdateCollectionPayload"},"CreateDocumentPayload":{"description":"a document payload","type":"object","properties":{"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2"},"slug":{"$ref":"#/components/schemas/Slug"},"status":{"$ref":"#/components/schemas/PublishStatus"},"title":{"description":"document title","type":"string","example":"How to create a document in Konnect DocumentHub"},"raw_content":{"description":"Must be a base64 encoded string. Either raw_content or str_mdr_content are required.","type":"string","format":"byte","example":"YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc="},"str_md_content":{"description":"Markdown content. Either raw_content or str_mdr_content are required.","type":"string","example":"## My Markdown"},"metadata":{"$ref":"#/components/schemas/Metadata"},"filename":{"description":"name of the uploaded file","type":"string","example":"my_doc.md"}},"required":["slug","title","filename"],"title":"CreateDocumentPayload"},"UpdateDocumentPayload":{"description":"a document payload","type":"object","properties":{"parent_document_id":{"description":"Parent document Id. If this value is explicitly set to null, the\ndocument will be put as a top level document at the bottom of the tree.\n","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"},"DocumentCreationResponsePayload":{"description":"a document payload","type":"object","properties":{"document_id":{"description":"document id","type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"revision_id":{"description":"revision id","type":"string","format":"uuid","example":"ecfb698d-77a8-4ab5-91fa-45ee383b48ba"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["document_id","revision_id","updated_at","created_at"],"title":"Document Creation Response Payload"},"MoveDocumentRequestPayload":{"description":"move document request payload","type":"object","properties":{"parent_document_id":{"description":"parent document id","type":"string","format":"uuid","example":"dd4e1b98-3629-4dd3-acc0-759a726ffee2"},"index":{"description":"index of the document in the parent document's children","type":"integer","example":1}},"title":"Move document"},"StringFieldEqualsFilter":{"description":"Filters on the given string field value by exact match.","oneOf":[{"type":"string"},{"type":"object","title":"StringFieldEqualsComparison","additionalProperties":false,"properties":{"eq":{"type":"string"}},"required":["eq"]}],"title":"StringFieldEqualsFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"}}},"StringFieldOEQFilter":{"description":"Returns entities that exact match any of the comma-delimited phrases in the filter string.","type":"object","properties":{"oeq":{"type":"string"}},"additionalProperties":false,"required":["oeq"],"title":"StringFieldOEQFilter","x-examples":{"example-1":{"oeq":"some-value,some-other-value"}}},"StringFieldNEQFilter":{"description":"Filters on the given string field value by exact match inequality.","type":"object","properties":{"neq":{"type":"string"}},"additionalProperties":false,"required":["neq"],"title":"StringFieldNEQFilter","x-examples":{"example-1":{"neq":"not-this-value"}}},"UuidFieldFilter":{"description":"Filters on the given UUID field value by exact match.","oneOf":[{"$ref":"#/components/schemas/StringFieldEqualsFilter"},{"$ref":"#/components/schemas/StringFieldOEQFilter"},{"$ref":"#/components/schemas/StringFieldNEQFilter"}],"title":"UuidFieldFilter","x-examples":{"example-1":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1","example-2":{"eq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"},"example-3":{"oeq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"},"example-4":{"neq":"3bbfd3a-e9ab-48a9-9881-ed589e4615d1"}}},"StringFieldContainsFilter":{"description":"Filters on the given string field value by fuzzy match.","type":"object","properties":{"contains":{"type":"string"}},"additionalProperties":false,"required":["contains"],"title":"StringFieldContainsFilter","x-examples":{"example-1":{"contains":"some-value"}}},"StringFieldOContainsFilter":{"description":"Returns entities that fuzzy-match any of the comma-delimited phrases in the filter string.","type":"object","properties":{"ocontains":{"type":"string"}},"additionalProperties":false,"required":["ocontains"],"title":"StringFieldOContainsFilter","x-examples":{"example-1":{"ocontains":"this-value,or-that-value"}}},"StringFieldFilter":{"description":"Filters on the given string field value by either exact or fuzzy match.","oneOf":[{"$ref":"#/components/schemas/StringFieldEqualsFilter"},{"$ref":"#/components/schemas/StringFieldContainsFilter"},{"$ref":"#/components/schemas/StringFieldOContainsFilter"},{"$ref":"#/components/schemas/StringFieldOEQFilter"},{"$ref":"#/components/schemas/StringFieldNEQFilter"}],"title":"StringFieldFilter","x-examples":{"example-1":"equals-some-value","example-2":{"eq":"some-value"},"example-3":{"contains":"some-value"},"example-4":{"ocontains":"some-potential,value"},"example-5":{"oeq":"some-potential,value"},"example-6":{"neq":"not-this-value"}}},"DateTimeFieldFilter":{"description":"Filters on the given datetime (RFC-3339) field value.","oneOf":[{"type":"string","title":"DateTimeFieldImplicitEqualsFilter","format":"date-time","description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","example":"2022-03-30T07:20:50Z"},{"type":"object","title":"DateTimeFieldEqualsFilter","additionalProperties":false,"properties":{"eq":{"description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["eq"]},{"type":"object","title":"DateTimeFieldLTFilter","additionalProperties":false,"properties":{"lt":{"description":"Value is less than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lt"]},{"type":"object","title":"DateTimeFieldLTEFilter","additionalProperties":false,"properties":{"lte":{"description":"Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lte"]},{"type":"object","title":"DateTimeFieldGTFilter","additionalProperties":false,"properties":{"gt":{"description":"Value is greater than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gt"]},{"type":"object","title":"DateTimeFieldGTEFilter","additionalProperties":false,"properties":{"gte":{"description":"Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gte"]}],"title":"DateTimeFieldFilter","x-examples":{"datetime_field_1":"2022-03-30T07:20:50Z","datetime_field_2":{"eq":"2022-03-30T07:20:50Z"},"datetime_field_3":{"lt":"2022-03-30T07:20:50Z"},"datetime_field_4":{"lte":"2022-03-30T07:20:50Z"},"datetime_field_5":{"gt":"2022-03-30T07:20:50Z"},"datetime_field_6":{"gte":"2022-03-30T07:20:50Z"}}},"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"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":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"},"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"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"DocumentContentTypeEnum":{"type":"string","default":"application/json","enum":["application/json","application/vnd.konnect.document-tree+json"]},"Metadata":{"description":"Contains key value pairs information about entity's metadata.","type":"object","example":{"owner":"John Appleseed"},"additionalProperties":true},"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"]},"MetadataNullable":{"description":"Contains key value pairs information about entity's metadata.","type":"object","additionalProperties":true,"nullable":true}},"examples":{"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"MoveDocument":{"description":"move document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveDocumentRequestPayload"}}}},"CreateCollection":{"description":"collection creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCollectionPayload"}}}},"UpdateCollection":{"description":"collection update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCollectionPayload"}}}},"PutCollection":{"description":"collection put","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCollection"}}}},"CreateDocument":{"description":"document creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocumentPayload"}}}},"UpdateDocument":{"description":"document update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDocumentPayload"}}}}},"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"}}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}}},"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.\n"}}},"tags":[{"name":"Collections","description":"document collections operations"},{"name":"Documents","description":"document operations"}],"security":[{"konnectAccessToken":[]}]}
```
