# 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 Reporting Service API
  version: 1.0.0
extends: openapi/progress-software-reportingservice-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: 14
- target: $.paths['/api/v0/compliance/reporting/controls'].post
  update:
    x-apievangelist-phrasing:
      intent: List compliance controls from last run
      effect: read
      questions:
      - Which compliance controls ran in the latest scans?
      - Is the compliance control list limited to 100 results by default?
      instructions:
      - text: List compliance controls matching {text}.
        slots:
          text: requestBody.text
      - text: List {size} controls from the last run with filters {filters}.
        slots:
          size: requestBody.size
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/controls/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search control summaries over a date range
      effect: read
      questions:
      - Can I get control summaries across a date range instead of just the last run?
      - How do I search compliance control summaries for a time window?
      instructions:
      - text: Search control summaries for a date range using filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Search control summaries containing {text}.
        slots:
          text: requestBody.text
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export compliance reports
      effect: read
      questions:
      - How do I export all compliance reports as CSV?
      - Can compliance report exports be filtered?
      instructions:
      - text: Export compliance reports matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Download compliance scan reports as a stream, filtered by {filters} and sorted by {sort}.
        slots:
          filters: requestBody.filters
          sort: requestBody.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/node/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export one node's compliance history
      effect: read
      questions:
      - Can I export the historical compliance reports for a single node?
      - What filter is required to export one node's report history?
      instructions:
      - text: Export historical compliance reports for one node using filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Export a single node's compliance history as CSV.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/nodeheader/id/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Show node header info for a report
      effect: read
      questions:
      - What node and metadata details are attached to a given compliance report?
      - Can I get header info for a node from its report ID?
      instructions:
      - text: Show node header info for report {id}.
        slots:
          id: path.id
      - text: Get node and report metadata for report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/nodes/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a compliance node by ID
      effect: read
      questions:
      - What does compliance know about one specific node?
      - Can I fetch a scanned node's details by its ID?
      instructions:
      - text: Show compliance node {id}.
        slots:
          id: path.id
      - text: Get the compliance details of node {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/nodes/search'].post
  update:
    x-apievangelist-phrasing:
      intent: List compliance-scanned nodes
      effect: read
      questions:
      - Which nodes have compliance scan results?
      - Is there a payload size limit when listing compliance nodes?
      instructions:
      - text: List compliance nodes matching {filters}.
        slots:
          filters: requestBody.filters
      - text: List page {page} of scanned nodes sorted by {sort}.
        slots:
          page: requestBody.page
          sort: requestBody.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: List compliance profiles in use
      effect: read
      questions:
      - Which compliance profiles are being used in scans?
      - Can I sort compliance profiles by name or title?
      instructions:
      - text: List compliance profiles in use sorted by {sort}.
        slots:
          sort: requestBody.sort
      - text: List profiles used by nodes matching {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/report-ids'].post
  update:
    x-apievangelist-phrasing:
      intent: List latest report IDs per node
      effect: read
      questions:
      - How do I get the ID of the latest compliance report for every node?
      - Can I only filter by one profile when listing report IDs?
      instructions:
      - text: List the latest report ID for each node.
      - text: List latest report IDs for nodes matching {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/reportcontrols/id/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: List control results within a report
      effect: read
      questions:
      - Which controls passed or failed in one specific report?
      - Is there a pagination limit on the controls listed for a report?
      instructions:
      - text: List control results in report {id}.
        slots:
          id: path.id
      - text: List controls in report {id} matching {filters}.
        slots:
          id: path.id
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/reportmanager/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a bulk compliance report export
      effect: write
      questions:
      - Can I export a large set of reports asynchronously and get an acknowledgement ID?
      - Where do I queue a multi-report export for later download?
      instructions:
      - text: Queue a report manager export of reports matching {filters}.
        slots:
          filters: requestBody.filters
      - text: Request an asynchronous export of many compliance reports.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: List compliance reports
      effect: read
      questions:
      - What compliance reports exist for my nodes?
      - Can I sort and page through compliance reports?
      instructions:
      - text: List compliance reports matching {filters}.
        slots:
          filters: requestBody.filters
      - text: List page {page} of reports, {per_page} per page.
        slots:
          page: requestBody.page
          per_page: requestBody.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/reports/id/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Show a compliance report
      effect: read
      questions:
      - What are the full results of a single compliance report?
      - Can I filter a report's results to one profile?
      instructions:
      - text: Show compliance report {id}.
        slots:
          id: path.id
      - text: Open report {id} filtered by {filters}.
        slots:
          id: path.id
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/suggestions'].post
  update:
    x-apievangelist-phrasing:
      intent: Suggest compliance filter values
      effect: read
      questions:
      - What values match when I type part of a profile or node name in compliance filters?
      - Which suggestion types are supported for compliance reporting?
      instructions:
      - text: Suggest {type} values containing {text}.
        slots:
          type: requestBody.type
          text: requestBody.text
      - text: Give {size} compliance suggestions for {type}.
        slots:
          size: requestBody.size
          type: requestBody.type
      method: generated
      generated: '2026-10-01'