ApiSpecDocument

object

API specification document.

api_typestringrequired

The type of specification being stored. This allows us to render the specification correctly.

Allowed values:oas2oas3asyncapi

Example:oas3

contentstringrequired
Example

ApiVersion

object

Singular version of an API

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

versionstringrequired

The version string of the API version .

Example:v1.0.0

specobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Example

ApiDocument

object

A document for an API. This is a document that is not a part of the API specification.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Unique identifier of the document.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

parent_document_idstring(uuid)

Unique identifier of the parent document.

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

Slug of the document. This is used in the URL to identify the document.

Example:getting-started

contentstringrequired

Markdown document

Example:# My Kong api This api is powered by Konnect

titlestringrequired

Title of the document.

Example:Hello World

Example

ApiDocumentTree

object

a document tree

* Additional properties are NOT allowed.
idstring(uuid)required

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

parent_document_idstring(uuid)

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

titlestringrequired

the title of the document

Example:Getting Started

slugstringrequired

the slug of the document

Example:getting-started

childrenarray[object]required

a document tree

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

ListApiAttributesPage

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example