Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Edge System API

3 actions 3 updates phrasing extends openapi/cumulocity-system-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/system'].get
$.paths['/service/edge/system/restart'].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 System API
  version: 1.0.0
extends: openapi/cumulocity-system-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/system'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Edge system status
      effect: read
      questions:
      - Is my Edge system healthy right now?
      - What is the current status of the Edge installation?
      instructions:
      - text: Show the Edge system status.
      - text: Check the health of the Edge installation.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/edge/system/restart'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart the Edge system
      effect: destructive
      questions:
      - How do I restart my Edge system remotely?
      - Can I reboot the Edge installation through the API?
      instructions:
      - text: Restart the Edge system.
      - text: Reboot this Edge installation now.
      method: generated
      generated: '2026-10-01'