# 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 Jobs Service API
  version: 1.0.0
extends: openapi/progress-software-jobsservice-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/compliance/scanner/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a compliance scan job
      effect: write
      questions:
      - How do I schedule an InSpec scan of my nodes against compliance profiles?
      - Can I create a detect job that just checks whether nodes are reachable?
      - Is it possible to make a scan job repeat on a schedule?
      instructions:
      - text: Create an exec scan job {name} running profiles {profiles} against nodes {nodes}.
        slots:
          name: requestBody.name
          profiles: requestBody.profiles
          nodes: requestBody.nodes
      - text: Create a {type} job named {name} that recurs on {recurrence}.
        slots:
          type: requestBody.type
          name: requestBody.name
          recurrence: requestBody.recurrence
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/scanner/jobs/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scan job's details
      effect: read
      questions:
      - What nodes and profiles does a specific scan job target?
      - Can I check a scan job's status and schedule by its ID?
      instructions:
      - text: Get scan job {id}.
        slots:
          id: path.id
      - text: Show the status, nodes and profiles of job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/scanner/jobs/id/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scan job
      effect: write
      questions:
      - How do I change the profiles or recurrence of an existing scan job?
      - Do I need to resend every field when updating a scan job?
      instructions:
      - text: Update scan job {id} to run profiles {profiles}.
        slots:
          id: path.id
          profiles: requestBody.profiles
      - text: Change job {id}'s name to {name} and recurrence to {recurrence}.
        slots:
          id: path.id
          name: requestBody.name
          recurrence: requestBody.recurrence
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/scanner/jobs/id/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scan job
      effect: destructive
      questions:
      - How do I delete a scan job I no longer need?
      - Does deleting a scan job also delete its compliance reports?
      instructions:
      - text: Delete scan job {id}.
        slots:
          id: path.id
      - text: Remove the compliance scan job {id} but keep its reports.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/scanner/jobs/rerun/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Rerun an existing scan job
      effect: write
      questions:
      - Can I run a scan job again right now without creating a new one?
      - How do I trigger a fresh scan using an existing job's settings?
      instructions:
      - text: Rerun scan job {id}.
        slots:
          id: path.id
      - text: Run job {id} again now with its saved nodes and profiles.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/scanner/jobs/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and list scan jobs
      effect: read
      questions:
      - Which compliance scan jobs exist, and which ones failed?
      - Can I filter scan jobs by type or status and sort by end time?
      instructions:
      - text: List scan jobs matching filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Show scan jobs sorted by {sort}, {per_page} per page.
        slots:
          sort: requestBody.sort
          per_page: requestBody.per_page
      method: generated
      generated: '2026-10-01'