# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Dashboards API
  version: 1.0.0
extends: openapi/harness-dashboards-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: 13
- target: $.paths['/gitops/api/v1/dashboard/counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Count recently created GitOps apps, clusters and repos
      effect: read
      questions:
      - How many GitOps applications, clusters and repositories were created in the last month?
      - Can I count new GitOps resources within a specific time window?
      instructions:
      - text: Count GitOps apps, clusters and repos created between {start} and {end}.
        slots:
          start: query.startTime
          end: query.endTime
      - text: Show recently created GitOps resource counts for project {project}.
        slots:
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gitops/api/v1/dashboard/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the GitOps dashboard overview
      effect: read
      questions:
      - What are the key health and sync metrics on the GitOps dashboard?
      - Can I scope the GitOps overview to a single agent?
      instructions:
      - text: Show the GitOps dashboard overview for project {project}.
        slots:
          project: query.projectIdentifier
      - text: Get the GitOps overview metrics for agent {agent}.
        slots:
          agent: query.agentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/api/dashboards/{dashboard_id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download data from all tiles in a dashboard
      effect: read
      questions:
      - How do I export the data behind every tile on a custom dashboard?
      - Which file types can I download dashboard tile data in?
      instructions:
      - text: Download all tile data from dashboard {dashboard} as {file_type}.
        slots:
          dashboard: path.dashboard_id
          file_type: query.file_type
      - text: Export dashboard {dashboard}'s tile data as {file_type} with filters {filters}.
        slots:
          dashboard: path.dashboard_id
          file_type: query.file_type
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/dashboards/{dashboard_id}/elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List the elements of a dashboard
      effect: read
      questions:
      - Which tiles or elements make up a given dashboard?
      - How do I find a dashboard element ID so I can download just that tile?
      instructions:
      - text: List the elements on dashboard {dashboard}.
        slots:
          dashboard: path.dashboard_id
      - text: Show me every tile ID in dashboard {dashboard}.
        slots:
          dashboard: path.dashboard_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/dashboards/{dashboard_id}/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List the filters on a dashboard
      effect: read
      questions:
      - What filters are defined on this dashboard and what are their defaults?
      - How do I find a dashboard filter's ID before changing it?
      instructions:
      - text: List the filters defined on dashboard {dashboard}.
        slots:
          dashboard: path.dashboard_id
      - text: Show the filter IDs and defaults for dashboard {dashboard}.
        slots:
          dashboard: path.dashboard_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a dashboard
      effect: write
      questions:
      - Can I copy an existing dashboard to use as a starting point for my own?
      - How do I duplicate a dashboard into a different folder with a new name?
      instructions:
      - text: Clone dashboard {dashboard}.
        slots:
          dashboard: requestBody.dashboardId
      - text: Copy dashboard {dashboard} into folder {folder} as {name}.
        slots:
          dashboard: requestBody.dashboardId
          folder: requestBody.folderId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/dashboards/{dashboard_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard's details
      effect: read
      questions:
      - What are the name, folder and tags of a particular dashboard?
      - Can I look up all the details of one dashboard by its ID?
      instructions:
      - text: Get the details of dashboard {dashboard}.
        slots:
          dashboard: path.dashboard_id
      - text: Show me dashboard {dashboard}'s name, folder and tags.
        slots:
          dashboard: path.dashboard_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or move a dashboard
      effect: write
      questions:
      - How do I rename a dashboard or move it to another folder?
      - Can I change a dashboard's description and tags after creating it?
      instructions:
      - text: Rename dashboard {dashboard} to {name} in folder {folder}.
        slots:
          dashboard: requestBody.dashboardId
          name: requestBody.name
          folder: requestBody.folderId
      - text: Move dashboard {dashboard} to folder {folder}, keeping the name {name}.
        slots:
          dashboard: requestBody.dashboardId
          folder: requestBody.folderId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/remove'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard
      effect: destructive
      questions:
      - How do I delete a single dashboard I no longer need?
      - Do I need the folder ID to remove a dashboard?
      instructions:
      - text: Delete dashboard {dashboard} from folder {folder}.
        slots:
          dashboard: requestBody.dashboardId
          folder: query.folderId
      - text: Remove the dashboard {dashboard} stored in folder {folder}.
        slots:
          dashboard: requestBody.dashboardId
          folder: query.folderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/dashboards/{dashboard_id}/filters/{filter_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a filter on a dashboard
      effect: write
      questions:
      - How do I change the default value of a dashboard filter?
      - Can I rename a dashboard filter or change its title?
      instructions:
      - text: Set filter {filter} on dashboard {dashboard} to default {value}.
        slots:
          filter: path.filter_id
          dashboard: path.dashboard_id
          value: requestBody.default_value
      - text: Retitle filter {filter} on dashboard {dashboard} as {title}.
        slots:
          filter: path.filter_id
          dashboard: path.dashboard_id
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/download/dashboards/{dashboard_id}/csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a dashboard as CSV
      effect: read
      questions:
      - Can I export a whole dashboard to a CSV file?
      - How do I get a CSV of a dashboard with expanded tables and visualization settings applied?
      instructions:
      - text: Download dashboard {dashboard} as a CSV.
        slots:
          dashboard: path.dashboard_id
      - text: Export dashboard {dashboard} to CSV with filters {filters}.
        slots:
          dashboard: path.dashboard_id
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/download/dashboards/{dashboard_id}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a dashboard as PDF
      effect: read
      questions:
      - How do I save a dashboard as a PDF to share with leadership?
      - Can I choose landscape orientation and paper size for a dashboard PDF?
      instructions:
      - text: Download dashboard {dashboard} as a PDF.
        slots:
          dashboard: path.dashboard_id
      - text: Export dashboard {dashboard} to a landscape PDF on {paper} paper.
        slots:
          dashboard: path.dashboard_id
          paper: query.paper_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard/schedules/run_once'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a dashboard delivery once
      effect: write
      questions:
      - Can I send a dashboard to people by email right now instead of waiting for the schedule?
      - How do I trigger a one-off dashboard delivery with a custom message?
      instructions:
      - text: Email dashboard {dashboard} as {file_type} to {emails} once, titled {name}.
        slots:
          dashboard: requestBody.dashboard_id
          file_type: requestBody.file_type
          emails: requestBody.destination_emails
          name: requestBody.name
      - text: Send a one-time {file_type} of dashboard {dashboard} named {name} to {emails} with message {message}.
        slots:
          file_type: requestBody.file_type
          dashboard: requestBody.dashboard_id
          name: requestBody.name
          emails: requestBody.destination_emails
          message: requestBody.message
      method: generated
      generated: '2026-09-26'