API Evangelist conversational phrasing for Cohesity Reports API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity Reports API
  version: 1.0.0
extends: openapi/cohesity-reports-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: 12
- target: $.paths['/public/reports/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on installed agents and their health
      effect: read
      questions:
      - Which Cohesity agents are unhealthy or need an upgrade?
      - Can I export the agent deployment report as CSV?
      instructions:
      - text: Show the agent deployment report for {hostOsType} hosts.
        slots:
          hostOsType: query.hostOsType
      - text: List installed agents with health status {healthStatus} as {outputFormat}.
        slots:
          healthStatus: query.healthStatus
          outputFormat: query.outputFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/dataTransferFromVaults'].get
  update:
    x-apievangelist-phrasing:
      intent: Report data pulled back from vaults
      effect: read
      questions:
      - How much data has been transferred from my cloud vaults back to the cluster?
      - Can I see vault-to-cluster transfer stats for a date range?
      instructions:
      - text: Report data transferred from vaults {vaultIds} to the cluster.
        slots:
          vaultIds: query.vaultIds
      - text: Show inbound transfer stats from vaults {vaultIds} since {startTimeMsecs}.
        slots:
          vaultIds: query.vaultIds
          startTimeMsecs: query.startTimeMsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/dataTransferToVaults'].get
  update:
    x-apievangelist-phrasing:
      intent: Report data sent to vaults
      effect: read
      questions:
      - How much data has the cluster archived out to each external target?
      - Can I group the outbound vault transfer report by target?
      instructions:
      - text: Report data transferred to vaults {vaultIds}.
        slots:
          vaultIds: query.vaultIds
      - text: Show cluster-to-vault transfer stats for {vaultIds} as {outputFormat}.
        slots:
          vaultIds: query.vaultIds
          outputFormat: query.outputFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/gdpr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the GDPR access report
      effect: read
      questions:
      - Which users can access objects that hold personal data?
      - Can I search the audit trail of GDPR-relevant actions in a time range?
      instructions:
      - text: Get the GDPR report for objects {id}.
        slots:
          id: query.id
      - text: Show which objects users {accessibleUsers} can access for GDPR.
        slots:
          accessibleUsers: query.accessibleUsers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/protectedObjectsTrends'].get
  update:
    x-apievangelist-phrasing:
      intent: Report protection trends over time
      effect: read
      questions:
      - How has protection of my objects trended week over week?
      - Can I roll up the protected objects trend by month?
      instructions:
      - text: Show the protected objects trend in timezone {timezone}.
        slots:
          timezone: query.timezone
      - text: Report protection trends rolled up by {rollup} in timezone {timezone}.
        slots:
          rollup: query.rollup
          timezone: query.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/protectionSourcesJobRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: Report backup snapshots for specific objects
      effect: read
      questions:
      - Which snapshots exist for a particular VM, and were they successful?
      - Can I page through the job run history for a list of objects?
      instructions:
      - text: List job runs for objects {protectionSourceIds}.
        slots:
          protectionSourceIds: query.protectionSourceIds
      - text: Show failed snapshots for objects {protectionSourceIds} with status {runStatus}.
        slots:
          protectionSourceIds: query.protectionSourceIds
          runStatus: query.runStatus
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/protectionSourcesJobsSummary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize snapshot stats per protected object
      effect: read
      questions:
      - Which objects have failed backups several times in a row?
      - Can I get snapshot summary statistics for everything under a vCenter?
      instructions:
      - text: Summarize job runs for objects protected by jobs {jobIds}.
        slots:
          jobIds: query.jobIds
      - text: Show objects with at least {consecutiveFailures} consecutive failures.
        slots:
          consecutiveFailures: query.consecutiveFailures
      - text: Summarize snapshot stats for registered source {registeredSourceId}.
        slots:
          registeredSourceId: query.registeredSourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/report-types/{reportType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe a report type's properties
      effect: read
      questions:
      - What properties does a given report type expose?
      - Which fields can I use with a particular report type?
      instructions:
      - text: Show the properties of report type {reportType}.
        slots:
          reportType: path.reportType
      - text: Describe report type {reportType}.
        slots:
          reportType: path.reportType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List available reports
      effect: read
      questions:
      - What reports can I access as the logged-in user?
      - Can I list a handful of reports by their ids?
      instructions:
      - text: List all reports I can access.
      - text: List reports {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report's configuration
      effect: read
      questions:
      - How do I look up a single configured report?
      - What components make up a particular report?
      instructions:
      - text: Get report {id}.
        slots:
          id: path.id
      - text: Show the configuration of report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/{id}/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview a report's data
      effect: read
      questions:
      - Can I preview a report's results before exporting or scheduling it?
      - Is it possible to preview only some components of a report with filters applied?
      instructions:
      - text: Preview report {id}.
        slots:
          id: path.id
      - text: Preview report {id} in timezone {timezone} for components {componentIds}.
        slots:
          id: path.id
          timezone: requestBody.timezone
          componentIds: requestBody.componentIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/reports/{id}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a report to a file
      effect: read
      questions:
      - How do I export a report as a PDF or CSV?
      - Can a large report export run asynchronously?
      instructions:
      - text: Export report {id} as {reportFormat}.
        slots:
          id: path.id
          reportFormat: requestBody.reportFormat
      - text: Export report {id} asynchronously in {reportFormat} format.
        slots:
          id: path.id
          reportFormat: requestBody.reportFormat
      method: generated
      generated: '2026-10-01'