# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Data Lifecycle API
  version: 1.0.0
extends: openapi/progress-software-datalifecycle-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: 15
- target: $.paths['/api/v0/data-lifecycle/compliance/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure compliance data retention jobs
      effect: write
      questions:
      - How do I change how long compliance scan data is kept?
      - Can I reschedule the compliance data purge jobs?
      instructions:
      - text: Set the compliance data lifecycle job settings to {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      - text: Update the compliance purge schedule using {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/compliance/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run compliance data lifecycle jobs now
      effect: write
      questions:
      - Can I trigger the compliance data cleanup immediately instead of waiting for the schedule?
      - How do I purge old compliance reports right now?
      instructions:
      - text: Run the compliance data lifecycle jobs now.
      - text: Kick off compliance data purging immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/compliance/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check compliance lifecycle job status
      effect: read
      questions:
      - When did the compliance data purge last run and when is it next?
      - What is the compliance job scheduler's status?
      instructions:
      - text: Show the status of the compliance data lifecycle scheduler.
      - text: Check whether the compliance purge jobs are running.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure all data lifecycle jobs at once
      effect: write
      questions:
      - Is there one place to set retention for compliance, event feed, infra and services data together?
      - How do I update every data lifecycle job in a single request?
      instructions:
      - text: 'Apply this full data lifecycle configuration: compliance {compliance}, event feed {event_feed}, infra {infra}, services {services}.'
        slots:
          compliance: requestBody.compliance
          event_feed: requestBody.event_feed
          infra: requestBody.infra
          services: requestBody.services
      - text: Set the infra retention part {infra} in the combined data lifecycle config.
        slots:
          infra: requestBody.infra
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/event-feed/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure event feed data retention jobs
      effect: write
      questions:
      - How long are event feed entries retained, and can I change it?
      - Can I reschedule the event feed purge job?
      instructions:
      - text: Set the event feed data lifecycle job settings to {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      - text: Change event feed retention with job settings {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/event-feed/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run event feed data lifecycle jobs now
      effect: write
      questions:
      - Can I purge old event feed data immediately?
      - How do I trigger the event feed lifecycle job on demand?
      instructions:
      - text: Run the event feed data lifecycle jobs now.
      - text: Purge expired event feed entries right away.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/event-feed/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check event feed lifecycle job status
      effect: read
      questions:
      - What's the status of the event feed purge scheduler?
      - When will event feed data next be cleaned up?
      instructions:
      - text: Show the event feed data lifecycle job status.
      - text: Check the event feed purge scheduler.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/infra/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure infra node data retention jobs
      effect: write
      questions:
      - How do I control how long infra data is kept before it is purged?
      - Can I change the schedule of the infra data lifecycle jobs?
      instructions:
      - text: Set the infra data lifecycle job settings to {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      - text: Update infra data retention using {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/infra/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run infra data lifecycle jobs now
      effect: write
      questions:
      - Can I run the infra data cleanup jobs immediately?
      - How do I trigger infra data purging on demand?
      instructions:
      - text: Run the infra data lifecycle jobs now.
      - text: Start infra data cleanup immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/infra/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check infra lifecycle job status
      effect: read
      questions:
      - What is the status of the infra data lifecycle scheduler?
      - When did the infra data cleanup last run?
      instructions:
      - text: Show the infra data lifecycle job status.
      - text: Check the infra cleanup scheduler.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run every data lifecycle job now
      effect: write
      questions:
      - Can I run all retention and purge jobs across every data type at once?
      - How do I trigger the whole data lifecycle in one go?
      instructions:
      - text: Run all data lifecycle jobs now.
      - text: Trigger every retention and purge action across all data lifecycle jobs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/services/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure services data retention jobs
      effect: write
      questions:
      - How do I set retention for services data?
      - Can I change the schedule of the services data lifecycle jobs?
      instructions:
      - text: Set the services data lifecycle job settings to {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      - text: Update services retention using {job_settings}.
        slots:
          job_settings: requestBody.job_settings
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/services/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run services data lifecycle jobs now
      effect: write
      questions:
      - Can I run the services data cleanup immediately?
      - How do I trigger the services lifecycle jobs on demand?
      instructions:
      - text: Run the services data lifecycle jobs now.
      - text: Start services data cleanup immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/services/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check services lifecycle job status
      effect: read
      questions:
      - What is the status of the services data lifecycle jobs?
      - When will services data next be cleaned up?
      instructions:
      - text: Show the services data lifecycle job status.
      - text: Check the services cleanup scheduler.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/data-lifecycle/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregate status of all data lifecycle jobs
      effect: read
      questions:
      - Can I see the status of every data lifecycle job in one response?
      - Are all my retention jobs healthy across compliance, event feed, infra and services?
      instructions:
      - text: Show the combined status of all data lifecycle jobs.
      - text: Give me an overview of every retention scheduler.
      method: generated
      generated: '2026-10-01'