ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Alert Suppression Windows API

6 actions 6 updates phrasing extends openapi/thousandeyes-alert-suppression-windows-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['/alert-suppression-windows'].get
$.paths['/alert-suppression-windows'].post
$.paths['/alert-suppression-windows/{windowId}'].get
$.paths['/alert-suppression-windows/{windowId}'].put
$.paths['/alert-suppression-windows/{windowId}'].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 Alert Suppression Windows API
  version: 1.0.0
extends: openapi/thousandeyes-alert-suppression-windows-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['/alert-suppression-windows'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert suppression windows
      effect: read
      questions:
      - Which alert suppression windows are set up for maintenance?
      - Can I see every suppression window in my account group?
      instructions:
      - text: List all alert suppression windows.
      - text: Show alert suppression windows in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-suppression-windows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert suppression window
      effect: write
      questions:
      - Can I silence alerts for certain tests during a maintenance window?
      - Is it possible to make a suppression window repeat every week?
      instructions:
      - text: Create a suppression window {name} starting {startDate} lasting {duration}.
        slots:
          name: requestBody.name
          startDate: requestBody.startDate
          duration: requestBody.duration
      - text: Suppress alerts for tests {testIds} in a new window {name} that repeats {repeat}.
        slots:
          testIds: requestBody.testIds
          name: requestBody.name
          repeat: requestBody.repeat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-suppression-windows/{windowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert suppression window
      effect: read
      questions:
      - What tests and schedule does a specific suppression window cover?
      - Can I check whether a suppression window is currently active?
      instructions:
      - text: Show alert suppression window {windowId}.
        slots:
          windowId: path.windowId
      - text: Get the schedule of suppression window {windowId}.
        slots:
          windowId: path.windowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-suppression-windows/{windowId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an alert suppression window
      effect: write
      questions:
      - Can I extend an existing maintenance window?
      - Is it possible to disable a suppression window without deleting it?
      instructions:
      - text: Change suppression window {windowId} to last {duration}.
        slots:
          windowId: path.windowId
          duration: requestBody.duration
      - text: Set suppression window {windowId} enabled to {isEnabled}.
        slots:
          windowId: path.windowId
          isEnabled: requestBody.isEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/alert-suppression-windows/{windowId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert suppression window
      effect: destructive
      questions:
      - Can I remove a suppression window once maintenance is over?
      - What removes an alert suppression window for good?
      instructions:
      - text: Delete alert suppression window {windowId}.
        slots:
          windowId: path.windowId
      - text: Remove suppression window {windowId} from account group {aid}.
        slots:
          windowId: path.windowId
          aid: query.aid
      method: generated
      generated: '2026-09-26'