Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Event Event Binaries API

4 actions 4 updates phrasing extends openapi/cumulocity-event-binaries-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 4

$.info
$.paths['/event/events/{id}/binaries'].get
$.paths['/event/events/{id}/binaries'].post
$.paths['/event/events/{id}/binaries'].delete

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 Event Event Binaries API
  version: 1.0.0
extends: openapi/cumulocity-event-binaries-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: 3
- target: $.paths['/event/events/{id}/binaries'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file attached to an event
      effect: read
      questions:
      - How do I download the file attached to an event?
      - Can I get the image or log stored with an event?
      instructions:
      - text: Download the attachment of event {id}.
        slots:
          id: path.id
      - text: Get the binary attached to event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/events/{id}/binaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to an event
      effect: write
      questions:
      - How do I attach a photo or log file to an event?
      - Can I store a binary alongside an existing event?
      instructions:
      - text: Attach a file to event {id}.
        slots:
          id: path.id
      - text: Upload a binary attachment for event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/event/events/{id}/binaries'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the file attached to an event
      effect: destructive
      questions:
      - How do I remove the attachment from an event but keep the event?
      - Can I delete an event's binary file?
      instructions:
      - text: Delete the attachment of event {id}.
        slots:
          id: path.id
      - text: Remove the binary file stored on event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'