# 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 Configurations API
  version: 1.0.0
extends: openapi/cumulocity-offload-configurations-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: 5
- target: $.paths['/service/datahub/offload'].get
  update:
    x-apievangelist-phrasing:
      intent: List DataHub offload configurations
      effect: read
      questions:
      - Which DataHub offloading pipelines are configured?
      - What data is being offloaded to the data lake right now?
      instructions:
      - text: List all offload configurations.
      - text: Show every DataHub offloading pipeline.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/datahub/offload'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up a new DataHub offload pipeline
      effect: write
      questions:
      - How do I start offloading alarms or measurements to the data lake?
      - Can I set a schedule and target table when I create an offload pipeline?
      instructions:
      - text: Create an offload of {source} into dataset {targetDataset}.
        slots:
          source: requestBody.source
          targetDataset: requestBody.targetDataset
      - text: Set up a {offloadType} offload of {source} on schedule {schedule}.
        slots:
          offloadType: requestBody.offloadType
          source: requestBody.source
          schedule: requestBody.schedule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/datahub/offload/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one offload configuration
      effect: read
      questions:
      - How do I see the filter and schedule of one offload pipeline?
      - Which target dataset does a given offload write to?
      instructions:
      - text: Show me offload configuration {id}.
        slots:
          id: path.id
      - text: Get the schedule and target dataset of offload configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/datahub/offload/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an offload pipeline
      effect: write
      questions:
      - Can I change the schedule of an existing offload pipeline?
      - How do I pause or change the filter on an offload configuration?
      instructions:
      - text: Change the schedule of offload configuration {id} to {schedule}.
        slots:
          id: path.id
          schedule: requestBody.schedule
      - text: Set the filter of offload configuration {id} to {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/datahub/offload/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an offload pipeline
      effect: destructive
      questions:
      - How do I remove an offload pipeline I no longer need?
      - Can I delete a DataHub offload configuration?
      instructions:
      - text: Delete offload configuration {id}.
        slots:
          id: path.id
      - text: Remove the offloading pipeline with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'