# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Reports API
  version: 1.0.0
extends: openapi/harness-reports-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/rmg/api/release/{releaseId}/report/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a CSV report for a release
      effect: write
      questions:
      - Can I produce a CSV report for one release over a date range?
      - Is release report generation asynchronous?
      instructions:
      - text: Generate a report for release {release} from {start} to {end}.
        slots:
          release: path.releaseId
          start: requestBody.startTs
          end: requestBody.endTs
      - text: Start a CSV report job for release {release} covering {start} through {end} in project {project}.
        slots:
          release: path.releaseId
          start: requestBody.startTs
          end: requestBody.endTs
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/{releaseGroupId}/report/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a CSV report for a release group
      effect: write
      questions:
      - How do I get one CSV report covering every release in a release group?
      - Can a release group report be limited to a time period?
      instructions:
      - text: Generate one combined report for every release in group {group} from {start} to {end}.
        slots:
          group: path.releaseGroupId
          start: requestBody.startTs
          end: requestBody.endTs
      - text: Start a CSV report job for all releases in group {group} between {start} and {end} in project {project}.
        slots:
          group: path.releaseGroupId
          start: requestBody.startTs
          end: requestBody.endTs
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/release/report/{reportId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a release report job's status
      effect: read
      questions:
      - Is my release report finished generating yet?
      - Why did a report generation job fail?
      instructions:
      - text: Check the status of report {report}.
        slots:
          report: path.reportId
      - text: Tell me whether report job {report} in project {project} has completed or failed.
        slots:
          report: path.reportId
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/release/report/{reportId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a completed release report
      effect: read
      questions:
      - Where do I download the CSV once a release report is ready?
      - Can I download a report that hasn't reached completed status?
      instructions:
      - text: Download report {report} as CSV.
        slots:
          report: path.reportId
      - text: Fetch the finished CSV file for report {report} in project {project}.
        slots:
          report: path.reportId
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'