Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity DataHub Offload Jobs API

3 actions 3 updates phrasing extends openapi/cumulocity-offload-jobs-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/datahub/offload/{id}/jobs'].get
$.paths['/service/datahub/offload/{id}/jobs'].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 DataHub Offload Jobs API
  version: 1.0.0
extends: openapi/cumulocity-offload-jobs-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/datahub/offload/{id}/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List runs of an offload pipeline
      effect: read
      questions:
      - Did my DataHub offload pipeline run successfully last night?
      - How do I see the job history of one offload configuration?
      instructions:
      - text: List the jobs of offload configuration {id}.
        slots:
          id: path.id
      - text: Show past runs for offload pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/datahub/offload/{id}/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an offload pipeline now
      effect: write
      questions:
      - Can I trigger an offload run manually instead of waiting for the schedule?
      - How do I start an offload job on demand?
      instructions:
      - text: Start an offload job for configuration {id} now.
        slots:
          id: path.id
      - text: Trigger a manual run of offload pipeline {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'