ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Generic Connectors API

8 actions 8 updates phrasing extends openapi/thousandeyes-generic-connectors-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 8

$.info
$.paths['/connectors/generic/{id}'].get
$.paths['/connectors/generic/{id}'].put
$.paths['/connectors/generic/{id}'].delete
$.paths['/connectors/generic/{id}/operations'].get
$.paths['/connectors/generic/{id}/operations'].put
$.paths['/connectors/generic'].get
$.paths['/connectors/generic'].post

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 Generic Connectors API
  version: 1.0.0
extends: openapi/thousandeyes-generic-connectors-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: 7
- target: $.paths['/connectors/generic/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a generic connector
      effect: read
      questions:
      - How do I see the target URL and headers of a connector?
      - What authentication is configured on a given generic connector?
      instructions:
      - text: Show generic connector {id}.
        slots:
          id: path.id
      - text: Get the details of connector {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectors/generic/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a generic connector
      effect: write
      questions:
      - How do I change where a generic connector sends data?
      - Can I update the authentication or headers on an existing connector?
      instructions:
      - text: Update connector {id} to target {target}.
        slots:
          id: path.id
          target: requestBody.target
      - text: Rename generic connector {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectors/generic/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a generic connector
      effect: destructive
      questions:
      - Is it possible to remove a generic connector?
      - Can I delete a connector that is no longer used?
      instructions:
      - text: Delete generic connector {id}.
        slots:
          id: path.id
      - text: Remove connector {id} from account group {aid}.
        slots:
          id: path.id
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectors/generic/{id}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List operations assigned to a connector
      effect: read
      questions:
      - Which operations are wired to a particular connector?
      - How can I see the operation IDs a connector serves?
      instructions:
      - text: List the operations assigned to connector {id}.
        slots:
          id: path.id
      - text: Show which operation IDs use generic connector {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectors/generic/{id}/operations'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign operations to a connector
      effect: write
      questions:
      - Which call attaches operations to a generic connector?
      - Does assigning operations to a connector replace the existing ones?
      instructions:
      - text: Assign operations to generic connector {id}, replacing current assignments.
        slots:
          id: path.id
      - text: Set the operation list for connector {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectors/generic'].get
  update:
    x-apievangelist-phrasing:
      intent: List generic connectors
      effect: read
      questions:
      - What generic connectors exist in my account group?
      - Which connectors are defined in ThousandEyes for streaming data out?
      instructions:
      - text: List all my generic connectors.
      - text: Show the connectors in account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectors/generic'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a generic connector
      effect: write
      questions:
      - How do I create a connector that sends data to my own endpoint?
      - What type, name and target are required for a new connector?
      instructions:
      - text: Create a {type} connector named {name} pointing at {target}.
        slots:
          type: requestBody.type
          name: requestBody.name
          target: requestBody.target
      - text: Add a new generic connector called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'