Gateway Admin Signals (dev)
CapabilityVersion
stringCapability-defined monotonic version.
Allowed values:v1
CapabilityOffset
stringCapability-defined monotonic offset.
CapabilityRequest
object * Additional properties are NOT allowed.
versionstringrequired
Capability schema version, such as “v1”.
Allowed values:v1
offsetstring(offset)
Capability-defined monotonic offset.
Example
CapabilitiesMap
objectMap of capability name -> capability request fields.
Example:
{
“config_sync”: { “version”: “v1”, “offset”: “v0.0” }
}
BaseCapabilityEnvelope
objectBase envelope for all capability signals.
Contains fields common to all capability signals.
typestringrequired
The signal type identifier.
versionstringrequired
The capability schema version for this signal type.
offsetstring(offset)required
Capability-defined monotonic offset.
correlation_idstring
Optional correlation id for tracing/debugging.
parametersobject
Optional map of additional parameters for future use.
* Additional properties are allowed.
Example