Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Inventory Binaries API

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

$.info
$.paths['/inventory/binaries'].get
$.paths['/inventory/binaries'].post
$.paths['/inventory/binaries/{id}'].get
$.paths['/inventory/binaries/{id}'].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 Inventory Binaries API
  version: 1.0.0
extends: openapi/cumulocity-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: 4
- target: $.paths['/inventory/binaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List stored files
      effect: read
      questions:
      - What files are stored in the inventory binary repository?
      - Which firmware or config files have been uploaded?
      instructions:
      - text: List all stored binaries.
      - text: Show every file in the binary repository.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/binaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to the inventory
      effect: write
      questions:
      - How do I upload a firmware image or config file?
      - Can I attach metadata when I upload a binary file?
      instructions:
      - text: Upload file {file} to the binary repository.
        slots:
          file: requestBody.file
      - text: Upload {file} with metadata {object}.
        slots:
          file: requestBody.file
          object: requestBody.object
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/binaries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a stored file
      effect: read
      questions:
      - How do I download a file I uploaded earlier?
      - Can I fetch the contents of a stored binary by ID?
      instructions:
      - text: Download binary {id}.
        slots:
          id: path.id
      - text: Get the file contents of stored binary {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/binaries/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stored file
      effect: destructive
      questions:
      - How do I delete an old firmware file from storage?
      - Can I remove a binary I uploaded by mistake?
      instructions:
      - text: Delete binary {id}.
        slots:
          id: path.id
      - text: Remove the stored file with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'