Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Real-Time Notifications Bayeux Handshake API

2 actions 2 updates phrasing extends openapi/cumulocity-bayeux-handshake-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cumulocity's API. It is a proposal applied on top of the contract, not a document Cumulocity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/notification/realtime'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Real-Time Notifications Bayeux Handshake API
  version: 1.0.0
extends: openapi/cumulocity-bayeux-handshake-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/notification/realtime'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange real-time Bayeux messages
      effect: write
      questions:
      - How do I start a real-time CometD session with a handshake?
      - Can I subscribe to a real-time channel over the Bayeux endpoint?
      - What channel do I send to disconnect a real-time client?
      instructions:
      - text: Send a handshake on channel {channel}.
        slots:
          channel: requestBody.channel
      - text: Subscribe client {clientId} to {subscription} via channel {channel}.
        slots:
          clientId: requestBody.clientId
          subscription: requestBody.subscription
          channel: requestBody.channel
      - text: Disconnect real-time client {clientId} on channel {channel}.
        slots:
          clientId: requestBody.clientId
          channel: requestBody.channel
      method: generated
      generated: '2026-10-01'