# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Event Events API
  version: 1.0.0
extends: openapi/cumulocity-events-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: 6
- target: $.paths['/event/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events recorded for devices
      effect: read
      questions:
      - What events has a particular device reported recently?
      - Can I list events of one type between two dates?
      - Which events carry a specific fragment, like location updates?
      instructions:
      - text: List events from device {source} since {dateFrom}.
        slots:
          source: query.source
          dateFrom: query.dateFrom
      - text: Show events of type {type} between {dateFrom} and {dateTo}.
        slots:
          type: query.type
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: List events containing fragment {fragmentType}, oldest first.
        slots:
          fragmentType: query.fragmentType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a new event for a device
      effect: write
      questions:
      - How do I log a custom event for a device in Cumulocity?
      - What do I need to send to record an event, such as time, type and text?
      instructions:
      - text: Create an event of type {type} on device {source} at {time} with text {text}.
        slots:
          type: requestBody.type
          source: requestBody.source
          time: requestBody.time
          text: requestBody.text
      - text: Record a new {type} event for device {source}.
        slots:
          type: requestBody.type
          source: requestBody.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/events'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete events matching a filter
      effect: destructive
      questions:
      - Can I bulk delete a set of events by filter?
      - Is there a way to clear out many events in one call?
      instructions:
      - text: Delete all events matching the filter.
      - text: Purge the event collection in one bulk delete.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single event by ID
      effect: read
      questions:
      - How do I read the details of one event by its ID?
      - What time and text did a particular event record?
      instructions:
      - text: Show me event {id}.
        slots:
          id: path.id
      - text: Get the type, source and text of event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/events/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the text or details of an event
      effect: write
      questions:
      - Can I edit the text of an event that was already recorded?
      - How do I correct the type or time of an existing event?
      instructions:
      - text: Change the text of event {id} to {text}.
        slots:
          id: path.id
          text: requestBody.text
      - text: Update event {id} to type {type} at time {time}.
        slots:
          id: path.id
          type: requestBody.type
          time: requestBody.time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/events/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one event by ID
      effect: destructive
      questions:
      - How do I remove a single event that was logged by mistake?
      - Can I delete one specific event without touching the others?
      instructions:
      - text: Delete event {id}.
        slots:
          id: path.id
      - text: Remove the single event with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'