# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Method Reports API
  version: 1.0.0
extends: openapi/methodfi-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: 3
- target: $.paths['/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a report
      effect: write
      questions:
      - How do I generate a report of a given type?
      - Are reports built asynchronously before I can download them?
      instructions:
      - text: Create a {type} report.
        slots:
          type: requestBody.type
      - text: Generate a new report of type {type} with idempotency key {key}.
        slots:
          type: requestBody.type
          key: header.Idempotency-Key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a report's status
      effect: read
      questions:
      - Is my report finished and ready to download?
      - Can I look up a report by its ID?
      instructions:
      - text: Get report {report}.
        slots:
          report: path.reportId
      - text: Check whether report {report} is completed.
        slots:
          report: path.reportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a completed report as CSV
      effect: read
      questions:
      - How do I download a finished report as a CSV file?
      - Can I get the CSV once a report is completed?
      instructions:
      - text: Download report {report} as CSV.
        slots:
          report: path.reportId
      - text: Save the CSV file for completed report {report}.
        slots:
          report: path.reportId
      method: generated
      generated: '2026-10-01'