ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Path Visualization Interface Groups API

5 actions 5 updates phrasing extends openapi/thousandeyes-path-visualization-interface-groups-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 5

$.info
$.paths['/network/path-vis/interface-groups'].get
$.paths['/network/path-vis/interface-groups'].post
$.paths['/network/path-vis/interface-groups/{interfaceGroupId}'].put
$.paths['/network/path-vis/interface-groups/{interfaceGroupId}'].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 Path Visualization Interface Groups API
  version: 1.0.0
extends: openapi/thousandeyes-path-visualization-interface-groups-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: 4
- target: $.paths['/network/path-vis/interface-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List path visualization interface groups
      effect: read
      questions:
      - What interface groups are defined for path visualization?
      - Can I see how hops are grouped in my path visualization?
      instructions:
      - text: List all path visualization interface groups.
      - text: Show interface groups in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network/path-vis/interface-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a path visualization interface group
      effect: write
      questions:
      - How do I group router interfaces by IP address in path visualization?
      - Can an interface group match hops by reverse DNS regex?
      instructions:
      - text: Create an interface group named {groupName} for IPs {ipAddresses}.
        slots:
          groupName: requestBody.groupName
          ipAddresses: requestBody.ipAddresses
      - text: Create interface group {groupName} matching reverse DNS patterns {rdnsRegexes}.
        slots:
          groupName: requestBody.groupName
          rdnsRegexes: requestBody.rdnsRegexes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network/path-vis/interface-groups/{interfaceGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a path visualization interface group
      effect: write
      questions:
      - Can I add IP addresses to an existing interface group?
      - Is renaming a path visualization interface group possible?
      instructions:
      - text: Rename interface group {interfaceGroupId} to {groupName}.
        slots:
          interfaceGroupId: path.interfaceGroupId
          groupName: requestBody.groupName
      - text: Set the IP addresses of interface group {interfaceGroupId} to {ipAddresses}.
        slots:
          interfaceGroupId: path.interfaceGroupId
          ipAddresses: requestBody.ipAddresses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/network/path-vis/interface-groups/{interfaceGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a path visualization interface group
      effect: destructive
      questions:
      - How do I delete an interface group from path visualization?
      - Can I remove an interface group I no longer need?
      instructions:
      - text: Delete interface group {interfaceGroupId}.
        slots:
          interfaceGroupId: path.interfaceGroupId
      - text: Remove path visualization interface group {interfaceGroupId}.
        slots:
          interfaceGroupId: path.interfaceGroupId
      method: generated
      generated: '2026-09-26'