# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Tenable Platform & Settings Cloud Connectors API
  version: 1.0.0
extends: openapi/tenable-cloud-connectors-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/settings/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud connectors
      effect: read
      questions:
      - Which cloud connectors are set up in my account?
      - Can I page through and sort my cloud connectors?
      instructions:
      - text: List all my cloud connectors.
      - text: List {limit} cloud connectors starting at {offset}, sorted by {sort}.
        slots:
          limit: query.limit
          offset: query.offset
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cloud connector
      effect: write
      questions:
      - How do I connect a cloud account so its assets are discovered automatically?
      - Do I need my AWS cloudtrails before creating an AWS connector?
      instructions:
      - text: Create a new cloud connector for my AWS account.
      - text: Set up a new cloud connector so cloud assets are imported.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors/{connector_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cloud connector's details
      effect: read
      questions:
      - What is the configuration and last status of one cloud connector?
      - How do I see the error code on a failing connector?
      instructions:
      - text: Show details for cloud connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Check the import status of connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors/{connector_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cloud connector
      effect: write
      questions:
      - Can I change a connector's name, service accounts or schedule?
      - Is it possible to change the type of an existing cloud connector?
      instructions:
      - text: Update the schedule of cloud connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Rename cloud connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors/{connector_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cloud connector
      effect: destructive
      questions:
      - How do I remove a cloud connector I no longer need?
      - Who is allowed to delete a cloud connector?
      instructions:
      - text: Delete cloud connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Remove the connector {connector_id} from my account.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors/azure-fa/{connector_id}/arm-template'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an Azure ARM template for a connector
      effect: read
      questions:
      - Where do I get the ARM template for an Azure Frictionless Assessment connector?
      - Can I download the Azure Resource Manager template for my connector?
      instructions:
      - text: Download the ARM template for Azure connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Get the Azure Resource Manager template for connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors/cloudformation-template'].post
  update:
    x-apievangelist-phrasing:
      intent: Download an AWS CloudFormation template
      effect: read
      questions:
      - How do I get the CloudFormation template for an AWS Frictionless Assessment connector?
      - Which AWS account ID does the CFT template need?
      instructions:
      - text: Download the CloudFormation template for connector {connector_id} and AWS account {account_id}.
        slots:
          connector_id: requestBody.connector_id
          account_id: requestBody.account_id
      - text: Get the CFT for AWS account {account_id} on connector {connector_id}.
        slots:
          account_id: requestBody.account_id
          connector_id: requestBody.connector_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors/aws/cloudtrails'].post
  update:
    x-apievangelist-phrasing:
      intent: List available AWS CloudTrails
      effect: read
      questions:
      - Which AWS CloudTrails can I use when creating an AWS connector?
      - Can I see the cloudtrails in a specific AWS region?
      instructions:
      - text: List AWS cloudtrails available in region {region}.
        slots:
          region: requestBody.region
      - text: Show cloudtrails in {region} for AWS account {account_id} using credentials {credentials}.
        slots:
          region: requestBody.region
          account_id: requestBody.account_id
          credentials: requestBody.credentials
      method: generated
      generated: '2026-10-01'
- target: $.paths['/settings/connectors/{connector_id}/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a cloud connector import now
      effect: write
      questions:
      - How do I trigger a cloud asset import right away instead of waiting for the schedule?
      - How can I tell whether a connector import job finished?
      instructions:
      - text: Start an import now on cloud connector {connector_id}.
        slots:
          connector_id: path.connector_id
      - text: Pull fresh asset data through connector {connector_id}.
        slots:
          connector_id: path.connector_id
      method: generated
      generated: '2026-10-01'