{ "opencollection": "1.0.0", "info": { "name": "Kong Enterprise Admin ACLs API Package Documentation API", "version": "3.14.0" }, "request": { "auth": { "type": "apikey", "key": "Kong-Admin-Token", "value": "{{Kong-Admin-Token}}", "placement": "header" } }, "items": [ { "info": { "name": "API Package Documentation", "type": "folder" }, "items": [ { "info": { "name": "List API Package Documents", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:packageId/documents", "params": [ { "name": "packageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "filter", "value": "", "type": "query", "description": "Filters API Documents in the response." } ] }, "docs": "Returns a collection of all documents for an API package." }, { "info": { "name": "Create API Package Document", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:packageId/documents", "params": [ { "name": "packageId", "value": "", "type": "path", "description": "The UUID API Package identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Publish a new document attached to an API Package.\n\nAll configuration options may be provided in the frontmatter section of `content`. If you set values in both the `POST` request _and_ in the frontmatter, the values in the `POST` request will take precedence.\n" }, { "info": { "name": "Get an API Package Document", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:packageId/documents/:documentId", "params": [ { "name": "packageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "documentId", "value": "", "type": "path", "description": "The document identifier related to the API" } ] }, "docs": "Returns a document for the API Package." }, { "info": { "name": "Update API Package Document", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:packageId/documents/:documentId", "params": [ { "name": "packageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "documentId", "value": "", "type": "path", "description": "The document identifier related to the API" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a document for an API Package." }, { "info": { "name": "Delete API Package Documentation", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:packageId/documents/:documentId", "params": [ { "name": "packageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "documentId", "value": "", "type": "path", "description": "The document identifier related to the API" } ] }, "docs": "Removes a document from an API Package." }, { "info": { "name": "Move API Package Documentation", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}:{port}{path}/v3/api-packages/:packageId/documents/:documentId/move", "params": [ { "name": "packageId", "value": "", "type": "path", "description": "The UUID API Package identifier" }, { "name": "documentId", "value": "", "type": "path", "description": "The document identifier related to the API" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send parent_document_id: null and index: 0. This api also supports using a negative index to co" } ] } ], "bundled": true }