Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Edge Cloud Sync API

3 actions 3 updates phrasing extends openapi/cumulocity-cloud-sync-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/cloud-sync'].get
$.paths['/service/edge/cloud-sync'].put

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 Cloud Sync API
  version: 1.0.0
extends: openapi/cumulocity-cloud-sync-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/cloud-sync'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the Edge cloud sync settings
      effect: read
      questions:
      - Is my Edge installation syncing data to the cloud tenant?
      - Which data types does Edge cloud sync currently send?
      instructions:
      - text: Show the cloud sync configuration.
      - text: Get the Edge cloud sync target and bandwidth limit.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/edge/cloud-sync'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the Edge cloud sync settings
      effect: write
      questions:
      - How do I point my Edge to a cloud tenant for data sync?
      - Can I cap the bandwidth Edge uses when syncing to the cloud?
      instructions:
      - text: Enable cloud sync to tenant {targetTenantId} at {targetTenantUrl}.
        slots:
          targetTenantId: requestBody.targetTenantId
          targetTenantUrl: requestBody.targetTenantUrl
      - text: Limit Edge cloud sync to {bandwidthLimitKbps} kbps for data types {syncedDataTypes}.
        slots:
          bandwidthLimitKbps: requestBody.bandwidthLimitKbps
          syncedDataTypes: requestBody.syncedDataTypes
      method: generated
      generated: '2026-10-01'