ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Cloud Insights Integrations API

15 actions 15 updates phrasing extends openapi/thousandeyes-cloud-insights-integrations-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 15

$.info
$.paths['/cloud-insights/integration/aws'].get
$.paths['/cloud-insights/integration/aws/{integrationId}'].get
$.paths['/cloud-insights/integration/aws/{integrationId}'].delete
$.paths['/cloud-insights/integration/aws/inventory'].post
$.paths['/cloud-insights/integration/aws/flow-logs'].post
$.paths['/cloud-insights/integration/aws/inventory/policies'].get
$.paths['/cloud-insights/integration/aws/flow-logs/policies'].get
$.paths['/cloud-insights/integration/azure'].get
$.paths['/cloud-insights/integration/azure/{integrationId}'].get
$.paths['/cloud-insights/integration/azure/{integrationId}'].delete
$.paths['/cloud-insights/integration/azure/inventory'].post
$.paths['/cloud-insights/integration/azure/flow-logs'].post
$.paths['/cloud-insights/integration/azure/inventory/{integrationId}'].put
$.paths['/cloud-insights/integration/azure/flow-logs/{integrationId}'].put

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 Cloud Insights Integrations API
  version: 1.0.0
extends: openapi/thousandeyes-cloud-insights-integrations-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: 14
- target: $.paths['/cloud-insights/integration/aws'].get
  update:
    x-apievangelist-phrasing:
      intent: List AWS monitoring integrations
      effect: read
      questions:
      - Which AWS accounts have I connected to ThousandEyes Cloud Insights?
      - Can I see both my AWS inventory and flow logs integrations in one list?
      instructions:
      - text: List all my AWS monitoring integrations.
      - text: Show the AWS inventory and flow logs integrations for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/aws/{integrationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AWS monitoring integration
      effect: read
      questions:
      - Where can I check the configuration of one specific AWS integration?
      - What details are stored for a single AWS inventory or flow logs integration?
      instructions:
      - text: Show me AWS integration {integrationId}.
        slots:
          integrationId: path.integrationId
      - text: Get the details of AWS monitoring integration {integrationId}.
        slots:
          integrationId: path.integrationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/aws/{integrationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AWS monitoring integration
      effect: destructive
      questions:
      - How do I disconnect an AWS account from Cloud Insights?
      - Can I remove an AWS flow logs integration I no longer need?
      instructions:
      - text: Delete AWS integration {integrationId}.
        slots:
          integrationId: path.integrationId
      - text: Remove the AWS monitoring integration {integrationId} from account group {aid}.
        slots:
          integrationId: path.integrationId
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/aws/inventory'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect AWS inventory monitoring
      effect: write
      questions:
      - How do I start monitoring my AWS resource inventory?
      - What IAM role ARN do I need to set up an AWS inventory integration?
      instructions:
      - text: Create an AWS inventory integration named {name} using role {roleArn}.
        slots:
          name: requestBody.name
          roleArn: requestBody.roleArn
      - text: Connect AWS inventory monitoring with IAM role {roleArn}.
        slots:
          roleArn: requestBody.roleArn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/aws/flow-logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect AWS flow logs monitoring
      effect: write
      questions:
      - How do I send AWS VPC flow logs into Cloud Insights?
      - Which SNS topics does an AWS flow logs integration need?
      instructions:
      - text: Create an AWS flow logs integration named {name} with role {roleArn} and SNS topics {snsTopicsArns}.
        slots:
          name: requestBody.name
          roleArn: requestBody.roleArn
          snsTopicsArns: requestBody.snsTopicsArns
      - text: Set up AWS flow logs monitoring called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/aws/inventory/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: Get IAM policies for AWS inventory
      effect: read
      questions:
      - What IAM permissions does the AWS inventory integration require?
      - Where do I get the policy JSON to grant inventory access in my AWS account?
      instructions:
      - text: Get the IAM policies needed for AWS inventory monitoring.
      - text: Show the AWS inventory IAM policy JSON for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/aws/flow-logs/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: Get IAM policies for AWS flow logs
      effect: read
      questions:
      - What IAM policy do I attach so flow logs can be read?
      - Can I download the permissions required for the AWS flow logs integration?
      instructions:
      - text: Get the IAM policies needed for AWS flow logs monitoring.
      - text: Show the flow logs IAM policy JSON for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/azure'].get
  update:
    x-apievangelist-phrasing:
      intent: List Azure monitoring integrations
      effect: read
      questions:
      - Which Azure tenants are connected to Cloud Insights?
      - Can I list every Azure inventory and flow logs integration I have?
      instructions:
      - text: List all my Azure monitoring integrations.
      - text: Show the Azure integrations for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/azure/{integrationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Azure monitoring integration
      effect: read
      questions:
      - Can I look up one Azure integration by its ID?
      - What settings are saved on a particular Azure flow logs integration?
      instructions:
      - text: Show me Azure integration {integrationId}.
        slots:
          integrationId: path.integrationId
      - text: Get the details of Azure monitoring integration {integrationId}.
        slots:
          integrationId: path.integrationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/azure/{integrationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Azure monitoring integration
      effect: destructive
      questions:
      - How do I disconnect an Azure subscription from Cloud Insights?
      - Can I delete an Azure inventory integration?
      instructions:
      - text: Delete Azure integration {integrationId}.
        slots:
          integrationId: path.integrationId
      - text: Remove the Azure monitoring integration {integrationId} from account group {aid}.
        slots:
          integrationId: path.integrationId
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/azure/inventory'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect Azure inventory monitoring
      effect: write
      questions:
      - How do I start monitoring my Azure resource inventory?
      - What app ID and tenant ID are needed to add an Azure inventory integration?
      instructions:
      - text: Create an Azure inventory integration named {name} for tenant {azureTenantId} with app {appId}.
        slots:
          name: requestBody.name
          azureTenantId: requestBody.azureTenantId
          appId: requestBody.appId
      - text: Connect Azure inventory monitoring using app {appId} and secret {password}.
        slots:
          appId: requestBody.appId
          password: requestBody.password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/azure/flow-logs'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect Azure flow logs monitoring
      effect: write
      questions:
      - How do I stream Azure flow logs into Cloud Insights?
      - Does the Azure flow logs integration need a Service Bus queue?
      instructions:
      - text: Create an Azure flow logs integration named {name} reading from queue {serviceBusQueueUrl}.
        slots:
          name: requestBody.name
          serviceBusQueueUrl: requestBody.serviceBusQueueUrl
      - text: Set up Azure flow logs monitoring for tenant {azureTenantId} with app {appId}.
        slots:
          azureTenantId: requestBody.azureTenantId
          appId: requestBody.appId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/azure/inventory/{integrationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Azure inventory integration
      effect: write
      questions:
      - After rotating my Azure client secret, can I update the inventory integration with it?
      - Can I rename an existing Azure inventory integration?
      instructions:
      - text: Update Azure inventory integration {integrationId} with new secret {password}.
        slots:
          integrationId: path.integrationId
          password: requestBody.password
      - text: Rename Azure inventory integration {integrationId} to {name}.
        slots:
          integrationId: path.integrationId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud-insights/integration/azure/flow-logs/{integrationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Azure flow logs integration
      effect: write
      questions:
      - How do I point my Azure flow logs integration at a different Service Bus queue?
      - Can I change the app credentials on an Azure flow logs integration?
      instructions:
      - text: Change the Service Bus queue of Azure flow logs integration {integrationId} to {serviceBusQueueUrl}.
        slots:
          integrationId: path.integrationId
          serviceBusQueueUrl: requestBody.serviceBusQueueUrl
      - text: Update Azure flow logs integration {integrationId} to use app {appId}.
        slots:
          integrationId: path.integrationId
          appId: requestBody.appId
      method: generated
      generated: '2026-09-26'