# 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 Subscriptions API
  version: 1.0.0
extends: openapi/cumulocity-subscriptions-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: 5
- target: $.paths['/notification2/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Notification 2.0 subscriptions
      effect: read
      questions:
      - Which notification subscriptions exist for my devices?
      - Can I list subscriptions for one device or one context?
      instructions:
      - text: List notification subscriptions for source {source}.
        slots:
          source: query.source
      - text: Show subscriptions in context {context} named {subscription}.
        slots:
          context: query.context
          subscription: query.subscription
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notification2/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to device or tenant notifications
      effect: write
      questions:
      - How do I subscribe to real-time notifications for a device?
      - Can I filter a notification subscription to only alarms or measurements?
      instructions:
      - text: Create subscription {subscription} in context {context}.
        slots:
          subscription: requestBody.subscription
          context: requestBody.context
      - text: Subscribe {subscription} in context {context} to device {source} with filter {subscriptionFilter}.
        slots:
          subscription: requestBody.subscription
          context: requestBody.context
          source: requestBody.source
          subscriptionFilter: requestBody.subscriptionFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notification2/subscriptions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete subscriptions matching a filter
      effect: destructive
      questions:
      - Can I remove all my notification subscriptions in one go?
      - Is there a bulk delete for Notification 2.0 subscriptions?
      instructions:
      - text: Delete all notification subscriptions matching the filter.
      - text: Purge my Notification 2.0 subscriptions in bulk.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notification2/subscriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one notification subscription
      effect: read
      questions:
      - How do I see the filter and context of one subscription?
      - What does a specific notification subscription listen to?
      instructions:
      - text: Show me subscription {id}.
        slots:
          id: path.id
      - text: Get the filter and source of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notification2/subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one notification subscription
      effect: destructive
      questions:
      - How do I stop one notification subscription?
      - Can I delete a single subscription without affecting others?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Remove the notification subscription with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'