# 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 Job Scheduler API
  version: 1.0.0
extends: openapi/progress-software-job-scheduler-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: 4
- target: $.paths['/api/v0/retention/nodes/delete-nodes/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure the delete-nodes retention job
      effect: write
      questions:
      - How do I change how often Automate runs the job that deletes nodes?
      - Can I turn off the delete-nodes retention job?
      instructions:
      - text: Run the delete-nodes job every {every} with threshold {threshold}.
        slots:
          every: requestBody.every
          threshold: requestBody.threshold
      - text: Set the delete-nodes scheduler running state to {running}.
        slots:
          running: requestBody.running
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/nodes/missing-nodes-deletion/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure deletion of nodes that stay missing
      effect: write
      questions:
      - How long can a node stay missing before Automate deletes it?
      - Can I schedule automatic removal of nodes that have been missing for a while?
      instructions:
      - text: Delete nodes that have been missing longer than {threshold}, checking every {every}.
        slots:
          threshold: requestBody.threshold
          every: requestBody.every
      - text: Set the missing-nodes-for-deletion job running state to {running}.
        slots:
          running: requestBody.running
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/nodes/missing-nodes/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure when nodes are marked missing
      effect: write
      questions:
      - After how long without a check-in does a node get marked missing?
      - Can I change how often Automate checks for missing nodes?
      instructions:
      - text: Mark nodes as missing after {threshold} without reporting, checking every {every}.
        slots:
          threshold: requestBody.threshold
          every: requestBody.every
      - text: Set the mark-nodes-missing scheduler running state to {running}.
        slots:
          running: requestBody.running
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/retention/nodes/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of node retention jobs
      effect: read
      questions:
      - What are the current settings and run state of the node retention jobs?
      - Is the missing-node cleanup job currently running?
      instructions:
      - text: Show the status of the node lifecycle job scheduler.
      - text: Get the thresholds and intervals for all node retention jobs.
      method: generated
      generated: '2026-10-01'