# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Downloads API
  version: 1.0.0
extends: openapi/harness-downloads-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: 3
- target: $.paths['/dashboard/download/tasks/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a dashboard download task
      effect: read
      questions:
      - Is my dashboard tile export finished yet?
      - How can I poll an asynchronous download task until it completes?
      instructions:
      - text: Check the status of download task {task}.
        slots:
          task: path.task_id
      - text: Tell me whether export task {task} has finished.
        slots:
          task: path.task_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/download/dashboards/{dashboard_id}/dashboard_elements/{dashboard_element_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch the results of a tile download task
      effect: read
      questions:
      - Once a tile export finishes, how do I retrieve the file?
      - Can I get a finished dashboard element download compressed?
      instructions:
      - text: Get the results of task {task} for element {element} on dashboard {dashboard}.
        slots:
          task: query.task_id
          element: path.dashboard_element_id
          dashboard: path.dashboard_id
      - text: Download the compressed output of task {task} for tile {element} in dashboard {dashboard}.
        slots:
          task: query.task_id
          element: path.dashboard_element_id
          dashboard: path.dashboard_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/download/dashboards/{dashboard_id}/dashboard_elements/{dashboard_element_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a download task for one dashboard tile
      effect: write
      questions:
      - How do I export the data behind a single dashboard tile in the background?
      - Can I start a tile export with filters and expanded tables?
      instructions:
      - text: Start a download task for element {element} on dashboard {dashboard}.
        slots:
          element: path.dashboard_element_id
          dashboard: path.dashboard_id
      - text: Queue an export of tile {element} in dashboard {dashboard} with filters {filters}.
        slots:
          element: path.dashboard_element_id
          dashboard: path.dashboard_id
          filters: query.filters
      method: generated
      generated: '2026-09-26'