# 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 Retention API
  version: 1.0.0
extends: openapi/progress-software-retention-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: 6
- target: $.paths['/api/v0/retention/service_groups/delete_disconnected_services/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the delete-disconnected-services job config
      effect: read
      questions:
      - After how long are disconnected services automatically deleted?
      - Is the job that removes disconnected services currently enabled?
      instructions:
      - text: Show the configuration of the remove-disconnected-services job.
      - text: Tell me the deletion threshold for disconnected services.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/service_groups/delete_disconnected_services/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the delete-disconnected-services job config
      effect: write
      questions:
      - How do I change how long disconnected services stay before they're deleted?
      - Can I disable automatic deletion of disconnected services?
      instructions:
      - text: Delete disconnected services after {threshold}.
        slots:
          threshold: requestBody.threshold
      - text: Set the remove-disconnected-services job running to {running} with recurrence {recurrence}.
        slots:
          running: requestBody.running
          recurrence: requestBody.recurrence
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/service_groups/delete_disconnected_services/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the delete-disconnected-services job now
      effect: destructive
      questions:
      - Can I run the scheduled cleanup of disconnected services right now?
      - How do I immediately delete services that passed the disconnected threshold?
      instructions:
      - text: Run the remove-disconnected-services retention job now.
      - text: Trigger the scheduled deletion of disconnected services immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/service_groups/disconnected_services/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the mark-disconnected-services job config
      effect: read
      questions:
      - How long can a service go without reporting before it's marked disconnected?
      - What schedule does the disconnected-services check run on?
      instructions:
      - text: Show the configuration of the mark-disconnected-services job.
      - text: Tell me the threshold for marking services as disconnected.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/service_groups/disconnected_services/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the mark-disconnected-services job config
      effect: write
      questions:
      - How do I change the period after which silent services are marked disconnected?
      - Can I change how often the disconnected-services check runs?
      instructions:
      - text: Mark services disconnected after {threshold} of silence.
        slots:
          threshold: requestBody.threshold
      - text: Set the disconnected-services check recurrence to {recurrence}.
        slots:
          recurrence: requestBody.recurrence
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/service_groups/disconnected_services/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run the mark-disconnected-services job now
      effect: write
      questions:
      - Can I run the check that marks services as disconnected right away?
      - How do I immediately flag services that stopped reporting?
      instructions:
      - text: Run the mark-disconnected-services retention job now.
      - text: Immediately check for and flag disconnected services.
      method: generated
      generated: '2026-10-01'