Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Notification 2.0 Tokens API

3 actions 3 updates phrasing extends openapi/cumulocity-tokens-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 3

$.info
$.paths['/notification2/token'].post
$.paths['/notification2/unsubscribe'].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 Notification 2.0 Tokens API
  version: 1.0.0
extends: openapi/cumulocity-tokens-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: 2
- target: $.paths['/notification2/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a token to consume a subscription
      effect: write
      questions:
      - How do I get a token to connect to a notification subscription?
      - Can I make a subscription token expire after a set number of minutes?
      instructions:
      - text: Create a token for subscriber {subscriber} on subscription {subscription}.
        slots:
          subscriber: requestBody.subscriber
          subscription: requestBody.subscription
      - text: Issue a token for {subscriber} on {subscription} expiring in {expiresInMinutes} minutes.
        slots:
          subscriber: requestBody.subscriber
          subscription: requestBody.subscription
          expiresInMinutes: requestBody.expiresInMinutes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notification2/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Invalidate a subscription token
      effect: destructive
      questions:
      - How do I unsubscribe a consumer and invalidate its token?
      - Can I revoke a notification token I issued?
      instructions:
      - text: Unsubscribe using token {token}.
        slots:
          token: requestBody.token
      - text: Invalidate notification token {token}.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-10-01'