# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Azure Bot Service Bot Connection API
  version: 1.0.0
extends: openapi/microsoft-azure-botconnection-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: 6
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}/listWithSecrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a bot connection setting including its secrets
      effect: read
      questions:
      - How do I see the client secret stored in my bot's OAuth connection setting?
      - Can I retrieve a bot connection setting with its secrets unmasked?
      instructions:
      - text: Get connection {connectionName} with secrets for bot {resourceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          connectionName: path.connectionName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Reveal the secrets of bot {resourceName} connection setting {connectionName}.
        slots:
          resourceName: path.resourceName
          connectionName: path.connectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bot OAuth connection setting
      effect: read
      questions:
      - Which identity provider is a bot's OAuth connection setting configured for?
      - Can I look up one connection setting on my Azure Bot Service resource?
      instructions:
      - text: Get connection setting {connectionName} for bot {resourceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          connectionName: path.connectionName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show bot {resourceName} connection {connectionName} without secrets.
        slots:
          resourceName: path.resourceName
          connectionName: path.connectionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Register an auth connection for a bot
      effect: write
      questions:
      - How do I add an OAuth connection so my bot can sign users in?
      - What properties go into a new Bot Service connection setting?
      instructions:
      - text: Register auth connection {connectionName} on bot {resourceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          connectionName: path.connectionName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Create bot {resourceName} connection setting {connectionName} with properties {properties}.
        slots:
          resourceName: path.resourceName
          connectionName: path.connectionName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bot connection setting
      effect: destructive
      questions:
      - How do I remove an OAuth connection setting from my bot?
      - Can I delete one bot connection without affecting the others?
      instructions:
      - text: Delete connection setting {connectionName} from bot {resourceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          connectionName: path.connectionName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Remove the {connectionName} auth connection from bot {resourceName}.
        slots:
          connectionName: path.connectionName
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections/{connectionName}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a bot connection setting
      effect: write
      questions:
      - How do I rotate the client secret on an existing bot OAuth connection?
      - Can I change the scopes of a bot connection setting after it is registered?
      instructions:
      - text: Update connection setting {connectionName} on bot {resourceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          connectionName: path.connectionName
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Change existing bot {resourceName} connection {connectionName} to properties {properties}.
        slots:
          resourceName: path.resourceName
          connectionName: path.connectionName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List connection settings on a bot
      effect: read
      questions:
      - Which OAuth connection settings are registered on my bot?
      - What auth connections does a Bot Service resource have configured?
      instructions:
      - text: List connection settings for bot {resourceName} in resource group {resourceGroupName}, subscription {subscriptionId}.
        slots:
          resourceName: path.resourceName
          resourceGroupName: path.resourceGroupName
          subscriptionId: path.subscriptionId
      - text: Show all auth connections on bot {resourceName}.
        slots:
          resourceName: path.resourceName
      method: generated
      generated: '2026-09-26'