Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Retention Rules API

6 actions 6 updates phrasing extends openapi/cumulocity-retention-rules-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 6

$.info

$.paths['/retention/retentions'].get

$.paths['/retention/retentions'].post

$.paths['/retention/retentions/{id}'].get

$.paths['/retention/retentions/{id}'].put

$.paths['/retention/retentions/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Retention Rules API
  version: 1.0.0
extends: openapi/cumulocity-retention-rules-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['/retention/retentions'].get
  update:
    x-apievangelist-phrasing:
      intent: List data retention rules
      effect: read
      questions:
      - What data retention rules are set on my tenant?
      - How long is each type of data kept before it's deleted?
      instructions:
      - text: List all retention rules.
      - text: Show how long each data type is retained.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/retention/retentions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a data retention rule
      effect: write
      questions:
      - How do I make old measurements expire after a number of days?
      - Can I set a retention rule just for one device or fragment?
      instructions:
      - text: Create a retention rule keeping {dataType} data for {maximumAge} days.
        slots:
          dataType: requestBody.dataType
          maximumAge: requestBody.maximumAge
      - text: Keep {dataType} data from source {source} for only {maximumAge} days.
        slots:
          dataType: requestBody.dataType
          source: requestBody.source
          maximumAge: requestBody.maximumAge
      method: generated
      generated: '2026-10-01'
- target: $.paths['/retention/retentions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one retention rule
      effect: read
      questions:
      - How do I see the details of one retention rule?
      - What maximum age does a specific retention rule apply?
      instructions:
      - text: Show me retention rule {id}.
        slots:
          id: path.id
      - text: Get the data type and maximum age of retention rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/retention/retentions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a data retention rule
      effect: write
      questions:
      - Can I change how many days an existing retention rule keeps data?
      - How do I edit the data type covered by a retention rule?
      instructions:
      - text: Change retention rule {id} to keep {dataType} data for {maximumAge} days.
        slots:
          id: path.id
          dataType: requestBody.dataType
          maximumAge: requestBody.maximumAge
      - text: Extend retention rule {id} for {dataType} to a maximum age of {maximumAge} days.
        slots:
          id: path.id
          dataType: requestBody.dataType
          maximumAge: requestBody.maximumAge
      method: generated
      generated: '2026-10-01'
- target: $.paths['/retention/retentions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data retention rule
      effect: destructive
      questions:
      - How do I remove a retention rule so data is no longer auto-deleted by it?
      - Can I delete a retention rule I set up earlier?
      instructions:
      - text: Delete retention rule {id}.
        slots:
          id: path.id
      - text: Remove the retention rule with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'