ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Dashboards Filters API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/dashboards/filters'].get
$.paths['/dashboards/filters'].post
$.paths['/dashboards/filters/{id}'].get
$.paths['/dashboards/filters/{id}'].put
$.paths['/dashboards/filters/{id}'].delete

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 ThousandEyes Dashboards Filters API
  version: 1.0.0
extends: openapi/thousandeyes-dashboards-filters-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: 5
- target: $.paths['/dashboards/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List dashboard filters
      effect: read
      questions:
      - What saved dashboard filters are in my account group?
      - Can I search dashboard filters by a name pattern?
      instructions:
      - text: List all dashboard filters.
      - text: Find dashboard filters matching {searchPattern}.
        slots:
          searchPattern: query.searchPattern
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/filters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dashboard filter
      effect: write
      questions:
      - How do I save a reusable filter for my dashboards?
      - Which permissions let me create a dashboard filter?
      instructions:
      - text: Create a dashboard filter named {name} with context {context}.
        slots:
          name: requestBody.name
          context: requestBody.context
      - text: Save a new dashboard filter {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/filters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard filter
      effect: read
      questions:
      - What data source filters are inside one dashboard filter?
      - Can I view the metadata of a single dashboard filter?
      instructions:
      - text: Show dashboard filter {id}.
        slots:
          id: path.id
      - text: Get the data source filters in dashboard filter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/filters/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dashboard filter
      effect: write
      questions:
      - Can I edit a dashboard filter someone else created?
      - How do I change the context of an existing dashboard filter?
      instructions:
      - text: Rename dashboard filter {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the context of dashboard filter {id} to {context}.
        slots:
          id: path.id
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/filters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard filter
      effect: destructive
      questions:
      - Who is allowed to delete a dashboard filter?
      - Is there a way to remove a saved dashboard filter?
      instructions:
      - text: Delete dashboard filter {id}.
        slots:
          id: path.id
      - text: Remove dashboard filter {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'