ConfigSyncV1Parameters

object
* Additional properties are NOT allowed.
endpoint_prefixstringrequired

Relative URI the DP should call to interact with capability workers.

Example:/v1/event-gateway-data-planes/<cp-id>

Example

ConfigSyncSignalV1

Signal notifying the DP that config has changed.

parameters contains capability-specific notification details.
For config_sync, that includes data-channel endpoints the DP can call to fetch config.

typestringrequired

The signal type identifier.

Allowed values:config_sync

versionstringrequired

The capability schema version for this signal type.

Allowed values:v1

parametersobjectrequired

Optional map of additional parameters for future use.

* Additional properties are NOT allowed.
Show Child Parameters
Example

EventGatewaySignal

A single signal envelope containing exactly one typed capability signal.

One Of
typestringrequired

The signal type identifier.

Allowed values:config_sync

versionstringrequired

The capability schema version for this signal type.

Allowed values:v1

parametersobjectrequired

Optional map of additional parameters for future use.

* Additional properties are NOT allowed.
Show Child Parameters
Example

EventGatewaySignals

object

The gateway signals response.

signalsOne Of
arrayrequired

A single signal envelope containing exactly one typed capability signal.

ConfigSyncSignalV1object

Signal notifying the DP that config has changed.

parameters contains capability-specific notification details.
For config_sync, that includes data-channel endpoints the DP can call to fetch config.

* Additional properties are NOT allowed.
Show Child Parameters
Example

Error

object

standard error

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.

Example