Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Dashboard API

6 actions 6 updates phrasing extends openapi/tenable-dashboard-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Tenable's API. It is a proposal applied on top of the contract, not a document Tenable publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/dashboards'].get
$.paths['/api/dashboards'].post
$.paths['/api/dashboards/{id}'].get
$.paths['/api/dashboards/{id}'].delete
$.paths['/api/dashboards/{id}'].patch

OpenAPI Overlay

Raw ↑
# 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 Dashboard API
  version: 1.0.0
extends: openapi/tenable-dashboard-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: 5
- target: $.paths['/api/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List dashboards
      effect: read
      questions:
      - Which dashboards exist in my Identity Exposure workspace?
      - Can I list all dashboards in their display order?
      instructions:
      - text: List my dashboards.
      - text: Show every dashboard I have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dashboard
      effect: write
      questions:
      - How do I add a new dashboard?
      - Can I choose where a new dashboard sits in the order?
      instructions:
      - text: Create a dashboard named {name} at position {order}.
        slots:
          name: requestBody.name
          order: requestBody.order
      - text: Add a new dashboard {name} in slot {order}.
        slots:
          name: requestBody.name
          order: requestBody.order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard
      effect: read
      questions:
      - How do I fetch a single dashboard by id?
      - What name and order does a particular dashboard have?
      instructions:
      - text: Get dashboard {id}.
        slots:
          id: path.id
      - text: Show the details of dashboard {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard and its widgets
      effect: destructive
      questions:
      - Does deleting a dashboard also remove its widgets?
      - How do I get rid of a dashboard I no longer use?
      instructions:
      - text: Delete dashboard {id} along with its widgets.
        slots:
          id: path.id
      - text: Remove dashboard {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dashboards/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reorder a dashboard
      effect: write
      questions:
      - Can I rename an existing dashboard?
      - How do I move a dashboard to a different position?
      instructions:
      - text: Rename dashboard {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Move dashboard {id} to position {order}.
        slots:
          id: path.id
          order: requestBody.order
      method: generated
      generated: '2026-10-01'