BadRequestError

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

invalid_parametersOne Of
arrayrequiredunique-items

invalid parameters

>= 1 items

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

DocumentFormatContentTypeEnum

string

Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json

Default:application/json

NodeChildren

array

List of children nodes of the current node

One Of
typestringrequired

Allowed values:heading

levelnumber

Level of the heading which maps to HTML tag

>= 1<= 6

childrenOne Of
array[object]

List of children nodes of the current node

HeadingBlockobject
Show Child Parameters

HeadingBlock

object
typestringrequired

Allowed values:heading

levelnumber

Level of the heading which maps to HTML tag

>= 1<= 6

childrenOne Of
array[object]

List of children nodes of the current node

Example

BlockQuoteBlock

object
typestringrequired

Allowed values:blockquote

childrenOne Of
array[object]

List of children nodes of the current node

HeadingBlockobject
Show Child Parameters
Example