EndpointPrefixRef

string

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

Example

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