# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Hygiene Dataset Expiration (TTL) API
  version: 1.0.0
extends: openapi/adobe-suite-dataset-expiration-ttl-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/ttl'].get
  update:
    x-apievangelist-phrasing:
      intent: List dataset expiration schedules
      effect: read
      questions:
      - Which datasets in my org are scheduled to expire?
      - Can I see only pending expirations due within a date range?
      - How do I find the expiration set on a dataset by name?
      instructions:
      - text: List dataset expirations with status {status}.
        slots:
          status: query.status
      - text: List expirations due between {expiryFromDate} and {expiryToDate}.
        slots:
          expiryFromDate: query.expiryFromDate
          expiryToDate: query.expiryToDate
      - text: Find expirations for datasets named like {datasetName}.
        slots:
          datasetName: query.datasetName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ttl'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a dataset to expire
      effect: write
      questions:
      - How do I set a dataset to be deleted automatically on a certain date?
      - What format should the expiry date be in when scheduling a dataset expiration?
      instructions:
      - text: Schedule dataset {datasetId} to expire at {expiry} as {displayName}.
        slots:
          datasetId: requestBody.datasetId
          expiry: requestBody.expiry
          displayName: requestBody.displayName
      - text: Create an expiration named {displayName} for dataset {datasetId} on {expiry} with note {description}.
        slots:
          displayName: requestBody.displayName
          datasetId: requestBody.datasetId
          expiry: requestBody.expiry
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ttl/{ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dataset expiration's details
      effect: read
      questions:
      - How do I check the expiration configured for one dataset?
      - Can I look up an expiration using the dataset ID instead of the expiration ID?
      instructions:
      - text: Show dataset expiration {ID}.
        slots:
          ID: path.ID
      - text: Get expiration {ID} including {include}.
        slots:
          ID: path.ID
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ttl/{ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a pending dataset expiration
      effect: write
      questions:
      - How do I push back the date a dataset is set to expire?
      - Can I edit an expiration after it's no longer pending?
      instructions:
      - text: Move the expiry of {ID} to {expiry}.
        slots:
          ID: path.ID
          expiry: requestBody.expiry
      - text: Rename dataset expiration {ID} to {displayName}.
        slots:
          ID: path.ID
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ttl/{ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending dataset expiration
      effect: destructive
      questions:
      - How do I stop a dataset from being deleted on its scheduled expiry?
      - Can I cancel an expiration that isn't pending anymore?
      instructions:
      - text: Cancel dataset expiration {ID}.
        slots:
          ID: path.ID
      - text: Remove the pending expiry on {ID} so the dataset is kept.
        slots:
          ID: path.ID
      method: generated
      generated: '2026-09-26'