# 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 Stats Service API
  version: 1.0.0
extends: openapi/progress-software-statsservice-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/reporting/stats/failures'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the top compliance failures
      effect: read
      questions:
      - Which platforms or environments are failing compliance the most?
      - Can I get the top failing controls and profiles for a date range?
      instructions:
      - text: Show the top compliance failures for filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Get the top {size} failing objects matching {filters}.
        slots:
          size: requestBody.size
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/stats/nodes/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count unique nodes for telemetry
      effect: read
      questions:
      - How many unique nodes have run since compliance telemetry was last sent?
      - What node count is used for usage reporting?
      instructions:
      - text: Get the count of unique compliance nodes for telemetry.
      - text: Tell me how many distinct nodes reported a recent run.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/stats/nodes/count/updated'].put
  update:
    x-apievangelist-phrasing:
      intent: Record when compliance telemetry was reported
      effect: write
      questions:
      - How do I acknowledge that compliance telemetry was sent?
      - Can I set the last compliance telemetry reported date?
      instructions:
      - text: Mark compliance telemetry as reported at {last_telemetry_reported_at}.
        slots:
          last_telemetry_reported_at: requestBody.last_telemetry_reported_at
      - text: Update the last telemetry reported timestamp to {last_telemetry_reported_at}.
        slots:
          last_telemetry_reported_at: requestBody.last_telemetry_reported_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/stats/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Get compliance stats per profile
      effect: read
      questions:
      - How are my compliance profiles performing across scanned nodes?
      - Can I see control-level results for one specific profile?
      instructions:
      - text: Show compliance statistics for all profiles.
      - text: Get {type} stats for profile {id} filtered by {filters}.
        slots:
          type: requestBody.type
          id: requestBody.id
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/stats/summary'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a compliance report summary
      effect: read
      questions:
      - What's the overall compliance summary across my nodes?
      - Can I get a summary of nodes or controls for the last 90 days?
      instructions:
      - text: Get the overall compliance summary.
      - text: Summarize compliance by {type} for filters {filters}.
        slots:
          type: requestBody.type
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/stats/trend'].post
  update:
    x-apievangelist-phrasing:
      intent: Get compliance trend over time
      effect: read
      questions:
      - Is compliance on my nodes getting better or worse over time?
      - What's the smallest interval I can use for a compliance trend graph?
      instructions:
      - text: Show the {type} compliance trend at interval {interval} for filters {filters}.
        slots:
          type: requestBody.type
          interval: requestBody.interval
          filters: requestBody.filters
      - text: Graph the controls compliance trend for the date range in {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'