# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity Exposure Widget API
  version: 1.0.0
extends: openapi/tenable-widget-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: 7
- target: $.paths['/api/dashboards/{dashboardId}/widgets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a dashboard's widgets
      effect: read
      questions:
      - Which widgets are on a dashboard?
      - Can I list every widget in one dashboard?
      instructions:
      - text: List widgets on dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      - text: Show all widgets of dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{dashboardId}/widgets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a widget to a dashboard
      effect: write
      questions:
      - How do I place a new widget on a dashboard?
      - Can I set a widget's size and position when adding it?
      instructions:
      - text: Add widget {title} to dashboard {dashboardId} at {posX},{posY} sized {width}x{height}.
        slots:
          title: requestBody.title
          dashboardId: path.dashboardId
          posX: requestBody.posX
          posY: requestBody.posY
          width: requestBody.width
          height: requestBody.height
      - text: Create a {width} by {height} widget titled {title} on dashboard {dashboardId} at column {posX}, row {posY}.
        slots:
          width: requestBody.width
          height: requestBody.height
          title: requestBody.title
          dashboardId: path.dashboardId
          posX: requestBody.posX
          posY: requestBody.posY
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{dashboardId}/widgets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a widget
      effect: read
      questions:
      - How do I fetch one widget's layout?
      - What title and size does a widget have?
      instructions:
      - text: Get widget {id} on dashboard {dashboardId}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      - text: Show layout of widget {id} in dashboard {dashboardId}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{dashboardId}/widgets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a widget
      effect: destructive
      questions:
      - How do I remove a widget from a dashboard?
      - Can I delete one widget without deleting the dashboard?
      instructions:
      - text: Delete widget {id} from dashboard {dashboardId}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      - text: Remove widget {id} on dashboard {dashboardId}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{dashboardId}/widgets/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move, resize or retitle a widget
      effect: write
      questions:
      - Can I resize a widget on a dashboard?
      - How do I rename or move an existing widget?
      instructions:
      - text: Resize widget {id} on dashboard {dashboardId} to {width}x{height}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
          width: requestBody.width
          height: requestBody.height
      - text: Retitle widget {id} in dashboard {dashboardId} to {title}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{dashboardId}/widgets/{id}/options'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a widget's data options
      effect: read
      questions:
      - What data series and filters does a widget display?
      - Can I read a widget's options?
      instructions:
      - text: Get the options of widget {id} on dashboard {dashboardId}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      - text: Show what data widget {id} in dashboard {dashboardId} is configured to chart.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{dashboardId}/widgets/{id}/options'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a widget's data options
      effect: write
      questions:
      - How do I choose what data a widget charts?
      - Can I replace a widget's options entirely?
      instructions:
      - text: Define the options of widget {id} on dashboard {dashboardId}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      - text: Replace the chart settings for widget {id} in dashboard {dashboardId}.
        slots:
          id: path.id
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'