Search
K
Konnect Service Catalog

CursorMetaPage

object
firststring(path)

URI to the first page

laststring(path)

URI to the last page

nextstring(path)required

URI to the next page

previousstring(path)required

URI to the previous page

sizenumberrequired

Requested page size

Example:10

Example

CursorMeta

object

Pagination metadata.

pageobjectrequired
Show Child Parameters
Example

Slug

string

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example

Move document

object

move document request payload

parent_document_idstring(uuid)

parent document id

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

indexinteger

index of the document in the parent document’s children

Example:1

Example

UnsupportedMediaTypeError

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.

Example:415

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.

Example:UnsupportedMediaType

typestringread-only

The error type.

Example:https://httpstatuses.com/415

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.

Example:kong:trace:1234567890

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.

Example:UnsupportedMediaType

Example