Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Edge Software Updates API

3 actions 3 updates phrasing extends openapi/cumulocity-software-updates-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['/service/edge/updates'].get
$.paths['/service/edge/updates'].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 Edge Software Updates API
  version: 1.0.0
extends: openapi/cumulocity-software-updates-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['/service/edge/updates'].get
  update:
    x-apievangelist-phrasing:
      intent: List available Edge updates
      effect: read
      questions:
      - Are there new versions available for my Edge installation?
      - Which Edge updates can I install?
      instructions:
      - text: List available Edge updates.
      - text: Show which Edge versions I can upgrade to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/edge/updates'].post
  update:
    x-apievangelist-phrasing:
      intent: Install an Edge update
      effect: write
      questions:
      - How do I upgrade my Edge installation to a newer version?
      - Can I choose which Edge version to install?
      instructions:
      - text: Install Edge version {version}.
        slots:
          version: requestBody.version
      - text: Upgrade this Edge to {version}.
        slots:
          version: requestBody.version
      method: generated
      generated: '2026-10-01'